Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Registration parameters are string properties that identify documents and batches — for example, the scan date or the name of the scanning operator. Values flow to Vantage along with the batch for further processing. Registration parameters can be attached to either a batch type or a document type. If you use one batch type to process different kinds of documents, you can create multiple document types with different parameter sets.

​
Where to configure

You can define registration parameters when you create a batch type in the Batch Type Wizard or later in the Batch Type Properties dialog box. Operators edit values — as long as the parameter isn’t read-only — on the Batch and Document tabs of the Registration Parameters window. The setup flow is the same for batch types and document types, except document types let you choose between two parameter types: Text or Drop-down list.

​
Add a registration parameter

1

Open the right list

In the Batch Type Properties dialog box:
  • For a batch type — on the Batch Registration Parameters tab, click New….
  • For a document type — on the Document Types tab, click Add… next to the registration parameters list.
2

Name the parameter

In the Registration Parameter dialog box, type a name.
3

Pick a type

From the Type drop-down, select Text or Drop-down list. The available settings below depend on the type you pick.

​
Text parameters

Text parameters are non-empty strings. The value can come from what the Operator types, from auto-generated tags, or a combination. The Default value field holds the user-entered text and any auto-insertion tags.

​
Auto-insertion tags

Select any of the following to include the value automatically in the parameter:
TagInsertsToken
OperatorName of the user who started the Scanning Station<O>
StationName of the computer on which the program is installed<S>
Station IDIdentifier of the Scanning Station<I>
DateDate the batch or document was created<D>
TimeTime the batch or document was created<T>

​
Validation

  • Check using regular expression — validates the parameter value against a pattern. If a batch contains a value that doesn’t match, Scanning Station blocks the export and shows a message.
  • Read-only — prevents the Operator from changing the default value. Not compatible with Check using regular expression.
Drop-down-list parameters offer values from a list. Populate the list manually, from a TXT file, or from an external source.

​
Add values manually

Click Add… next to the drop-down list, then type a value in the dialog box that opens.

​
Import from a TXT file

Click Import, choose a TXT file, and Scanning Station adds one parameter value per line to the list.

​
Import from an external source

Select Use external source of values, then pick the source type in the Values Source Settings dialog box. Make sure every Scanning Station that will use this source can reach it. For example, to bind a TXT file as an external source, click Browse and pick the file in the Source of Values dialog box.
Values from an external source are refreshed only when the batch type is created or edited — not continuously.

​
Re-import

To re-import registration parameters from the source, click Import… on the Batch Registration Parameters tab of the Batch Type Properties dialog box. On re-import:
  • Manually added parameters are preserved.
  • Imported parameters are refreshed with the source’s latest values.
You can remove any parameter and change the Required flag on imported parameters.

​
Options for both types

OptionDescription
RequiredThe parameter must have a value. A batch can’t be exported if a required parameter is empty.
CommentFree-form comment about the parameter.