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

Build a Document form

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

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

  1. Navigate to User interface > Forms.

    The Forms list page appears.

  2. On the Generate list, select Document forms.

    The Generate document forms dialog box is displayed.

  3. On the Document type list, select the document type for which to build a form.

    The selected document types are associated with the form at runtime.

  4. Select the Form types to generate and do the following:

    • Scan

    • Validation

    • Document review

    • Verification

    1. On selecting the form type, by default, the Form name is displayed as a document type name suffixed with the respective form type. For example, if you select the form type as Scan and the selected document type name is Variant, the form name becomes Variant_Scan. However, you can change the form name as needed.
    2. The Category of the form defaults to the category of the document type. You can change the category the form should be associated with.
  5. Click Generate and save to save the generated form. Alternatively, to release the form, click Generate and release.
    The form is generated and associated with the selected document type. The generated form has the following format: <DocumentName>_<FormType>. For example, in the PersonalInfo_Scan form, PersonalInfo is the document type and Scan is the form type.

    • Preview of a Document form is not available as you can open a Document form only in a Scan control.

    • If the document type is locked by another user, the system displays a message, and the forms are not created.

    • If the document type is locked by the current user, the system displays a warning. If the user proceeds, the forms are created, and the properties of the document type are updated.

    • In the earlier versions of TotalAgility, the Document Verification form displayed all the field types (such as Check box and Combo box) added to the verification form as the text fields at runtime. The Check box and Combo box field types added on the Document Verification form at design time are also displayed at runtime. After importing a package that includes a Document Verification form (configured with text fields, combo boxes, and check boxes) created in earlier versions of TotalAgility, you must regenerate and re-release the form for the appropriate field types to appear on the form.

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

    • On regenerating the Validation, Verification, Document review, or scan forms, overwrite the existing associated document forms or create new ones. The regenerated forms have the associated document name. When you choose to create a new form, and the extraction group 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 document form is generated.

Edit a Document form

Once a Document form is generated, you can open the form in the Design view. All the fields of the extraction group appear as corresponding controls. However, at runtime, these fields appear on the "Document" tab. The fields do not appear on the form if the "Display field for verification" property is not selected in the extraction group.

You can modify a Document form in the Design view. For example:

  • Add and remove basic 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 document type properties on which the form is generated.

  • Add a mini-viewer to the Capture control field.

You cannot copy or create a Tablet or Phone version of a Document form.

  1. Open the Document form.

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

    The Enable table auto-height property and Refresh interval setting is only available for Document forms.

  2. Make changes as needed.
  3. You can associate the form with another document type.
    1. On the Form modeling bar, click File > Associations.
    2. Under Update associated document form, on the Document list, select the extraction group to associate with the form.
    3. Click Update.

      The Document form is updated with the selected document.

    4. Click Close.