Properties of a folder type field

Configure the general, and validation properties of a folder field.

Use the following tabs to configure the properties of a folder type field.

In addition to the above properties, a folder type field contains some system-defined properties.

General

Use this tab to configure the general properties of a folder field.

Name

A name for the field. This name is used as the field ID. For name and display name conventions for a folder type field, see Name conventions.

Display name

A display name for the field. When you build forms that use a folder field, the display name appears in the generated form at design time and runtime.

Description

Optional. A description for the folder field.

Type

The type of field. Available options are: Text, Boolean, Choice, Date and Number.

Note

Default value

A Default value for the field. If no value is provided for the field, the default value is used at runtime.

Allow empty field

If selected, allows field values to be null.

Note When you use nullable type fields, at runtime the extraction is successful with the text box, date and dropdown fields appearing empty and the check box appearing filled.

Formatter

A formatter for the field. See Field formatters for more information.

If using a business rule formatter, configure the formatter to map rule inputs to folder fields or provide a static value.

Note If a field, such as field1 is mapped to a dependent formatter and relies on the inputs of another field, such as field2, you can still format field1 but the formatted value of field1 may not be passed to the formatter in field 2.

Display field for verfication

If selected, allows you to configure additional settings to display a field for verification. See Verification settings for a folder type field.

Verification settings for a folder type field

Configure fields inside a Folder (except tables) to allow for verification before releasing the fields to a back office system. You can select the verification mode and allow a reviewer to edit the field.

Exporting or importing a process that has a variable or a classification group referring to a folder includes verification settings configured for fields.

  1. To display the field on the form for verification, both at design time and runtime, on the General tab of the field, select Display field for verification. (Default: Clear)
  2. Select a Verification mode. Available options are:
    • Confirm (default): In this mode, if the data compared with the image is correct, the user presses a key to accept the data. Once you select this mode, select the User may change field value property to allow or restrict editing a field after the field is accepted (confirmed). (By default the user can edit the field.)
    • Blind double keying: In this mode, the field is displayed with no value and the user must enter a value using the image as a reference. This value is compared with the original value from the last module that ran before verification. If the values do not match, a message appears. Once you select this mode, select the Show field values if no match option to allow a double-keyed field display values if there is a mismatch. (Default: Clear; field values are not displayed.)

      Note Use Blind double keying only for advanced users who will use this information as a guideline and who understand the importance of keying from the image rather than matching the original value.

    • Read-only: In this mode, the field is set to read-only. You cannot edit the field.
  3. Click Save.

Validation

Use this tab to apply validation rules on a folder field to determine if the field is valid or invalid.

You can associate multiple validation rules to a field. You can also associate global or local field validators to a folder field.

  1. Navigate to Capture > Folders.

    The Folders page appears.

  2. On the folder field group, select the field for which to configure the validation settings.
  3. In the properties panel of the field, click the Validation tab.
  4. Click for Validators.

    The Add field validators dialog box is displayed.

  5. Select the local field validators and global field validators as needed from the Local field validator and Global field validator tabs respectively.

    The selected validators appear in the Selected items box.

    To remove a selected validation rule, click for the validator. To remove all the selected validators, click Remove all.

  6. Click Done.

    The validation rules appear under Validators in the properties panel.

  7. To change the order of the selected validation rules, use and on the header.

    At runtime, validation rules are executed based on the order of the rules.

  8. Save or release the folder type.