Specify UiPath export options

Set UiPath Orchestrator connection parameters, file naming, queue name, image options, and field mapping in the XML config or export script.

Specify the options used for export in the XML configuration file or in the script, depending on how you chose to configure your export settings.

The options cover the connection parameters for UiPath Orchestrator, the output image options, the method of naming export files, and the field mapping.

UiPath Orchestrator connection settings

Option	What to specify
Server	The address of the server where Orchestrator is located.
Repository	For UiPath Enterprise Orchestrator, the name of your Orchestrator tenant. For UiPath Cloud Platform, your service name in your account.
Username	For UiPath Enterprise Orchestrator, the name or the e-mail of the Orchestrator user. For UiPath Cloud Platform, the user’s e-mail, plus the authentication type in AuthenticationType.
Password	The Orchestrator user’s password.

With UiPath Cloud Platform, an old account from UiPath Community Orchestrator has to be migrated to the new authentication method first, by resetting the password. For more information, see Consuming APIs with the new cloud Orchestrator.

Server address examples

For UiPath Enterprise Orchestrator, specify the address of the Orchestrator web application:

connectorSettings.DmsConnectionSettings.Server = "https://orchestrator.mydomain.com";

For UiPath Cloud Platform Orchestrator, specify the following server address:

connectorSettings.DmsConnectionSettings.Server = "https://platform.uipath.com";

Repository example

For UiPath Cloud Platform, specify your service name:

connectorSettings.DmsConnectionSettings.Repository = "test_service";

To find the name of an available service, open your UiPath Cloud Platform account and navigate to the Services tab.

Required Orchestrator user roles

Assign the following roles to the user in Orchestrator: view queues, create transactions, and view units.

Export file names

In the FileName field, specify the template used to generate the names of the export files.

Tag	Value it inserts
<Project>	Name of the ABBYY FlexiCapture project
<Batch>	Batch name
<DocumentDefinition>	Name of the Document Definition in ABBYY FlexiCapture
<Identifier>	Document identifier
<BatchType>	Batch type name
<Time>	Current time in yyyy-MM-dd_HH-mm-ss format
<Index:>	Index field value
<FileNameWithoutExtension>	Name of the source file

The <FileNameWithoutExtension> tag works when the image was received from the UiPath activity, because the batch then holds this registration parameter with the name of the source image file.

Orchestrator queue name

In the DmsMetadataTemplate.Name field, specify the Orchestrator queue name:

connectorSettings.MappedFields.DmsMetadataTemplate.Name = "Verification queue"

After the export script runs, a new transaction with the data is created in this queue. Create the queue in Orchestrator.

Output image options

The ExportImageSavingOptions option covers the settings available for output images, such as the image format options and the ability to redact fields holding confidential information.

For more information, see IExportImageSavingOptions.

Field mapping

Map the fields to export the recognized metadata. For each Document Definition field whose value you want to export, specify its name in the transaction.

Only the Document Definition fields that have been mapped are exported to the transaction. Any number of fields can be mapped.

If you configure export options using a script, the field pair must be in the following format:

{ @"Invoice Layout\InvoiceNumber", "InvoiceNumber" }

If you configure export options using XML, the field pair must be in the following format:

<FieldPair>
<AfcField>Invoice Layout\InvoiceNumber</AfcField>
<DmsField>InvoiceNumber</DmsField>
</FieldPair>

In both formats, the first value is the full path to the field in the ABBYY FlexiCapture Document Definition, and the second value is the name of the field in the UiPath Orchestrator transaction. You can choose any name for the field in the transaction. Fields with the specified names are created in the transaction at runtime.

Additional UiPath export options

Specify additional UiPath export settings using the DmsSpecificOptions property. In each of the following code samples, the first attribute is the option name and the second attribute is the option value.

AuthenticationType

AuthenticationType sets the authentication type used when logging in to UiPath Orchestrator. It has only two values, Basic and OAuth2.

For UiPath Cloud Platform Orchestrator, this option is required and its value must be OAuth2. For UiPath Enterprise Orchestrator, the option is not required, and its value is Basic.

connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("AuthenticationType", "OAuth2"))
};

Reference

Reference specifies a reference to use when creating a transaction. Specify Document.Batch.Id.ToString() as the value to use the batch identifier as the reference.

connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("Reference", Document.Batch.Id.ToString()))
};

OrganizationUnitName

OrganizationUnitName exports the processing results to the specified Orchestrator organization unit. This option is available only for UiPath Enterprise Orchestrator, and the Organization Unit feature has to be enabled in Orchestrator.

Specify the name of the organization unit as the option value.

connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("OrganizationUnitName", "ORG_UNIT_NAME"))
};

AccountLogicalName

AccountLogicalName specifies which UiPath Cloud Platform account the processing results are exported to. Use it when several UiPath Cloud Platform accounts are available to the user. This option is available only for UiPath Cloud Platform Orchestrator.

The account logical name is the editable part of the Orchestrator site URL in the Orchestrator Account Settings. It is also visible in the browser’s address bar after you log in to your account.

connectorSettings.DmsSpecificOptions = new Option[] { 
new Option(new KeyValuePair<string, object>("AccountLogicalName", "testaccount123"))
};

Several options in one script

To use several options in a single export script, list them as elements of the Option array, separated by commas:

connectorSettings.DmsSpecificOptions = new Option[] {
new Option(new KeyValuePair<string, object>("AuthenticationType", "OAuth2")),
new Option(new KeyValuePair<string, object>("AccountLogicalName", "ACCOUNT_LOGICAL_NAME")),
new Option(new KeyValuePair<string, object>("Reference", Document.Batch.Id.ToString()))
};

Saving document images

The SaveDocumentImages option indicates whether image files are saved to a UiPath Orchestrator transaction. Set it to true to save images, or to false to save none.

connectorSettings.SaveDocumentImages = true;

Reference files

Examples of setting up the export options are in the \Single-task package\Samples\FlexiCapture Scripts folder of the connector installation path. Look for the files named default.config.xml and UiPath - ExportScript - Configure by script (Attended service).cs.