Processing Options
Processing Options #
Figure 7 Sys parm processing options
There are several system-wide processing options that apply to ADH, and they are set on the window above.
Rename document file on import #
| Item | Description |
|---|---|
| Selected | The name of the file is appended with the date and time that the import took place. |
| Cleared | The name of the file is not changed on import. |
| Relevant when | This is important if the name of each import document is always the same when delivered to the inbox. File names must be unique in the archive box, and a duplicate value will not be copied there (remaining in the inbox where it might inadvertently be imported again). |
Transform on load #
| Item | Description |
|---|---|
| Selected | A transformation is attempted on all documents as they are loaded into SICS. |
| Cleared | The user must manually start the transformation process from the find or view document windows. |
| Relevant when | Automatic processing of documents and messages is required. |
Automatically Update Input Field xPath #
| Item | Description |
|---|---|
| Selected | When changing the name of a field in the Input pattern, and the xPath contains the same string, the xPath is automatically changed too. |
| Cleared | The xPath is not changed if the field name is changed. |
| Relevant when | Duplicating fields in the Input pattern, then changing the field name of the new field (which is compulsory). |
XML Input Pattern Generation Algorithm #
This option is used when creating an input pattern directly from a loaded message. The system can analyze the document and create a pattern automatically, but how it does so is controlled by this parameter.
There are two choices:
- Standard - simply takes each element and attribute in the incoming XML ‘as is’, and creates an input field for each one. Any namespace information that may be present, is ignored. Attributes named ‘xmlns:*’ and ‘xsi:schemaLocation’ are ignored as well.
- Entity/Value - creates meaningful input field names, but the incoming document must contain
and elements, the entity element must contain a @name attribute. The @name attribute is used as the input field name.
The Standard algorithm takes the input XML element names to be the Input Pattern field (or group) names:
<dueDate>29.01.2016</dueDate>
The Entity/Value algorithm assumes this input file pattern:
<entity name="dueDate">
<value>29.01.2016</value>
</entity>
The Entity/Value algorithm also has a number of other built-in ‘specialities’, like looking for ObjectId, fileName and page elements, represented in a standard way.
Note: The create input pattern option should not be used if this parameter has the value ’none’.
Input Data Text Forcing Entity/Value Algorithm #
This option can be set when ‘XML Input Pattern Generation Algorithm’ is set to Standard.
| Value |
|---|
| Enter the element name (e.g. “ValueExtractorResult”) that would - if present in the input xml file - force use of the Entity/Value algorithm when the Standard algorithm is selected. |
Default Decimal Separator #
The Default Decimal Separator option defines which decimal separator character should be used as a default when designing mappings.
| Value | Example |
|---|---|
| In theory any single character can be specified. | In practice, either ‘.’ or ‘,’ should be used. |
Excel Compression Ratio Limit #
An .xslx file is actually a kind of compressed/zip file. The compression ratio will be 1 (no compression) or less (the more compressed the file is, the smaller the ratio will be). Small ratio means high compression. When importing an Excel file into ADH, a security exception will be raised if the compression ratio is very small (i.e. a very tight compression). By default, the limit for raising a security exception is a compression ratio of 0.01.
The system parameter provided here helps to configure the compression ratio limit by the user, thus overriding the default 0.01 so as to avoid the security risk error due to high compression and the excel file can be imported to ADH without this issue.
Default Locale #
The default Locale specifies things like the date and time format used in some transformation functions. Choose the locale required from the drop down list.
| Mandatory | Relevant when |
|---|---|
| Yes | The locale of the transformation mappings differs from the standard locale of your desktop. |
Input Data Mapping Name xPath #
Used to speed up the process of finding a suitable mapping to be automatically assigned when a document with no mapping is being processed.
If the ‘Input Data Mapping Name XPath’ system parameterhas been set, AND this xPath expression is able to extracta non-empty value from the XML input file, AND this value matches the name of an active mapping, then this mapping will be assigned (given that the blocks on the validation tab execute successfully).
Else, all active mappings will be tested, and if there is one and only one mapping that matches, this mapping will be assigned.
| Mandatory |
|---|
| No |
Handling of invalid UTF-8 multi-byte sequences in XML documents #
XML documents that are to be imported into ADH (from Workstation or through ADH Server) must be UTF-8 encoded.
The system parameter(s) provided here determine what action to take should an invalid multi-byte sequence be detected (possibly because the document is actually Windows-1252 encoded).
| Action | Description |
|---|---|
| Fail | Fail the import. |
| Remove | Remove the first byte of the sequence. |
| Replace | Replace the first byte with the given replacement character. |
| Convert | Import the document assuming Windows-1252 encoding. |
| Mandatory | Default value |
|---|---|
| No | ‘Fail’ |
Excel Import #
When Excel spreadsheets are imported into ADH, cells formatted as Date will be converted to a string representation of the date value.
This conversion uses default settings that are not always fitting.
If Date Format is specified with a non-empty value, it will be used in conjunction with the selected Locale to convert the date. Otherwise, the default settings mentioned above will be used.
The allowed values for Date Format is described here:
SimpleDateFormat
Built-in date and time formats such as formats that begin with an asterisk (*) respond to changes in regional date and time settings in the operating system. To apply the custom conversion to such cells only, tick the Apply to date cells with built-in formatting only check-box.