Page tree
Skip to end of metadata
Go to start of metadata

Form-level properties are the settings that define form sections (Pages), form behavior (Page Navigation, Buttons) and how long the user data will be kept (Record Retention Policy).

Form-level properties are displayed and can be modified in the Properties panel when the Visual Designer is in the Form mode. You can switch to the Form mode by selecting 'Form' in the drop-down list at the top of the Display panel or by clicking on Form navigation link at the top of the Properties panel.

The next settings can be configured and saved directly in the Properties panel:

Title - a mandatory field that identifies the form's title. Its main function is to identify form in auto-PDF.

Description - a mandatory field, visible to forms administrators only. It may describe form purpose or contain version specific information.

Hide Tracking Code - a checkbox, when it's ticked Tracking code will be hidden. Tracking code is an automatically generated code that uniquely identifies instance of a form when a user starts the form. By default it is displayed in the top right corner, between Page Links bar (if present) and Page Title.

Allow Suspend / Resume - a checkbox, when it's ticked anonymous users (users that are not logged in) can suspend the form and resume it later. As part of this functionality, on suspend users are provided with security credentials which they will use to resume the form. Those credentials can be sent to email address if provided.


Page Navigation section:

Direct Navigation - a checkbox to allow/disallow direct navigation through a form. When it is ticked users will be able to switch between pages not only by clicking on the Next or Previous buttons, but also by clicking on a link in the Page Links panel or on a block representing the page in the Progress bar (see  Form Structure). Note: when direct navigation is allowed and user moves to another page other than clicking on Next button, no validation is performed on the page the user is leaving. Make sure your business scenario allows leaving a page without validation. As a rule, if Previous button is not allowed Direct Navigation should not be allowed either. It is safe to allow direct navigation as validation of all pages will occur when a user clicks Submit button, the form will not be submitted if any of the pages fail validation. When Direct Navigation is not ticked the Page Links panel displays tabs instead of links. 

Pages to Show - the maximum number of page links/tabs to be displayed in the Page Links panel. When value is 0, all page links/tabs will be displayed. Otherwise the Page Links will try to fit the number of pages set and the rest of the form pages, if there are more visible pages, will become accessible through dropdown menus that will be added to the right and/or to the left. 


Record Retention Policy settings define periods (in days/months/years or hours) for keeping user data created during different stages of the form submission.  

Submitted - the period of time for which to keep submitted records. For example, if it is set as  '2' 'Years' then user data will be kept for 2 years from the moment the user clicks "Submit" button, after that the record will be automatically deleted.

In-Progress - the period of time for which to keep submissions in-progress, when user has started the form but haven't submitted it yet. The period is reset every time the form is accessed by the user. For example, if it is set as '14' 'Days' and the user doesn't access the form for two weeks, the user data related to the form will be deleted.

 

Form has two sets of settings grouped under Pages and Buttons that you can modify and save in the Editor window. 

Pages section

The Pages section is where you add pages or re-arrange the order of the pages. 

When the Visual Designer is in the Form mode Pages section shows the number of the pages the form consists of - Form has xx pages. Click on the Modify button to add a new page to the form or change the order of the pages. The Editor window will open displaying the existing pages and available page types that you can add.  

Form Pages list on the left shows the pages the form has or will have as you add them:

There is the Start page at the top, it can be renamed but cannot be moved from its position, it is always the first. The Start page is mandatory and cannot be deleted.

There could be two pages at the bottom, the Submission page and the Completed page, they can be renamed but cannot be moved from their position either. The Submission page is a special type of Data Entry type - it is mandatory and cannot be deleted. The Completed page is optional and can be deleted.

All other pages are of the Data Entry type and placed between Start page and Submission page, use drag-and-drop to re-arrange their order at any time.

There is a Go to Page icon next to the page name that allows you to jump straight to the page. 

Available Page Types has Data Entry Page box that you can drag and drop between the Start page and the Submission page to add a new page. If you have deleted the Completed page before you can re-instate it - the Completed Page box will appear in the Available Page Types. You can add it only once and drag and drop it only into one position - to be the very last.

If you have made the changes, click the Save button to save them and close the Editor. To exit the Editor without saving click the Cancel button.

 

Buttons section

The Buttons setting allows you to modify settings for the control buttons for users to navigate and action a form.  

When in the Form mode Buttons section of the Properties Panel shows the control buttons that are enabled for the form - Form has the following buttons:... Click on the Modify button to enable/disable control buttons or change their settings in the Editor window. 


Every control button has Label setting with pre-defined value that you can change to suit your needs. It is the text that appears on top of the button, it cannot be left blank and is a mandatory setting. 

Start Button - a button that appears on the Start page of a form for users to start the form. 

Next Page Button - a button that allows users to move forward from one page to another. It is visible when the form has more than one Data Entry pages. The button has an important setting - checkbox Validate. If ticked it enforces page validation: when user clicks Next Page button, the next page cannot be accessed until all fields on the current page have passed validation rules.

Previous Page Button - a button that allows users to move backwards from one page to another. For this button to appear a form should have more than one Data Entry page. In Use setting is a checkbox that allows you, when you untick it, to hide the Previous Page button. If Direct Navigation checkbox is also not ticked it will enforce one-way-only navigation: every page has to be validated before users can proceed to the next page and there is no way to go back to the previous page.

Submit Form Button - button to submit the form. You can set the text displayed in the confirmation dialog box users will see when they click on the Submit Form button in the Prompt setting. If Prompt is left empty the form will be submitted without asking user's confirmation.

Restart Form Button - button to restart the form. When In Use setting is ticked Restart Form button appears on the Completed Page if it exists, and when the user clicks on the button the Start page is displayed so that the user can start the same form again.

Quit Form Button - button to exit the form without submission. You can set text displayed in the confirmation dialog box users will see when they click on the Quit Form button. If Prompt is empty the form will be closed and all data the user entered will be deleted without user confirmation. Show on submit page setting that is normally ticked allows to force users to submit the form. If you untick it, Quit Form Button will be invisible. 


  

  • No labels