Integrate ABBYY Vantage with Flowable
Target audience: Modelers, administrators
Introduction
With v3.17.0+ we introduced a new integration with ABBYY Vantage in Flowable. This integration allows you to use the ABBYY Vantage service to extract data from documents in your Flowable processes or cases. In this How-To, we will show you how to:
- Configure the connection to ABBYY Vantage via Oauth2 with client credentials
- Use the new ABBYY Service Task (CMMN and BPMN) to extract data from a document and store it in a process instance or case instance variable
The ABBYY Vantage integration is a connector that is not enabled in Flowable by default and requires an additional license.
Configuration
To enable the ABBYY Vantage integration we need to:
- create a secret in ABBYY Vantage
- configure the Flowable application properties
Secret in ABBYY Vantage
To create a secret in ABBYY Vantage, follow these steps:
- Log in to your ABBYY Vantage account.
- On the left side, open the Configuration section.
- Select the Public API Client menu.
- Add a new client by clicking on the Add client button.
- Activate the "Allow client credentials flow" option and open the Manage Roles menu.
- Add the Manual Review Operator and **Skill User** Roles. You can decide if you want to allow that for all skills, or select specific ones.
Configure Flowable
To configure the connection to ABBYY Vantage, you need to add the following properties to the flowable-ui-app.properties
file:
spring.security.oauth2.client.registration.abbyy.client-id=<yourClientId>
spring.security.oauth2.client.registration.abbyy.client-secret=<yourClientSecret>
spring.security.oauth2.client.registration.abbyy.scope=openid,permissions,global.wildcard
spring.security.oauth2.client.registration.abbyy.authorization-grant-type=client_credentials
spring.security.oauth2.client.provider.abbyy.token-uri=https://vantage-eu.abbyy.com/auth2/connect/token
flowable.abbyy.registration-id=abbyy
flowable.abbyy.api-base-url=https://vantage-eu.abbyy.com/api/publicapi/v1/
ABBYY Vantage in Flowable
Use the ABBYY Service Task
With the ABBYY Service Task, you can trigger the extraction of data from a document. To use the ABBYY Service Task, follow these steps:
- Add the ABBYY Service Task to your process or case
-
Configure the input documents (content items) and the ABBYY Vantage skill you want to execute. The Input documents should resolve to a list of content items, a list of content items ids, a single content item or a single content item id.
-
Set the Output Variable Name to store the extracted data
You can define field mappings. These mappings will limit the data that is stored in the output variable. If you don't define any field mappings, all data will be stored in the output variable.
Manual Review
To allow the users to interact with the ABBYY transaction, you can use the ABBYY Vantage Manual Review Activity. This will hold the data extraction until the user has reviewed and approved the extracted data. Flowable can react to that state of the ABBYY transaction by providing a form that will be used to review the transaction by a user within Flowable.
Manual Review is only available for ABBYY Vantage transactions on process skills and if the process skill contains the Manual Review Activity
To display the manual review, Flowable provides a new form component called ABBYY Manual Review. It is an encapsulated iframe that will display the ABBYY Manual Review form.
At runtime, Flowable will create a new Task in case a manual review is required. The user can then open the task and review the extracted data.