Capture controls based on the fields for a document type
TotalAgility provides the following Capture controls depending on the fields configured for an extraction group. You can open a Capture form (Scan, Validation, Verification and Document review) in a design view and configure these controls.
The Date and Number field types are represented by the Text field on the Document type forms.
Common properties for all Capture field types
Property |
Description |
Property available for the form type |
|||
---|---|---|---|---|---|
Scan |
Validation |
Document review |
Verification |
||
Type |
The type of the field. |
|
|
|
|
Name |
A unique name for the field. |
|
|
|
|
Tooltip |
The supplementary information that displays by hovering the mouse over the tab at runtime. |
|
|
|
|
Read only |
If selected, displays the read-only check box at runtime. |
|
|
|
|
Security token |
Makes the form secure. See Security tokens. |
|
|
|
|
Text |
A meaningful text for the field. For example, use "Customer name" instead of "textbox1". |
|
|
|
|
Field name |
A meaningful name of the field to display at runtime. For example, "Customer name" instead of "Field1". This is a read-only property for all the field types except for the Choice field type. |
|
|
|
|
Properties specific to a Capture text field
Property |
Description |
Property available for the form type |
|||
---|---|---|---|---|---|
Scan |
Validation |
Document review |
Verification |
||
Max length |
The maximum number of characters allowed in a text field. If set, you cannot enter more than the specified number of characters into the text field. If you enter more characters, only characters up to the set maximum number appear in the field. By default, the maximum length of a text field is 0 (zero), which means a user can enter any number of characters in the field. The max length property is independent of Type and Format properties. |
|
|
|
|
Multiline |
If selected, handles text that may go beyond one line, such as customer address. (Default: Clear) |
|
|
|
|
Height |
Height of the text field. This property is only available if the "Multiline" option is selected. |
|
|
|
|
Preserve line breaks |
Allows preserving line breaks for a multi-line field when lassoing, so that the line breaks are preserved when data is populated in the field. This property is only available if the "Multiline" option is selected. |
|
|
|
|
Auto complete |
If selected, allows the field to complete automatically. (Default: Clear) |
|
|
|
|
Ignore case |
If selected, allows the field to accept letters in uppercase and lowercase. By default, the text field is case-sensitive. (Default: Clear) |
|
|
|
|
Mini-viewer |
If selected, displays a mini-viewer for a Capture field on a Document form to quickly view a portion of the image related to the field. (Default: Clear) When you choose to show a mini- viewer for a Capture field in a Document form, additional control is added to the selected Capture field. See Add a Mini viewer for more information. |
|
|
|
|
Properties specific to a Capture Check box
Property |
Description |
Property available for the form type |
|||
---|---|---|---|---|---|
Scan |
Validation |
Document review |
Verification |
||
Checked |
Allows the check box to be selected at runtime. (Default: Selected) |
|
|
|
|
Mini-viewer |
If selected, displays a mini- viewer for a Capture field on a Document form to quickly view a portion of the image related to the field. (Default: Clear) When you choose to show a mini-viewer for a Capture field in a Document form, additional control is added to the selected Capture field. See Add a Mini viewer for more information. |
|
|
|
|
Properties specific to a Capture Combo box
Property |
Description |
Property available for the form type |
|||
---|---|---|---|---|---|
Scan |
Validation |
Document review |
Verification |
||
Behavior |
The behavior of the Table. Available options are:
|
|
|
|
|
Auto complete match type |
Allows the field to complete automatically, depending on the selected option:
|
|
|
|
|
Mini-viewer |
If selected, displays a mini-viewer for a Capture field on a Document form to quickly view a portion of the image related to the field. When you choose to show a mini-viewer for a Capture field in a Document form, additional control is added to the selected Capture field. See Add a Mini viewer for more information. |
|
|
|
|
Properties specific to a Capture table
A Capture Table control is not displayed on Folder, and Document verification forms. If any fields in a Capture Table control are set as hidden or read-only, the system can prevent a user from completing a Validation activity. The reason is that when a user adds a row to a table, all the cells in that row are marked invalid (including any hidden or read-only cells). As a result, all the visible cells in the table do not mark the table as valid and the user is not able to complete the Validation activity.
If you want to hide fields from one user but make them visible to others, you either define the hidden fields as ‘Always valid’ (see Configure validation for document fields) or define validation rules that run during the ‘Add table row’ event that will set the valid flag as ‘true’ for hidden and read-only cells (see Add field validation for document fields.)
Property |
Description |
Property available for the form type |
|||
---|---|---|---|---|---|
Scan |
Validation |
Document review |
Verification |
||
Enabled |
Enables the control at runtime. (Default: Selected) |
|
|
|
|
Display name |
The display name for a field. |
|
|
|
|
Show toolbar |
Displays the toolbar at runtime. (Default: Selected) |
|
|
|
|
Autofit columns |
Adjusts the last column's width to fit the table width. (Default: Selected) If the table width exceeds the combined columns' width, the width of the last column increases to fill the available space. Similarly, if the table width becomes less than the width of the combined columns, the width of the last column reduces proportionally to fit the available space. For example, in a table of three columns, where each column is 100 mm wide, and if the total table width is set to 400 mm, then the width of the last column increases to 200 mm. If the table width is set to 250 mm, then the width of the last column becomes 50 mm. See the Example for more scenarios of resulting columns based on Width mode and Auto fit properties. |
|
|
|
|
Persistent OCR highlight |
If selected, a table's OCR remains highlighted regardless of where the current focus is. (Default: Clear) A new toggle button is available on the Capture table toolbar with the default state set at design time.. You can change the state of the button at runtime. The setting defined at runtime takes precedence over the setting configured in the Designer. |
|
|
|
|
Align row zones |
If selected, allows you to modify how the table OCR zones are highlighted where the left and right endpoints are aligned to the leftmost and rightmost rows. (Default: Clear) A new toggle button is available on the Capture table toolbar with the default state set at design time. You can change the state of the button at runtime. The setting defined at runtime takes precedence over the setting configured in the Designer. |
|
|
|
|
Mini-viewer |
If selected, displays a mini-viewer as an additional control for a Capture field on a Document form to quickly view a portion of the image related to the field. (Default: Clear) See Add a Mini viewer for more information. |
|
|
|
|
Properties specific to a Table column of Text field type
Property |
Description |
---|---|
Width |
Width of the table column. |
Read-only |
If selected, displays the read-only check box at runtime. (Default: Clear) |
Visible |
Makes the field visible at runtime. (Default: Selected) |
Multiline |
If selected, handles text that may go beyond one line, such as customer address. (Default: Clear) |
Preserve line breaks |
If selected, allows preserving line breaks for a multi-line field when lassoing, so that the line breaks are preserved when data is populated in the field. (Default: Clear) This property is only available if the "Multiline" option is selected. |
Properties specific to a Table column of Boolean field type
Property |
Description |
---|---|
Width |
Width of the table column. |
Read-only |
If selected, displays the read-only check box at runtime. (Default: Clear) |
Visible |
Makes the field visible at runtime. (Default: Selected) |
Behavior |
The behavior of the Table. Available options are:
|
Display mode |
The mode in which the text is displayed on a table at runtime. Available options are:
|
Dynamic data source |
A dynamic data source for the choice type of column. Once a dynamic data source is assigned, it will take precedence over any static or lookup defined in the extraction group. Form action types that can be used for a dynamic data source are:
|
Properties specific to a Table column of Choice field type
Property |
Description |
---|---|
Width |
Width of the table column. |
Read-only |
If selected, displays the read-only check box at runtime. (Default: Clear) |
Visible |
Makes the field visible at runtime. (Default: Selected) |
Multiline |
If selected, handles text that may go beyond one line, such as customer address. |
Preserve line breaks |
If selected, allows preserving line breaks for a multi-line field when lassoing, so that the line breaks are preserved when data is populated in the field. (Default: Clear) This property is only available if the "Multiline" option is selected. |
Properties specific to a Table column of Choice field type
Property |
Description |
---|---|
Width |
Width of the table column. |
Read-only |
If selected, displays the read-only check box at runtime. (Default: Clear) |
Visible |
Makes the field visible at runtime. (Default: Selected) |
Multiline |
If selected, handles text that may go beyond one line, such as customer address. (Default: Clear) |
Preserve line breaks |
If selected, allows preserving line breaks for a multi-line field when lassoing, so that the line breaks are preserved when data is populated in the field. (Default: Clear) This property is only available if the "Multiline" option is selected. |
Properties specific to a Table column of Date/Number field types
Property |
Description |
---|---|
Width |
Width of the table column. |
Read-only |
If selected, displays the read-only check box at runtime. (Default: Clear) |
Visible |
Makes the field visible at runtime. (Default: Selected) |