Registration Parameters of Batches and Documents

Registration parameters are string properties used for identifying documents and batches. Examples of registration parameters include the date of scanning or the name of the scanning operator. Registration parameters can be specified for batch types or for document types. For example, if you use the same batch type to process different documents, you can create multiple document types with different registration parameters in that batch. You can specify registration parameters in one of the following ways:

• When you create a batch type.
• At a later time in the properties dialog box of an existing batch type.

You can modify the registration parameters of batches and document types (if they are not read-only) on the Batch and Document tabs of the Registration Parameters dialog box. For more information, see Specifying registration parameters. The process of specifying registration parameters is the same for document types and for batch types, but for document types you also have a choice of two types of registration parameters — text or drop-down list. An operator can be assigned to specify or check specific registration parameters of batches and documents when a new batch is created.

​

Add a registration parameter

​

Configure registration parameters

​

Text registration parameters

Registration parameters of this type are text strings, which can consist of user-specified text, automatically generated text, or a combination of the two, but cannot be empty. The Default value field contains user-specified text (if any) and automatically generated tags (if auto tags are enabled). The following data can be automatically included in a registration parameter of type Text:

• Operator — The name of the user that started the Scanning Station (the <O> tag)
• Station — The name of the computer on which the program is installed (the <S> tag)
• Station ID — The identifier of the Scanning Station (the <I> tag)
• Date — The date when the batch or document was created (the <D> tag)
• Time — The time when the batch or document was created (the <T> tag)

To include data in a registration parameter automatically, select the options you want. Additionally, the following options are available:

• Check using regular expression — Checks if the registration parameter fits a template. The template is specified using the Alphabet Used in Regular Expressions. If the registration parameter does not fit the template, the batch cannot be sent anywhere. If an attempt is made to send a batch with such a registration parameter, a message is displayed explaining that the registration parameter does not fit the template.
• Read-only — If this option is enabled, the operator will not be able to change the default value. This option is not available if the Check using regular expression option is enabled.

​

Drop-down list registration parameters

A value for registration parameters of this type is selected from a drop-down list. Items in this drop-down list are either created by an operator or imported from a TXT file or a database. This can be done in one of the following ways:

• Create a list item manually — To add a registration parameter to the drop-down list manually, click the Add… button. In the dialog box that opens, type a value for the registration parameter (see Text registration parameters above).
• Import list items — To import registration parameters from a text file, click the Import button. In the dialog box that opens, select the TXT file from which you want to import registration parameters. A registration parameter will be created from each line in the TXT file and added to the list.
• Import list items from an external source — Select the Use external source of values option, and then select the type of the external source in the Values Source Settings dialog box.

To import from a file, click the Browse button and select a file in the Source of Values dialog box. A registration parameter will be created from each line of the file. To connect to an external database:

1. Click the Set Up… button in the Values Source Settings dialog box.
2. Select a provider on the Provider tab.
3. On the Connection tab, specify a connection string and connection settings.
4. Test the connection to the database if necessary.
5. Click OK.
6. In the Values Source Settings dialog, specify a schema, a database table, and a database field.
7. Click OK.

The following database types are supported:

• Microsoft SQL
• Oracle
• Azure
• Microsoft Access

​

Import registration parameters from ABBYY FlexiCapture

Clicking the Import button on the Batch Registration Parameters tab of the Batch Type Properties dialog box loads the registration parameters specified for this batch type in your ABBYY FlexiCapture project. When you import registration parameters once again:

• Any registration parameters added manually will be preserved.
• If an existing registration parameter has the same name as a registration parameter in your ABBYY FlexiCapture project, the parameter from the ABBYY FlexiCapture project and its settings will be used.
• The imported registration parameters will be updated.
• If a registration parameter was renamed on the Scanning Station, it will be preserved and the parameter from the ABBYY FlexiCapture project will be added once again.
• If a registration parameter was renamed in the ABBYY FlexiCapture project, the old registration parameter will be removed from the Scanning Station and the new parameter will be imported.

You can also remove any registration parameter and modify the Required option for imported registration parameters. The following options are available for registration parameters of both Text and Drop-down list types:

• Required — Indicates that the parameter must have a value. A batch with a required registration parameter cannot be exported unless the registration parameter has a value.
• Comment — A comment for the registration parameter.