UIPath FlexiCapture As An Attended Service

FlexiCapture Connector
for Guide
FlexiCapture as an attended
service
FlexiCapture as an attended service
Contents
How to run Sample FlexiCapture project

• FlexiCapture side
• UiPath side
Configuring ABBYY FlexiCapture project settings

• Connecting the libraries to a Document Definition
• 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 11 12 13 14 15 16
FlexiCapture project FlexiCapture project
Step 2
• Click Project > Document Definitions...
• Select the Document Definition
• Click Edit....

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 3
• Go to Document Definition > Document
Definition Properties...
> Export Destinations tab
• Select Export to UiPath and click Edit

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 4
• Click Edit Script
• Specify connection settings
to the UiPath Orchestrator
connectorSettings.DmsConnectionSettings.Server = "https://platform.uipath.com";
connectorSettings.DmsConnectionSettings.Repository = "Tenant";
connectorSettings.DmsConnectionSettings.Credentials.Username = "username";
connectorSettings.DmsConnectionSettings.Credentials.Password = "password"; connectorSettings.DmsConnectionSettings.Repository = "Tenant";
• Specify the queue name where connectorSettings.DmsConnectionSettings.Credentials.Password = "password";
transactions will be saved

(How to create a queue – see Step 5)
connectorSettings.MappedFields.DmsMetadataTemplate.Name = "QueueName";
• Save the changes and publish document connectorSettings.MappedFields.DmsMetadataTemplate.Name = "QueueName";
definition

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
UiPath settings: Queue
Step 5
• Open the UiPath
Orchestrator
• Click Queues and
create a new one
as it shown
on the picture

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
UiPath settings
Step 6
• 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

9
Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
UiPath settings: Configure package source
with ABBYY FlexiCapture 12 activity
Step 7
• On the Design tab, click the
Manage Packages button
or press Ctrl+P

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 8
• 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

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 9
• In the sample project
Abbyy.Activities.UiPath.
FlexiCaptureActivities
is installed in Project Dependencies
• Click Save

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 10
• Open a sample UiPath process
included in distribution kit
ABBYY FlexiCapture 12 Processor
• In the Main window, double-click to
view Processing Files (for each)
activity

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
UiPath settings:
Setting up the ABBYY FlexiCapture Activity
Step 11
• Expand Data Capture activity and
specify connection settings to the
ABBYY FlexiCapture Application
Server
• Server URL
• Company (optional)
• User Name
• Batch Type - type “Attended
service”

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
UiPath settings:
Setting up the ABBYY FlexiCapture Activity
Step 12
• Open Get Password activity and
specify Password of the ABBYY
FlexiCapture user

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
UiPath settings: Receiver process
Step 13
• Open the sample process - ABBYY
FlexiCapture 12 Receiver
• Click the Get Transaction activity
and on the Variables tab specify
the name of the queue from which
to take a transaction
• Make sure that the UiPath Robot is
running and Machine is connected
to Orchestrator
How to connect Robots to Orchestrator –

see the Guide
https://orchestrator.uipath.com/docs/connectin
g-robots-to-orchestrator
How to create a queue – see Step 5

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 14
• Open the sample process –
ABBYY FlexiCapture Processor
• 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

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 15
• 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:
• a URL to verification page on the ABBYY
FlexiCapture 12 Web Verification Station

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Step 16
• Verify the document and complete the
task
• Run the Receiver process
• Specify the output folder for the results
• Open output folder and check the
results

Step 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
How to configure FlexiCapture
project for attended usage scenario
20
Connecting the libraries to a Document Definition
Step 1
• On the Project Setup Station open your
ABBYY FlexiCapture project
• Click Project > Document Definitions...
• Select the Document Definition
• Click Edit....

Step 1 2 3 4 5 6 7 8 9 10 … 30
Connecting the libraries to a Document Definition
Step 2
• Go to Document Definition > Document
Definition Properties...
> .Net References tab
• Click the Add...
• Select Attached file
• Specify the path to the DLL files:
AfcDmsConnector.dll, DmsConnector.dll,
UiPathConnector.dll, and
Newtonsoft.Json.dll files
• Click Apply, OK and Save document
definintion

Step 1 2 3 4 5 6 7 8 9 10 … 30
Creating an export profile
Step 3
• Go to Document Definition
> Export Settings...
• Click the Add...

Step 1 2 3 4 5 6 7 8 9 10 … 30
Step 4
• Select Custom export (script)
• Select Critical option
• Select Errors are irrelevant
• Uncheck Field condition
• Click Next

Step 1 2 3 4 5 6 7 8 9 10 … 30
Step 5
• Click the Edit Script…
• Select C# .Net script language
• Paste into the script editor
the sample script
UiPath - ExportScript –
Configure by script.cs

Step 1 2 3 4 5 6 7 8 9 10 … 30
Step 6
• Specify the actual values required
to connect to the UiPath Orchestrator
connectorSettings.DmsConnectionSettings.Repository = "Tenant";
connectorSettings.DmsConnectionSettings.Credentials.Password = "password";
connectorSettings.MappedFields.DmsMetadataTemplate.Name = "QueueName";
You can always edit this script later

Step 1 2 3 4 5 6 7 8 9 10 … 30
Creating an export profile Это нужно?
Step 7 Code:
• Add the highlighted code using Abbyy.Connectors.Dms.ComFacade;
into the script using Abbyy.Infrastructure.Logging;
• Save the changes and close the script using System.Collections.Generic;
editor
if (Document.Properties.Has("WasVerified")
• Specify a name for your export profile – && Document.Properties.Get("WasVerified") ==
Export_to_UiPath bool.TrueString)
• Click Finish {
// TODO: Place the main code of your export
script inside these braces.
The newly created export profile //
will appear in the list of available export // Factory factory = new Factory();
profiles // . . .
}

Step 1 2 3 4 5 6 7 8 9 10 … 30
How to configure FlexiCapture project for attended
usage scenario
Step 8
• Select the box next to the profile
in the Enabled column
• Click the Add... button to create standard
XML export profile

Step 1 2 3 4 5 6 7 8 9 10 … 30
usage scenario
Step 9
• Select Export to data files from the Type
dropdown list
• Select Critical option
• Select Save document images option
• Select Errors are irrelevant
• Uncheck Field condition
• Click Next

Step 1 2 3 4 5 6 7 8 9 10 … 30
usage scenario
Step 10
• Make sure the Export path field
is empty
• Click Edit

Step 1 2 3 4 5 6 7 8 9 10 … 30
Configure FlexiCapture as attended service
Step 11
Set up filename template
• View: Advanced
• Specify filename template
(e.g. Data_<Identifier> )
• Click OK and Next
You can specify Filename template:

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

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 12
• File format: XML Document (*.xml)
If you want to define fields
for export, go to Set Up Field Mapping…
• Click Next

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 13
Set up Export Images to Files
• Select Save Images with Data
• Template: Same as data
• Click Next

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 14
Select Image File Format
• Image file format depends
on your requirements
• Click Next

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 15
• Select the Destination Name
Name: Export to XML
• Click Finish

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 16
• Check the Enabled flag
• Save and close the Document Definition

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 17
• Publish the Document Definition

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Document Processing settings
Step 18
• Go to Project > Batch Types
• Click New to create new batch type

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Document Processing settings
Step 19
• Go to Image Processing Options
• Select Create document -
For each image file
• Click Next until you get to Workflow settings

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 20
• Select Advanced schema
• Select the Verification stage
• Click Edit....

Step 1 … 11 12 13 14 15 16 17 18 19 20 … 30
Step 21
• Select the Enable web stations option
on the General tab
• Click OK to save the changes

Step 1 … 21 22 23 24 25 26 27 28 29 30
Select schema for workflow
Step 22
• Click the Stage... button to add
a new stage

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 23
• Select Automatic
• Click OK

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 24
• Provide a name for the new stage –
Post Verification Script Stage
• Make sure that the Wait for all documents
of a batch is selected
• Select the Linked to previous option

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 25
• On the Script tab select Document
processing
• Click the Edit script…

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 26
• Past the following C# .Net script code
Document.Properties.Set("WasVerified",
Document.Properties.Set("WasVerified",
bool.TrueString);
bool.TrueString);
• Save the script and close the Script Editor

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 27
• On the Entry Conditions tab
select Under these conditions
• Click the Rule...

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 28
• Provide a name for the new rule –
Previous stage was verification
• Select condition type - Script
• Click the Script… button
• Paste the following C# .Net script code:
Result.CheckSucceeded =
(Document.StageInfo.StageName ==
"Verification Postprocessing" ||
Document.StageInfo.StageName ==
"Verification");

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 29
• Save the newly configured rule
and the new script stage
Post Verification Script Stage

should be right after Verification stage
• Use Move Up or Move Down buttons to
correct the order of the stages

Step 1 … 21 22 23 24 25 26 27 28 29 30
Step 30
• Name the batch type
as Attended service
• Click Finish
The project is ready now!
• Upload it to the server

(File >Upload Project to Server)

Step 1 … 21 22 23 24 25 26 27 28 29 30
For details, see the Administrator’s
Guide
51

UIPath FlexiCapture As An Attended Service

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

UIPath FlexiCapture As An Attended Service

Uploaded by

Copyright:

Available Formats

FlexiCapture Connector

How to run Sample FlexiCapture project

Configuring ABBYY FlexiCapture project settings

Note! To be able to send documents from UiPath to

How to run Sample How to configure 4

How to run Sample How to configure 5

How to run Sample How to configure 6

transactions will be saved

• Save the changes and publish document connectorSettings.MappedFields.DmsMetadataTemplate.Name = "QueueName";

How to run Sample How to configure 7

How to run Sample How to configure 8

How to run Sample How to configure

How to run Sample How to configure 10

How to run Sample How to configure 11

How to run Sample How to configure 12

How to run Sample How to configure 13

How to run Sample How to configure 14

How to run Sample How to configure 15

How to connect Robots to Orchestrator –

How to create a queue – see Step 5

How to run Sample How to configure 16

How to run Sample How to configure 17

The process in this sample project prompts

How to run Sample How to configure 18

How to run Sample How to configure 19

How to run Sample How to configure 21

How to run Sample How to configure 22

How to run Sample How to configure 23

How to run Sample How to configure 24

How to run Sample How to configure 25

You can always edit this script later

How to run Sample How to configure 26

How to run Sample How to configure 27

How to run Sample How to configure 28

How to run Sample How to configure 29

How to run Sample How to configure 30

You can specify Filename template:

How to run Sample How to configure 31

How to run Sample How to configure 32

How to run Sample How to configure 33

How to run Sample How to configure 34

How to run Sample How to configure 35

How to run Sample How to configure 36

How to run Sample How to configure 37

How to run Sample How to configure 38

How to run Sample How to configure 39

How to run Sample How to configure 40

How to run Sample How to configure 41

How to run Sample How to configure 42

How to run Sample How to configure 43

How to run Sample How to configure 44

How to run Sample How to configure 45

• Save the script and close the Script Editor

How to run Sample How to configure 46

How to run Sample How to configure 47

How to run Sample How to configure 48

Post Verification Script Stage

How to run Sample How to configure 49

The project is ready now!

• Upload it to the server

How to run Sample How to configure 50

You might also like