6.2.4.2. Document Fields
Once you have set up the basic shared parameters of your document, you are going to want to tailor it to your specific use case. In particular, you are going to want to configure the fields that are specific to your documents. These fields have a name, and a field type. The name is a technical name (as it is for your document type name). It should not change and any effort to display it differently should be handled through labels. Document field types serve two purposes:
1. Data validity: Try to select the most specific field type in order to avoid bad values to make it into your documents. You don't want invoice totals for example to end up mistakenly containing address information. To avoid this, you'd set up your total as "Number" and any non number extractions would set your message in error and allow you to correct your extraction.
2. Filtering: The field type determines the filters and operations that will be available in your document grid. Strings will allow keyword searches, dates will allow you to select date intervals etc.
Babelway currently supports the following field types:
String |
This field type is the most common. Any kind of free text information can be stored here. |
String (choice within a list of values) | Using this field instead of the regular string will allow you to restrain values to a limited list of whitelisted ones. The filters in your document grid will then provide a dropdown for example to list only documents having one of those values. This is useful for example when wishing to configure a "status" for a document where the list of possible values is known and you want them to match exactly one status. |
Integer | Field with this type will only be able to contain numbers without decimals. |
Number (with decimals) | Use this field in order to save numbers with decimals. |
Date | Using this field type will allow you to save a date. |
Date and time |
This field allows you to save a time. NB. When populating fields of this type, you can use the parseDateTime function. |
Partner |
If you have configured partners in your environment, this field type will allow you to link these documents to a given partner. You can use this field to restrict access to your documents based on partner data accesses. NB. When populating fields of this type, you can use the findPartner function. |
Partner Ids | Partner identifiers |
File |
This will allow you to attach a file to your document (for example, a PDF version of your business document). NB. In your document extractor, this field type will require populating the following information: |
IBAN account | IBAN stands for International Bank Account Number. This field type will guarantee that any account added here matches an IBAN format. |
Document reference | This field type will reference another document. In your document's detailed page, this field will be displayed as a link to another document. |