Professional Documents
Culture Documents
UIPath FlexiCapture As An Attended Service PDF
UIPath FlexiCapture As An Attended Service PDF
for Guide
FlexiCapture as an attended
service
FlexiCapture as an attended service
Contents
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
Step 2
• Click Project > Document Definitions...
• Select the Document Definition
• Click Edit....
Step 3
• Go to Document Definition > Document
Definition Properties...
> Export Destinations tab
• Select Export to UiPath and click Edit
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.Server = "https://platform.uipath.com";
connectorSettings.DmsConnectionSettings.Credentials.Password = "password"; connectorSettings.DmsConnectionSettings.Repository = "Tenant";
connectorSettings.DmsConnectionSettings.Credentials.Username = "username";
• Specify the queue name where connectorSettings.DmsConnectionSettings.Credentials.Password = "password";
definition
Step 5
• Open the UiPath
Orchestrator
• Click Queues and
create a new one
as it shown
on the picture
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
Step 7
• On the Design tab, click the
Manage Packages button
or press Ctrl+P
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 9
• In the sample project
Abbyy.Activities.UiPath.
FlexiCaptureActivities
is installed in Project Dependencies
• Click Save
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 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 12
• Open Get Password activity and
specify Password of the ABBYY
FlexiCapture user
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
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 15
• Select input and output folders
• Wait when the input file will be processed
• Open output folder and check the result
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
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 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 3
• Go to Document Definition
> Export Settings...
• Click the Add...
Step 4
• Select Custom export (script)
• Select Critical option
• Select Errors are irrelevant
• Uncheck Field condition
• Click Next
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 6
• Specify the actual values required
to connect 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.MappedFields.DmsMetadataTemplate.Name = "QueueName";
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 8
• Select the box next to the profile
in the Enabled column
• Click the Add... button to create standard
XML export profile
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 10
• Make sure the Export path field
is empty
• Click Edit
Step 11
Set up filename template
• View: Advanced
• Specify filename template
(e.g. Data_<Identifier> )
• Click OK and Next
Step 12
• File format: XML Document (*.xml)
If you want to define fields
for export, go to Set Up Field Mapping…
• Click Next
Step 13
Set up Export Images to Files
• Select Save Images with Data
• Template: Same as data
• Click Next
Step 14
Select Image File Format
• Image file format depends
on your requirements
• Click Next
Step 15
• Select the Destination Name
Name: Export to XML
• Click Finish
Step 16
• Check the Enabled flag
• Save and close the Document Definition
Step 17
• Publish the Document Definition
Step 18
• Go to Project > Batch Types
• Click New to create new batch type
Step 19
• Go to Image Processing Options
• Select Create document -
For each image file
• Click Next until you get to Workflow settings
Step 20
• Select Advanced schema
• Select the Verification stage
• Click Edit....
Step 21
• Select the Enable web stations option
on the General tab
• Click OK to save the changes
Step 22
• Click the Stage... button to add
a new stage
Step 23
• Select Automatic
• Click OK
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 25
• On the Script tab select Document
processing
• Click the Edit script…
Step 26
• Past the following C# .Net script code
Document.Properties.Set("WasVerified",
Document.Properties.Set("WasVerified",
bool.TrueString);
bool.TrueString);
Step 27
• On the Entry Conditions tab
select Under these conditions
• Click the Rule...
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 29
• Save the newly configured rule
and the new script stage
Step 30
• Name the batch type
as Attended service
• Click Finish
51