Reconciliation
You are able to add, edit, delete, save and run Reconciliation Processes depending on the settings of the Project.
A Reconciliation Process allows you to create references between Object and/or Categories based on a user specified configuration.
Add / Edit an Reconciliation Processes
Specify the name of the Reconciliation Processes. This name is used to identify the Reconciliation Processes.
Source Value
The source of a Reconciliation Processes are Descriptions that have been configured as 'String', 'Text', 'Text (layout)', or 'Text (tags & layout)'.
| Type | Use the dropdown menu to select an Object Type or Classification. Click the blue 'filter' button to specify a Filter. Only filtered Objects or Categories will be used. |
| Source | Use the dropdown menu to select a Description. Click 'add' to add additional Descriptions. Click 'del' to remove empty Descriptions. |
Reconcile / Test
Use Descriptions that have been configured as 'String', 'Text', 'Text (layout)', or 'Text (tags & layout)' as the reconciliation value. All selected Objects or Categories will be reconciled with the Source Value based on the values stored in the selected Descriptions.
| Type | Use the dropdown menu to select an Object Type or Classification. Click the blue 'filter' button to specify a Filter. Only filtered Objects or Categories will be used. |
| Value | Use the dropdown menu to select a Description. Click 'add' to add additional Descriptions. Click 'del' to remove empty Descriptions. |
Store Result
Specify how and in which Description the resulting references should be stored.
| Save | Select 'Overwrite' to overwrite existing references. Select 'Append' to append new references to existing references. |
| Tags | If the Source Description is configured as 'Text (tags & layout)', references can be stored as tags. |
| Object Description | Use the dropdown menu to select a Description or Location Reference in which the resulting reference is to be stored. |
Run a Reconciliation Processes
To run a Reconciliation Processes, click the green 'run' button at the relevant Reconciliation Processes.
If a Reconciliation Processes has been intermitted or has been completed, the amount of processed Objects will be displayed. This number can be reset to 0 by clicking the red 'reset' button.
The following parameters can be specified for every run of the Reconciliation Processes.
| Process Objects Batch | Set the amount of Objects to be processed in one batch. Between 1 and 20. If Auto-Save Results is set to 'None', the amount of Objects in one batch will be displayed for further inspection. |
| Auto-Save Results | Specify whether results should be auto-saved if Objects have been linked, auto-discarded if no Objects have been linked, or if no automated action should be taken. |
| Score Threshold | Discard the Object match when the computed score is below this threshold. Between 1 and 100. |
| Score Multi-Match Difference | Maximum difference in score when multiple Object patterns match on the same text. Keep the highest scoring Object and other Objects this close to that score. Between 0 and 99. 0 will keep only those Objects that have a score as high as the highest scoring Object. 99 will keep every Object that scores above the score threshold. |
| Score Multi-Overlap Difference | Maximum difference in score when multiple Object patterns overlap on the same text. Keep the highest scoring Object and other Objects this close to that score. Between 0 and 99. 0 will keep only those Objects that have a score as high as the highest scoring Object. 99 will keep every Object that scores above the score threshold. |
| Pattern Sensitivity | Set the sensitivity to match a value part of an Object's pattern. Between 0 and 100. 0 allows for the value to match anywhere. 100 allows for the value to match a word; value is surrounded by whitespace or punctuation. |
| Pattern Distance | Maximum distance in characters between separate matched values by an Object's pattern. |
| Extend Match | Extend a matched value to the nearest whitespace or punctuation (i.e. whole word). |
Click 'Run Reconciliation' to run the Reconciliation Process.
If the Reconciliation Process is configured to auto-save the results, you will be shown the result of the run.
If the Reconciliation Process is configured not to auto-save the results, you will be prompted with an overview of the results. The Objects of the current batch will be displayed together with the results. When multiple matches have been found, you can select the Object or Objects that should be saved as a result.
If the Reconciliation Process is configured to store tags, the text and the generated tags will be displayed. Click the blue 'edit' button to edit the tags.
Click 'Continue' to run the next batch of Objects. The currently applied parameters of the Reconciliation Processes are displayed and can be adjusted.