Integrating the scanning stage - ABBYY Documentation

The instructions provided in this section assume that Windows authentication is used. Alternatively, you can use FlexiCapture or SAML authentication. To load the Scanning Station GUI and functionality, use the <iframe> element. The following scenarios are supported:

Creating a batch

To create and open a new batch with certain registration parameters, set the value of the src attribute to:<stationUrl>/WinAuth/Manage/Create?projectId=[project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value], where

Name	Obligatory	Description
<stationUrl>		The address of the Scanning Station to be accessed by the third-party system. The default value is <serverName>/FlexiCapture12/Scanning.
WinAuth		Windows authentication parameter.
Create		The name of the command that creates a new batch.
projectId		The ID of the project where the batch is to be created.
batchTypeName		The type of the batch to be created.
batchName		A name for the new batch. If no name is specified, the program will select a name based on the settings of the selected batch type.
regparam		A registration parameter in the format “name:value”. The regparam registration parameter must be specified in the settings of the batchTypeName batch type on the web station. Otherwise, this parameter will be ignored. Note: You can pass more than one registration parameter by joining multiple parameters with the ”&” symbol.

Opening a batch

To open an existing batch with certain registration parameters, set the value of the src attribute to:<stationUrl>/WinAuth/Manage/Open?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value], where

Name	Obligatory	Description
<stationUrl>		The address of the Scanning Station to be accessed by the third-party system. The default value is <serverName>/FlexiCapture12/Scanning.
WinAuth		Windows authentication parameter.
Open		The name of the command that opens an existing batch. Important! If there is more than one batch in the project, the alphabetically first batch will be taken.
projectId		The ID of the project that contains the batch to be opened.
batchName		A new name for the batch. Use this parameter if you want to rename the batch.
regparam		A registration parameter in the format “name:value”. The regparam registration parameter must be specified in the settings of the batchTypeName batch type on the web station. Otherwise, this parameter will be ignored. Note: You can pass more than one registration parameter by joining multiple parameters with the ”&” symbol.

Important! You can only open a batch that has not yet been uploaded to the server.

Opening a requested batch and creating a new batch if the requested batch does not exist

To open a requested batch and create a new batch if the requested batch does not exist, set the value of the src attribute to:<stationUrl>/WinAuth/Manage/OpenOrCreate?projectId=[Project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value], where

Name	Obligatory	Description
<stationUrl>		The address of the Scanning Station to be accessed by the third-party system. The default value is <serverName>/FlexiCapture12/Scanning.
WinAuth		Windows authentication parameter.
OpenOrCreate		The name of the command that opens a requested batch or creates a new batch if the requested batch does not exist.
projectId		The ID of the project that contains the batch to be opened/created.
batchTypeName		The type of the batch to be opened/created.
batchName		A new name for the batch. Use this parameter if you want to rename the existing batch or assign a name to a new batch. If this parameter is not used while creating a new batch, the program will select a name based on the settings of the selected batch type.
regparam		A registration parameter in the format “name:value”. The regparam registration parameter must be specified in the settings of the batchTypeName batch type on the web station. Otherwise, this parameter will be ignored. Note: You can pass more than one registration parameter by joining multiple parameters with the ”&” symbol.

Important! You can only open a batch that has not yet been uploaded to the server.

Getting a rescanning task

To get a rescanning task, set the value of the src attribute to:<stationUrl>/WinAuth/Manage/GetRescan?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value], where

Name	Obligatory	Description
<stationUrl>		The address of the Scanning Station to be accessed by the third-party system. The default value is <serverName>/FlexiCapture12/Scanning.
WinAuth		Windows authentication parameter.
GetRescan		The name of the command that gets an existing rescanning task. Important! If there is more than one task in the project, the alphabetically first task will be taken.
projectId		The ID of the project that contains the batch to be rescanned.
batchName		A new name for the batch. Use this parameter if you want to rename the batch to be rescanned.
regparam		A registration parameter in the format “name:value”. The regparam registration parameter must be specified in the settings of the batchTypeName batch type on the web station. Otherwise, this parameter will be ignored. Note: You can pass more than one registration parameter by joining multiple parameters with the ”&” symbol.

When the user is finished working with the batch and exits the integrated Scanning Station, the postMessage method is used to pass the FC_Scanning_TaskClosed message to the parent element. The final page will open. The developer must direct the user from the final page back to the third-party system.

Use URL encoding if you need to pass non-English (e.g. Japanese) characters as parameter values in the URL.