...
Property | Description | Default |
Mandatory | You can indicate whether or not a field is mandatory. Mandatory fields will be marked as read when not found and will block submission if not filled | false |
Field | The number of options is virtually unlimited. You can specify a data type other than string to reduce the number of options for a text field. For example, here you can specify that the text should be an amount | string |
Annotation, tag, separator, computed | Indicates whether the field of interest is an annotation, a tag, a separator, or computed | |
Data type | Indicates whether this is a text field or a tag field | text field |
Scope* | Indicates whether the scope is a page, a section or a document | section |
Visible | You can indicate if a field of interest is visible | true |
Multiple* | You can indicate if a field of interest can appear multiple times. | false |
Count in evaluation | A flag to decide whether the specific field should be evaluated. Setting this property on false enables some fields not to be taken into account in evaluations. This is useful for commentary and other optional fields. | true |
Conditional* | Some fields of interest are only relevant depending on the value of other fields of interest. For example, you may only be interested in the VAT number of an invoice if if has been confirmed that the document is a valid invoice (valid_invoice field == true). | No condition (always show) |
Display name | This is the label that will be shown in the FrontEnd to the user of the data entry companion and in the stats pane | No default, must be specified |
Technical name | This is the label that will be used when communicating to servers | Same as display name |
Description | A short text to characterise the field of interest |
Scope and the importance of page/subpage splitting
...