Welcome > Form Designer module > Configure the form properties > Configure the general properties of a form

Configure the general properties of a form

  1. On a form, click the form name.
  2. On the Properties bar, click Settings Extended Properties.
  3. By default, the form is added to the Default Category, change the category by consuming the category to use.
  4. Enter a Name for the form.
    Note A form name must be valid. For example, the form name cannot be "Open" or "Close". If the form name is invalid, a message appears.
  5. View the current version of the form.
  6. Enter a Title to appear on the form.
  7. Click Yes to allow the use of security tokens. See Security tokens.
  8. Click Yes for Offline Enabled; the devices will not execute field validation events for the form.
  9. In the Image box, consume an image. This image appears as shortcut icon for the Device Create New Job form in the MFP client.

    The Offline Enabled and Image properties are specific to the Device Create New Job form.

  10. By default, external users can access forms. Click No for Allow Anyone to prevent external users from accessing a form. The Security and Resources properties are enabled for internal users.
  11. For Security, select either option:
    • To restrict specific resources or groups from accessing a form at runtime, click Allow Everyone Except and then consume the resources and groups as needed.
    • To permit specific resources or groups access to forms, click Deny Everyone Except and then consume the resources and groups as needed.
  12. For Horizontal Navigation, accept the default navigation set for the site or select a custom navigation menu to display horizontally in realtime. You can only select a navigation menu that is already created. See Configure the navigation settings.
  13. For Vertical Navigation, accept the default navigation set for the site or select a custom navigation menu to display vertically in real time. You can only select a navigation menu that is already created.
    Note For a tablet or a phone form, you can only use a vertical navigation menu. The horizontal navigation menu is unavailable for touch forms.
  14. By default, Redirect Confirmation is set to Yes.

    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.

    Note

    • By default, Redirect Confirmation is set to Yes on any Take Activity forms created new from TotalAgility 7.3.1, but set to No on forms created in versions previous to TotalAgility 7.3.1. If you change the setting to Yes on upgraded forms, the following warning message appears: For Redirect Confirmation to work as expected, you must populate the global variables with correct values.

    • In a Take activity form, when you select the Leave Page option, it cancels the activity and redirects the user to the selected target. When you leave the page for a saved activity, the previously saved changes are lost.

    • This functionality is not supported on IOS platforms.

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

  15. To specify the form to be redirected to if a form fails to load at runtime, select either option for On Load Error Redirect To :
    • Origin: Redirects you back to the original page where the current page was launched.
    • Form: Consume a form. You are redirected to the external form.
    At runtime, if a form fails to load, an error message appears. When you click OK, you are redirected to the configured form (origin or specific form) and the form loads in the same window.
    Note If Redirect to Confirmation is set to Yes, you are redirected to the error form without having to confirm leaving the page.
  16. In Refresh Interval box, specify the interval at which the form is refreshed automatically.
  17. In the Initialization Variables box, consume the form fields, form variables, or global variables as initialization variables for your form. Initialization variables are variables or fields that must be populated when the form is first run.
  18. To allow table rows to auto-adjust its height to fit to content so that all content can be displayed without scrolling in the table, click Yes for Enable Table Auto-Height. (Default: No)
    Note This property is only available for a Document form. You can override this property for a Multiview and Take Activity form (Scan, Verification, Validation and Document Review).
  19. To override the table height for a specific capture form (Scan, Verification, Validation and Document Review), on the Override Table Auto-Height list, select Multiline or Single Line as applicable, (Default: None).
    Note This property is only available for a Multiview and Take Activity form for Scan, Verification, Validation and Document Review.
  20. For Touch Enhanced, click Yes to enable the touch property for the phone and tablet forms.
    The existing controls are removed and the Form Controls toolbox changes to touch enabled. Any controls added to the phone form are prefixed with "Touch". For example, Textbox is named as TouchTextbox. This property is not supported for Mobile Capture and Mobile Barcode Capture.
  21. In the Design group, do the following:
    1. To specify a Primary Form amongst the desktop, phone or tablet form, select one of the following:

      • Desktop: Opens the desktop form as the primary form in the form designer. (Default)

      • Phone: Opens the phone form as the primary form in the form designer.

      • Tablet: Opens the tablet form as the primary form in the form designer.

      Note:

      • When you add a redirect action to a form (desktop, phone or tablet) and consume 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 consume a form, it displays the initial parameters of the primary form.

    2. For Width Mode, select either option:

      • Fixed: Accept the default width or specify a custom width in pixels, in the Actual Width box.

      • Percentage: Set the width of the form in percentage to display the form relative to the browser window. (Default: 100%)

        • If you add a cell or a control to a cell in percentage mode, you can modify the width as a percentage. (Default: 100%)

        • A label associated with a control always has a fixed width.

        • If a form is set in percentage mode, resizing the browser window resizes the controls.

        • If you add a column or a cell to a form and the existing items are less than 98% in total (percentage or pixels), the new column or cell take up the remaining space (to a total of 98%). The width of existing columns or cells does not change.

        • You cannot add a new column or a cell to a form if the existing items on the form are greater than 98% in total (percentage or pixels). You must resize the existing cells or columns to allow space for the new ones in the form.

    3. For Header Form, accept the default header for the site or consume a custom (Other) header for this form.
    4. For Associated Label Width, accept the default label width of 100 or change the width of the label. Changes are applied to all the labels associated with the existing controls and to any new controls you add to the form.
    5. To position the form relative to the window it is presented in (from the left, center or right), for Alignment, select Left, Center or Right.
  22. In the Background group, do the following:
    1. Accept the default Theme as the background or click Inline to select a color scheme.
    2. To enhance the look of the form by using image in the background, do the following:

      1. Click Yes for Use Background Image. (Default: No)

      2. Enter an image name or URL in the Image Path box.

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

        Alternatively, to load an image from store, click Yes for Load Image from Store and consume an existing image or enter the image name, such as Add.png in the Image box. The image name must match the name in the database for the image to display at runtime.

    3. By default, the original size of image is used. To fit the image to the full size of the form, click Yes for Resize To Fit.
  23. In the Viewport group, click Yes for Use Viewport to control the display of a form in a phone or tablet device. By default, the value for all the properties are set to blank. Configure the following properties:

    • Width: Enter "device-width" to set the viewport to the physical width of the device screen or enter the number of pixels.

    • Height: Enter "device-height" to set the viewport to the physical height of the device screen or enter the number of pixels.

    • Initial Scale: Enter the initial zoom of the web page. A value of 1.0 indicates no zoom.

    • Maximum Scale: Enter the maximum level to zoom in a web page. A value of 1.0 indicates the user cannot zoom in.

    • Minimum Scale: Enter the minimum level to zoom out a web page. A value of 1.0 indicates the user cannot zoom out.

    • User Scalable: Click Yes to allow the user to zoom in and out of a web page.

    Note Zoom does not work for a touch-enabled form.