6.2.4.1. Configuration Settings

The very first step to getting your document module up and running is configuring a document type. Typically, Babelway's message traffic helps you automate and support a business process such as invoicing, or tracking shipments, or routing purchase orders etc. Each one of these processes is tied to business documents like invoices, bills of lading, or purchase orders. This is what would translate into a document type in Babelway. Below is an example of a working configuration for invoices:

Environment settings - DocumentTypes

 

General Settings and Fields

A document type is defined by some shared configuration settings that involve general maintenance of the documents. Along with the general settings, a document type comprises a list of fields that will allow you to collect all the relevant business information you want.

Name	This will reference the technical name of your document. Please note that this name will be used as an identifier to reference your document type throughout the application. Modifying it will change the link between your document type and existing documents and document extractors. For changes to your document's display name, you can adapt its labels.
Keep duration	This indicates how long the documents must be kept. The expiration date of the document is calculated at the documents initial creation time and cannot be modified afterwards. Thus, modifying this field, or updating documents later will not have any effect on the expiration date of existing documents.
Fields	All the fields that you want to have for this DocumentType.  For every field, you can choose its name and its type (see specific section on document fields). A special field called UniqueKey can be used to uniquely identify a document. It can be used to enrich a document with multiple messages. It can also be used to link documents.

Interface Personalisation

You can also personalize how the interface will display your DocumentTypes.

Menu section	By default, if you leave this field empty, all Documents will be displayed in the Monitoring section, with one menu entry by DocumentType.  By using this parameter, you can group multiple DocumentTypes in just one menu section. The DocumentTypes will then be displayed as tabs in this menu section.  To do this, simply add an id for the menu section. All the DocumentTypes with the same id will be grouped together.
Labels	This parameter allows you to load labels that must be used, in any language, to display data related to this DocumentType.  To do this, you must load a zip file containing a properties file (with all labels) for every language. Files in the zip must be named documents_[language].properties, or documents.properties for texts to use by default.  By clicking on the link "Download file pattern", you can easily get an example file with all the correct keys already defined.  Document Type labels
List default columns	Use a comma separated list of field names to define which ones to display by default upon opening your document list page. The names must be the name of a field. Note that the system fields can also be added ('id', 'creationMoment', 'lastUpdateMoment', 'keepUntil').  If you leave this field blank, the default is to display the columns for all of your fields, and id and creationMoment.  The order of elements in the list has no importance.
List default search	The criteria, on document creationMoment field, that will be applied by default when users come to the table of this DocumentType.  If you choose for shorter values, the searches will be faster. For this reason, it is often better to choose short values, because users almost always access only recent documents, and let them change the criteria on the rare occasions when the users want to access old documents.
List operators	The operators that will be applied for searches in the table. The expected format is a semicolon separated list of items of the form [fieldName]:[operators]. [operators] is a comma separated list of operators to display. Possible operators are 'eq' (equals), 'lt' (less than), 'le' (less or equal), 'gt' (greather than), 'ge' (greather or equal) or 'cn' (contains). Example of value : 'field1:eq,cn;field2:eq'.
Detail columns	This allows you to break your document fields into sections on the document details page (Monitoring > Document > select a document). The value must have be formatted as follows: [Section1]field1,field2[Section2]field4,field3 For better readability, newLines are also accepted before every section.  If you leave this field blank, the default is to display all the possible fields.