Setting up Enate & ABBYY Integration

In order to integrate with ABBYY FlexiCapture, you need to:

1. Set up an ABBYY FlexiCapture connection

2. Create an ABBYY FlexiCapture Action type

3. Add an ABBYY FlexiCapture Action into you Case flow

Note: Only filetypes supported by ABBYY v12 onwards will be submitted. See the following link for list of formats supported by ABBYY: https://help.abbyy.com/en-us/flexicapture/12/standalone_operator/input_formats

1. Setting up an ABBYY FlexiCapture connection

In order to enable ABBYY FlexiCapture integration, a connection to an active ABBYY instance must be configured in Enate's Builder app. These settings are accessed from the ABBYY section in Enate's Marketplace:

Clicking on 'Activate' will take you to a page where you can view your OCR Connections. Click to add a new connection and then in the subsequent pop-up, provide the following details:

Field	Details
Platform Name	A friendly name for use when selecting the platform during the subsequent set up of an ABBYY OCR Action when creating your Case flow.
URL	The root URL for the FlexiCapture installation including http or https as appropriate i.e. for an installation accessed at https://my-abbyy/FlexiCapture12/Login/#/Login.
Username	The username must be from an account which has Scanning Operator, Verification Operator and External User permissions.
Password	The password must be from an account which has Scanning Operator, Verification Operator and External User permissions.

Once you have supplied this information, click to test the connection.

Once the connection has been tested successfully, your ABBYY integration is successfully connected with Enate. Enate will now automatically sync project lists with ABBYY; ABBYY projects do not need to be manually added to Enate.

Important note: The ABBYY server must be accessible from the Enate Application tier AND from the browsers of your end users. In the case of Enate SaaS this means that ABBYY must be internet-facing.

2. Creating an ABBYY Action Type

Once you have successfully set up an ABBYY FlexiCapture connection, you then need to create an ABBYY FlexiCapture Action type.

You can either do this in the Service Line section of Builder, or directly from your Case flow.

From the Service Lines Page

Creating an ABBYY FlexiCapture Action type from the Service Lines section of Builder adds the Action to your menu of available Actions when you're building flows subsequently in Cases.

To do this, in the Service Lines page select, which service line you would like to add the ABBYY Action to and then click on the plus symbol next to the 'Process Search' box. This will bring up a drop down menu where you can select an Action.

This will open up a new Action for you to create.

Add a name and description to your Action and then in the 'type' drop down select 'ABBYY OCR'.

You can then choose to add a global checklist to your ABBYY FlexiCapture Action. This contains a standard checklist of activities that will be added any time this Action type is added to a Case flow. See here for more information on checklists.

Once you are happy with your Action, hit save to create it. This Action can now be added to new and existing business processes by selecting it from the dropdown list when adding a new Action to a Case.

From a Case Flow

Alternatively, you can add an ABBYY FlexiCapture Action type directly from the Case flow itself.

To do this, open your desired Case flow in edit mode, click on an Action's menu and then instead of clicking to add an existing Action, select to create a new Action by clicking the '+' icon.

Give the Action a name, add a description if you wish and for its 'type', select 'ABBYY OCR'. This will add the ABBYY FlexiCapture Action to the Case flow.

3. Adding an ABBYY FlexiCapture Action into you Case flow

Once you has successfully set up an ABBYY connection, you then need to add an ABBYY FlexiCapture Action in your Case flow.

Select the '+' icon on the Add Action Menu in the desired Case flow. Give the ABBYY Action a name and then assign it as an ABBYY OCR Action Type. This will add an ABBYY Action to the Case flow.

Once an ABBYY FlexiCapture Action has been added to your Case flow, a new section will display in the Action info grid.

Configuring an ABBYY Action

You now need to configure the settings for the new Action you have added to your Case.

Click on the Action in the flow to highlight it in the info section. In the Action Info tab, you need to add the following information:

Setting	Description	Notes
When is it due?	Select a due date from the dropdown menu of Due Date ‘flavours’	Mandatory to set live. (See Due Date Flavours Settings for more information).
Who does it go to?	Select a value from the dropdown menu of Allocation ‘flavours’	Mandatory to set live. (See Allocation Flavours Settings for more information).
General Settings	Select a value from the dropdown menu of Follow Up ‘flavours’	Mandatory to set live. (See General Settings Flavours Settings for more information).
Main Card	You can select a Custom Card to display on the main section of the Action screen.	Optional. See here for more information about Custom Cards.
Side Card	You can select a Custom Card to display on the side panel of the Action screen.	Optional. See here for more information about Custom Cards.
Manual Creation	Switching this setting on allows the Action to be started manually in Work Manager.	Optional. See Adding Ad-hoc Actions section for more information.
Checklist	Here you can add local checks to the Action that help support 'custom' activities that take place for that specific Action. You can also edit the global checks for the Action type from here too, if it has any.	Optional. See here for more information about adding checklists.
Email Reminder	Switching this setting on sends reminder emails to the Action assignee before and/or after the due date of the Action.	Optional.

Additionally, once an ABBYY Action has been added to your Case flow, a new 'ABBYY FlexiCapture' tab will display in the info grid.

Here you need to add the following settings that are only relevant for ABBYY Actions:

Setting	Description	Notes
Platform	The ABBYY Platform being used for this Action	Mandatory
Project	The ABBYY project this is part of.	Mandatory
Input File Tag	Only documents with this File Tag will be passed to ABBYY for processing with this Action.	Optional. If an Input File Tag has been specified then only files on this Action marked with this tag will be included in the ABBYY batch. If no Input File Tag is selected then all files attached to the Case will be included for scanning and processing by ABBYY FlexiCapture.
Output File Tag	When ABBYY is finished processing documents as part of this Action, it will pass them back to Enate marking them with this File Tag.	Optional. If an Output File Tag has been specified then all files processed by this Action will be tagged with the Output File Tag value when they are transferred back through to Enate.

Note : As an additional validation check, when configuring Case flows that includes ABBYY Actions, if any of the referenced platform are now deleted, the system will prompt you to replace this with an active ABBYY Platform.

Your ABBYY FlexiCapture Action is now ready to be used in your Case flows at runtime.

For detailed information on how ABBYY Actions work at runtime, see here:

pageHow ABBYY FlexiCapture Actions Work At Runtime