Configure the settings of a form.

Control width (%)

Lets you update the width of all the controls on a form at a time rather than doing it individually for each control. To update width of all controls, enter or select the control width and click Update.

Once you update the width for a single control, the width of all the controls is updated automatically.

If the form is set to percentage width mode, any controls set to percentage width mode adjust depending on the form percentage width. However, if any controls are set to fixed width, then the form percentage does not affect those controls.

The controls that support control width are:

  • Label

  • Text box

  • Button

  • Check box

  • Table

  • Drop-down list

  • Calendar

  • Tab

  • Hyperlink

Associated label width The width of labels associated with all the existing controls and with any new controls added to the form. (Default: 100)

Lets you accept the default Theme as the background or an Inline color scheme.

Use image

If selected, allows you to use an image for the background to enhance the look of the form. Use background image in one of the following ways:

  • Select Load image from store and select an existing image. The image name must match the name in the database for the image to display at runtime.

  • Enter an image name or URL to the image in the Image path field.

    Note For on-premise TotalAgility, the image must reside in <Installation location>\Kofax\TotalAgility\Agility.Server.Web\Forms\Images.

Resize to fit: If selected, fits the image to the full size of the form. By default, the original size of image is used.

Show asterisk

By default, displays the red asterisk for all the mandatory fields when you view the form at runtime.

  • This property is not available for capture controls.

  • On upgrading TotalAgility, the Show asterisk property is turned off by default for all forms.

  • When you set a control to be mandatory using an action, the asterisk for the control at runtime is displayed only if the Show asterisk property on the form is enabled.

Use browser tab order

If selected, the form uses the default browser tab order rather than a specific tab order on each control.

The tab order property for all controls becomes read-only and cannot be edited. The tabs in a browser typically function in the following order:

  1. First column

  2. First row

  3. First cell including all controls left to right, top to bottom within the cell

  4. Next cell in the row

  5. Next row

  6. Next column

Expand last row to fit

If selected, any controls within the row expand to take up the remaining browser window height.

  • This property is not available for the document and folder forms.

  • This property is only available for cells with vertical layout.

  • If the controls on the cells (with vertical orientation) on a form take up more height than the browser window height, unexpected behavior occurs, such as, scrolling vertically is not possible.

  • If more than one control is set to expand to fit within a single cell, both the controls share the remaining browser window height equally.

Enable column splitting

If selected, allows you to resize the columns on a cell at runtime. When you resize a column, the adjacent columns auto-adjust accordingly. Resizing a column provides you the flexibility to assign less or more space to the contents of the column as needed.

Show column splitter

If selected, shows the splitter at runtime. If a form contains more than one column, a splitter becomes available between each column.

If cleared, the splitter becomes unavailable; however, you can still resize the columns.

Note This property is not available for a form if width mode is set to fixed.

Redirect confirmation

At runtime, when the user navigates away from a form, a message is displayed with the following options:

  • Stay on page: Allows to remain on the same page and to perform any action on the form.

  • Leave page: Redirects the user to the selected target.

Additional information:

  • For an Activity form, if Redirect confirmation is selected at the design time, and you select to leave the page at runtime, the activity is cancelled and is displayed back in the work queue, and you are redirected to the selected target. When you leave the page for a saved activity, the previously saved changes are lost.

  • If Redirect confirmation is clear for an Activity form, the activity is still automatically canceled on redirect (as long as you do not click the Cancel, Save or Complete buttons first), and is also canceled if you navigate away from the form (for example, use the Back button in the browser or close the window.)

  • By default, Redirect confirmation is selected on any Activity forms created new from TotalAgility 7.3.1, but cleared on forms created in versions previous to TotalAgility 7.3.1. If you select the Redirect confirmation option on upgraded forms, the following warning message appears: For Redirect confirmation to work as expected, you must populate the global variables with correct values.

    This functionality is not supported on IOS platforms.

    The message cannot be localized when the browser language preference is changed.

Refresh interval The interval at which the form is refreshed automatically.
Form factors
Primary form

The type of form (Desktop, Phone or Tablet) to open as the primary form in the Form Designer.

For example,

  1. Create a form with only desktop and tablet form factors.

  2. Set the primary form to tablet.

  3. Browse the form from a mobile device.

    As there is no phone form, the tablet form is displayed as this is the primary form.

  • The Primary form property does not apply to Document and Folder forms.

  • When you add a redirect action to a form (desktop, phone or tablet) and select a target form, and if the same form type exists then the initial parameters of that form type are displayed. Otherwise, the initial parameters of the identified primary form are displayed.

  • When you configure a navigation menu and select a form, it displays the initial parameters of the primary form.

See Configure JavaScript functions

Configure JavaScript functions

JavaScript functions can be called using the JavaScript action. See Add a JavaScript action to a form.

  1. In the properties panel of the form, click Configure next to JavaScript.

    The JavaScript dialog box is displayed.

  2. In the JavaScript functions field, enter the script.
    Example Function sample
    function sample()
    Important The script can contain one or more functions, however you must enter a valid script, otherwise the form fails to load at runtime.
  3. Click Save.