Registration parameters are textual properties that identify a specific batch or document. These properties can be the scanning date, the name of the scanning operator, etc. A registration parameter may be either required or optional.
Registration parameters can be assigned to a batch when it is created (if it is created automatically using image import profiles). Registration parameters can also be assigned to batches and documents on the Scanning Station and sent to ABBYY FlexiCapture together with the images.
Registration parameters can be configured on the Registration Parameters tab of the Batch Properties or Document Properties dialog box (click Properties... on the shortcut menu). You may need to modify registration parameters if:
- The FlexiLayout is used to check if certain data occur on a document.
- Some already known information that may affect field search is written into the registration parameters of a document. For example, a detected classifier class or a preset vendor may be written into the registration parameters and then passed into the FlexiLayout.
A registration parameter can be passed to a main or an additional FlexiLayout. In this case, the input named parameter of the FlexiLayout in ABBYY FlexiLayout Studio must be of type String and its name must be the same as the name of the registration parameter in ABBYY FlexiCapture.
Registration parameter names and values can be used as a filter for the task queue on the Web Verification Station. For more information, see the Web Verification Station help guide.
Note: It is recommended to specify different names for batch and document registration parameters. If the names are identical, the document registration parameter will be used (for example, when generating file names during export).
Named registration parameters
You can also use named registration parameters to specify document processing settings.
- fc_Predefined:DefinitionsToMatch
This registration parameter allows you to specify which Document Definitions should be used. The value of this registration parameter can be the name of a Document Definition, the name of a section, or the names of multiple sections separated by semicolons, for example:
"Document Definition 1; Document Definition 2\Section 1; Document Definition 2\ Section 2".
This registration parameter can be filled in by a scanning operator, either manually or by using a script. It is also possible to fill in this parameter at any stage preceding recognition if it becomes clear which Document Definition should be applied (e.g. as a result of classification).
- fc_Predefined:DocumentError
If this parameter is not empty, then, at the export stage, the document will be deemed to contain an error and will be exported using the export profile designed for exporting documents with errors. The error description will contain the value of the registration parameter.
Storing basic message headers in the registration parameters
When importing images from an e-mail folder using the MAPI, IMAP or POP3 protocols, the details of the corresponding e-mail message will be automatically written into the registration parameters of the newly created batch. The following parameters will be added:
- fc_Predefined:EmailSubject
The subject of the e-mail message.
- fc_Predefined:EmailSender
The sender's address.
- fc_Predefined:EmailAddressee
The addresses of the recipients in the "To" field.
- fc_Predefined:EmailCopyAddressee
The addresses of the recipients in the "Cc" field.
Note: This parameter cannot be longer than 255 characters. If the total size of all the addresses in the "Cc" field exceeds 255 characters, the excess characters will be truncated.
- fc_Predefined:EmailDate
The date and time when the message was received.
Note: If you don't want the details of the e-mail message to be written into the registration parameters of the newly created batch, set the following Windows registry key to "false":
[HKEY_CURRENT_USER\Software\ABBYY\FlexiCapture\12.0\Controller] "UseHotFolderSpecialParameters"="false".