Integrate the scanning stage - ABBYY Documentation

These instructions assume Windows authentication. You can also use FlexiCapture or SAML authentication. To load the Scanning Station interface and functionality, use the <iframe> element. The station supports four scenarios: creating a batch, opening a batch, opening or creating a batch, and getting a rescanning task.

Use URL encoding to pass non-English characters, such as Japanese, as parameter values in the URL.

Create a batch

To create and open a new batch with certain registration parameters, set the src attribute to:

<stationUrl>/WinAuth/Manage/Create?projectId=[project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Yes	The address of the Scanning Station that the third-party system accesses. The default value is `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Yes	Windows authentication parameter.
`Create`	Yes	The name of the command that creates a new batch.
`projectId`	Yes	The ID of the project to create the batch in.
`batchTypeName`	Yes	The type of the batch to create.
`batchName`	No	A name for the new batch. Without a name, the program selects one based on the settings of the selected batch type.
`regparam`	No	A registration parameter in the format `name:value`. The parameter must be specified in the settings of the `batchTypeName` batch type on the web station, otherwise it is ignored. Join multiple parameters with the `&` symbol.

Open a batch

To open an existing batch with certain registration parameters, set the src attribute to:

<stationUrl>/WinAuth/Manage/Open?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Yes	The address of the Scanning Station that the third-party system accesses. The default value is `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Yes	Windows authentication parameter.
`Open`	Yes	The name of the command that opens an existing batch. If the project holds more than one batch, the command takes the alphabetically first one.
`projectId`	Yes	The ID of the project that contains the batch to open.
`batchName`	No	A new name for the batch. Use this parameter to rename the batch.
`regparam`	No	A registration parameter in the format `name:value`. The parameter must be specified in the settings of the `batchTypeName` batch type on the web station, otherwise it is ignored. Join multiple parameters with the `&` symbol.

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

Open or create a batch

To open a requested batch, and create a new one if the requested batch does not exist, set the src attribute to:

<stationUrl>/WinAuth/Manage/OpenOrCreate?projectId=[Project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Yes	The address of the Scanning Station that the third-party system accesses. The default value is `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Yes	Windows authentication parameter.
`OpenOrCreate`	Yes	The name of the command that opens a requested batch, or creates a new batch if the requested one does not exist.
`projectId`	Yes	The ID of the project that contains the batch to open or create.
`batchTypeName`	Yes	The type of the batch to open or create.
`batchName`	No	A new name for the batch. Use this parameter to rename an existing batch or to name a new one. Without it, a new batch takes a name based on the settings of the selected batch type.
`regparam`	No	A registration parameter in the format `name:value`. The parameter must be specified in the settings of the `batchTypeName` batch type on the web station, otherwise it is ignored. Join multiple parameters with the `&` symbol.

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

Get a rescanning task

To get a rescanning task, set the src attribute to:

<stationUrl>/WinAuth/Manage/GetRescan?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Yes	The address of the Scanning Station that the third-party system accesses. The default value is `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Yes	Windows authentication parameter.
`GetRescan`	Yes	The name of the command that gets an existing rescanning task. If the project holds more than one task, the command takes the alphabetically first one.
`projectId`	Yes	The ID of the project that contains the batch to rescan.
`batchName`	No	A new name for the batch. Use this parameter to rename the batch to rescan.
`regparam`	No	A registration parameter in the format `name:value`. The parameter must be specified in the settings of the `batchTypeName` batch type on the web station, otherwise it is ignored. Join multiple parameters with the `&` symbol.

Return to the third-party system

When the user finishes with the batch and exits the integrated Scanning Station, the postMessage method passes the FC_Scanning_TaskClosed message to the parent element and the final page opens. The developer must direct the user from that page back to the third-party system.

​Create a batch

​Open a batch

​Open or create a batch

​Get a rescanning task

​Return to the third-party system

Create a batch

Open a batch

Open or create a batch

Get a rescanning task

Return to the third-party system