FlexiCapture Connector

for Guide

FlexiCapture as an unattended
service
FlexiCapture as an unattended service
Contents

How to run Sample FlexiCapture project

• FlexiCapture side
• UiPath side

Configuring ABBYY FlexiCapture project settings

• Configure document export settings
• Configure document processing settings

2
How to run Sample FlexiCapture
project

3
 How to run Sample FlexiCapture project:
FlexiCapture project settings

Step 1
• Open the sample project – InvoiceDemoProject
on the Project Setup Station
• Click File>Upload Project to Server
• Open project from the server

Note! To be able to send documents from UiPath to

ABBYY FlexiCapture, you need to open
the following port in the firewall to the Application
Server: port 80 (if HTTP is used) or port 443
(if HTTPS is used)

How to run Sample How to configure 4

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 How to run Sample FlexiCapture project:
UiPath settings
Step 2
• Find the NuGet package named
Abbyy.Activities.UiPath.FlexiCaptureActivities
.
<version>.nupkg
in the distribution package and place it into a
local folder
• Create a new project in UiPath Studio
To do this, click the Start tab and then click
Process
• Specify name and location for a project and
click Create button

How to run Sample How to configure

5
Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 UiPath settings: Configure package source
with ABBYY FlexiCapture 12 activity

Step 3
• On the Design tab, click the
Manage Packages button
or press Ctrl+P

How to run Sample How to configure 6

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 UiPath settings: Configure package source
with ABBYY FlexiCapture 12 activity

Step 4
• Click the Settings tab
• Create a new package source: click ‘+’
• Name: packages
• Source: path to the folder that
contains the package
Abbyy.Activities.UiPath.FlexiCapture
Activities.<version>.nupkg
• Click Add
• Click Save to confirm the settings

How to run Sample How to configure 7

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 UiPath settings: Installing the NuGet package
in UiPath Studio

Step 5
In the UiPath sample process "ABBYY
FlexiCapture 12 Processor"
Abbyy.Activities.UiPath.
FlexiCaptureActivities is already
installed in the project dependencies

To see that activity is available

click All Packages and select the newly
created packagesource

How to run Sample How to configure 8

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 UiPath settings: Installing the NuGet package
in UiPath Studio

Step 6
• Open a sample project included in
distribution kit
ABBYY FlexiCapture 12 Processor
• In the Main window, double-click to
view Processing Files (for each)
activity

How to run Sample How to configure 9

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 UiPath settings:
Setting up the ABBYY FlexiCapture Activity

Step 7:
• Expand Data Capture activity and specify
connection settings to the ABBYY FlexiCapture
Application Server
• Server URL
• Company (optional)
• User Name
• Batch Type - write “Unattended service”

How to run Sample How to configure 10

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 UiPath settings:
Setting up the ABBYY FlexiCapture Activity

Step 8:
• Open Get Password activity and
specify Password of the ABBYY
FlexiCapture user

How to run Sample How to configure 11

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 How to run Sample FlexiCapture project

Step 9
• Create input folder and output
folder in which you need to save
results
• Put the image file to the input folder
(You can use sample images from
distribution package)
• Click Run to start the processing

How to run Sample How to configure 12

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
 How to run Sample FlexiCapture project:
Results

Step 10
• Select input and output folders
• Wait when the input file will be processed
• Open output folder and check the result

The process in this sample project prompts

the user to select a folder with files and
output folder, sends each file from the folder
to ABBYY FlexiCapture, waits up to 5 minutes
for the files to be processed, and receives:
• the resulting files from FlexiCapture
• a list of the captured fields and their
values

How to run Sample How to configure 13

Step 1 2 3 4 5 6 7 8 9 10
FlexiCapture project FlexiCapture project
How to configure FlexiCapture
project for unattended usage scenario

14
 How to configure FlexiCapture project for unattended
usage scenario

Step 1
• Open the project in Project Setup Station
• Go to Project > Project properties >
General tab
• Export root path must be blank

How to run Sample How to configure 15

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Сonfigure the export profile

Step 2
• Click Project > Document Definitions...
• Select the Document Definition and click
Edit...
• Click Document Definition menu >
Document Definition properties… > Export
Destinations tab
• Click the Add...

How to run Sample How to configure 16

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure the export profile

Step 3
Select the Type of Destination
• Type: Export to data files
• Select Critical option
• Select Save document images if required
• Document condition: Errors are irrelevant
• Uncheck Field condition
• Click Next

How to run Sample How to configure 17

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure the export profile

Step 4
Export Data to Files
• Target: Create folder structure and filename
using template
• Make sure the Export path field
is empty
• If file exists: Add suffix to name of new file
• Go to Template > Edit

How to run Sample How to configure 18

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 5
Set up filename template
• View: Advanced
• Use Tags to specify filename template
• Click OK and Next

You can specify Filename template:

<RegParam:FileNameWithoutExtension>
to use the name of the source file for naming
export files

How to run Sample How to configure 19

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 6
• File format: XML Document (*.xml)
If you want to define fields
for export, go to Set Up Field Mapping…
• Click Next

How to run Sample How to configure 20

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 7
Set up Export Images to Files
• Select Save Images with Data
• Template: Same as data
If you need to redact sensitive data on images,
go to Select Fields to Redaction…
• Click Next

How to run Sample How to configure 21

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 8
Select Image File Format
• Image file format depends
on your requirements
• Click Next

How to run Sample How to configure 22

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 9
• Select the Destination Name
Name: Export to XML
• Click Finish

How to run Sample How to configure 23

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 10
• Check the Enabled flag
• Save and close the Document Definition

How to run Sample How to configure 24

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 11
• Publish the Document Definition

How to run Sample How to configure 25

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Document Processing settings

Step 12
• Go to Project > Batch Types
• Click New to create new batch type

How to run Sample How to configure 26

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Document Processing settings

Step 13
• Go to Image Processing Options
• Select Create document -
For each image file
• Click Next until you get to Workflow settings

How to run Sample How to configure 27

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
 Configure FlexiCapture as unattended service

Step 14
• Select Unattended schema
• Click Next
• Name the batch type as Unattended service
• Click Finish

The project is ready!

Upload it to the server and open

(File > Upload Project to Server)

How to run Sample How to configure 28

FlexiCapture project FlexiCapture project
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14
For details, see the Administrator’s
Guide

29