...
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 |
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
It is important to distinguish the different types of scope: document, page, sections.
A document is the entire file that is uploaded to the system. This file can either have 1 page or more. A document ideally contains one invoice, one email, one receipt, or other one format. However, this is not always the case; documents can also contain different formats at once. For example, on the illustration below, that one document has one contract, 2 invoices, and one identity card.
A page is one side of a document. In the review pane, you can view one page at a time. Page splitting enables the classification of different formats within one document. The illustration below has 4 pages (1 page of a contract, 2 pages of invoices, and 1 page of an identity card).
A section is a part of a page. Subpage splitting enables the detection of different sections. Sections are encountered usually when smaller receipts or ID cards are processed. For example, the front and back side of ID cards are usually saved in one single page, or several receipts are usually grouped together in one single page. The illustration below shows the fourth page that is divided in 2 sections.
Multiple and the importance of page/subpage splitting
This property is especially useful if splitting (page or subpage) is enabled. If the multiple box is ticked, it allows the tool to search for the field more than once.
Scenario 1 - page splitting enabled: Let’s say your client sent you a pdf file of not only once invoice but two or more merged into one pdf file, then this multiple box tells the Contract.fit solution that there will be not only one invoice_date but multiple. If the multiple box is not ticked, then the solution will only take into account the first invoice_date that it finds and assigns it to the whole file or document.
Scenario 2 - subpage splitting enabled: Often times when the finance department receives receipts, they receive a document with multiple receipts in one page. Once again, it would be logical to tick “multiple” for the field “gross_amount” or “invoice_date” as the chances that these fields are the same for all receipts are pretty slim.
Conditional
It is possible to add logical AND/OR conditions for specific fields. Choose any field of your liking and click on “show” in the conditional column. On the pop-up screen you can add rules that condition the situation where your selected field will be shown. It is also possible to add groups to manipulate the AND and OR logic. In the illustration below, the condition would work as follows: The field of interest would only be relevant if
The gross amount is not null, AND
Either the amount payable or the net amount is not null.
...
...
Other tables
You may want to maintain the row logic for tables in the extraction of information. To this end, we allow you to specify tables, which contain one or more row types.
...