English (English) - Change language

Integrating Web Stations into third-party systems

ABBYY FlexiCapture 12 allows you to integrate its Verification stage into a third-party system, such as Microsoft SharePoint. ABBYY FlexiCapture 12 must be connected to the third-party system by means of the Single Sign-On technology.

The instructions provided in this section assume that Windows authentication is used. Alternatively, you can use FlexiCapture or SAML authentication.

First, you need to create an <iframe> child element.

To load the ABBYY FlexiCapture 12 GUI and functionality into the <iframe> element, set the value of the src attribute to:

<stationUrl>/WinAuth/#/Verify?projectId=[project identifier]&roleId=[role identifier]&stageId=[stage identifier]&taskId=[task identifier]&returnTo=DeadEnd, where:

Name Obligatory Description
<stationUrl> The address of the Verification Station to be accessed by the third-party system. The default value is <serverName>/FlexiCapture12/VerificationNew.
WinAuth Windows authentication parameter.
projectId The ID of the project. If only project ID is specified, a random task will be taken from among the tasks available in this project.
roleId The ID of the Operator’s role. This parameter is not dependent on any of the other parameters. If no role ID is specified, the top-most role allowed for the user will be used for the task.
stageId The ID of the stage from which to take the task.
taskId The ID of the task that requires verification.
returnTo=DeadEnd The parameter shows that the program will switch to the final page once the task is processed and the user will not be able to continue working with the Verification Station.

Note: The ability to return to the third-party system from the final page displayed by the Verification Station must be implemented by the developer.

Users will interact with the integrated Verification Station in the same manner they interact with non-integrated Verification Stations in the standard processing scenario. A customized menu is used for forwarding tasks to the next stage and for exiting the integrated Verification Station.

You can set up the integrated Verification Station by editing the keys in the <appSettings> section of the Web.config file. To disable a menu item, set the corresponding key to true:

  • DisableSendToRescan – sends a task to the rescanning stage
  • DisableTaskPostponement – postpones a task
  • DisableSendToStage – sends a task to a specific stage
  • DisableSendToExceptions – sends a task to Exceptions

We recommend disabling the display of the Verification Station header. This will ensure that the user can only access a specific batch and will not see the program features unrelated to the task at hand. To conceal the verification Station header, set the Headless key to true.

When the user finishes processing the task and exits the integrated Verification Station, the postMessage method will pass one of the following messages to the parent element:

  • FC_Verification_TaskClosed – The task was closed and sent to the Export stage.
  • FC_Verification_TaskSentToRecognition – The task was sent to the Re-recognition stage.
  • FC_Verification_TaskSentToStage – The task was sent to another stage.
  • FC_Verification_TaskSentToExceptions – The task was sent to Exceptions.
  • FC_Verification_TaskPostponed – The task was postponed.
  • FC_Verification_TaskSentToRescan – The task was sent to the Re-scanning stage.
  • FC_Verification_CantGetTask – The program failed to get the task for some reason.
  • FC_Verification_TaskRejected  – The task was rejected.

Sample code for receiving a message from the parent element

Once the message from the <iframe> element is processed, the integrated Verification Station can be closed down and the user will be able to resume his/her work with the third-party system.

10/3/2017 12:17:44 PM

Please leave your feedback about this article