› User interface › Forms › Build forms › Build a Folder form

Build a Folder form

A Folder form is a customized view of a folder. Using a Folder form, you can generate Scan, Validation, Verification, and Document Review forms for a folder type.

A folder type can have more than one form. However, a folder type can have only one of each form type. For example, a folder type cannot have two Scan forms. You can generate a folder form for multiple folder types at once.

  1. Generate a Folder form in one of the following ways.
    Option

    Navigate to User interface > Forms.

    1. On the Generate list, select Folder forms

      The Generate folder forms dialog box is displayed.

    2. On the Folder type list, select the folder.

      The selected folder type is associated with the form at runtime.

      If the selected folder is protected, then you cannot generate forms for it.

    Navigate to Capture > Folders.

    On the context menu of a folder for which to generate a form, click Generate forms.

  2. Select the form types to generate. Available options are:

    • Scan

    • Validation

    • Document review

    • Verification

  3. Click Generate and save to save the form or Generate and release to save and release the form.
    The form is generated and associated with the selected form types. The generated form has the following format: <FolderName>_<FormType>. For example, in the Employment_Scan form, Employment is the folder type and Scan is the form type. The form name appears in the Form name field, and the category of the form defaults to the category of the folder. However, you can change the form name and update the category the form should be associated with.

    • When you generate a folder form (for Scan, Validation, Verification, and Document review forms) on the folder that exists in GitHub and the folder is not checked out to GitHub or checked out with another user, a warning message appears. When you click OK, a folder form for the selected form type is generated.

    • In the earlier versions of TotalAgility, the Folder form for Verification displayed all the field types (such as Check box and Combo box) added on the verification form as the text fields at runtime. The Check box and Combo box field types added to the Document Verification form at design time are also displayed at runtime.

    • When you regenerate the folder form and choose to create a new form, and the folder exists in GitHub but is not checked out to GitHub or checked out with another user, a warning message appears. When you click OK, a new folder form is generated.

    • You can open a Folder form only in a Scan control therefore the preview of the form is not available.

  4. When you open the generated form in the design view, all the fields of the folder type appear as corresponding controls. However, at runtime, these fields appear in the Folder tab.

    The fields do not appear in the form if the Display field for verification property is clear in the Folder type.

Edit a Folder form

Once a Folder form is generated, you can open the form in the design view. All the fields of the folder type appear as corresponding controls. However, at runtime, these fields appear in the "Folder" tab. The fields do not appear in the form if the "Display field for verification" property is clear in the folder type.

You can modify a Folder form in the design view. For example:

  • Add and remove normal controls, such as text boxes and buttons.

  • Move the Capture control fields on the form and configure field properties. You cannot delete the Capture control fields. See Capture controls.

  • Change the folder type properties on which the form is generated.

  1. Open the Folder form.

    The existing properties of the form are displayed in the properties panel. See Form properties.

  2. Make changes as needed.
  3. You can associate the form with another folder type.
    1. On the Form modeling bar, click File > Associations.
    2. Under Update associated folder form, on the Folder list, click the down arrow. A list of available folder types appears.
    3. Select the folder type to associate with the form.
    4. Click Update.

      The Folder form is updated with the selected folder type.