Skip to main content
You can add an activity to the process by dragging it from the UiPath Studio Activity panel. After the activity is added to the process, you need to fill in its fields in the properties panel located in the right-hand part of the UiPath Studio window.
  • Use the Input fields for transferring an image file and its name to the activity:
    • FileContent is a file to be sent to ABBYY FlexiCapture as a byte array (this field accepts values of type System.Byte[]).
    • FileName is the name of a file to be sent to ABBYY FlexiCapture (this field accepts values of type String).
    • The BatchRegistrationParameters field allows you to specify user registration parameters for a batch when sending files to ABBYY FlexiCapture. The values of these registration parameters can be used to specify the names of export files (when exporting from ABBYY FlexiCapture). The field accepts values of type IEnumerable<KeyValuePair<string, string>>. The Dictionary<String, String> class is recommended for passing the registration parameters. Dictionary must be initialized. The field value may look like this:
new Dictionary(Of String, String) from {{"Key", "Value"}, {"Key1", "Value1"}}.
This field is optional. Leave this field empty if you do not need to specify any registration parameters. Registration parameter values can be used, for example, for naming export files in ABBYY FlexiCapture.
  • Output fields allow you to specify variables in which the activity will save results:
    • Fields is an array of ‘field name, field value’ pairs containing a list of document fields. This field accepts values of type IEnumerable<KeyValuePair<String, String>>.
      Note: Fields will only be received if the resulting files include an XML file. AnXML export profile must be configured for the Document Definition in the ABBYY FlexiCapture project.
    • Files is an array of ‘file name, file as byte array’ pairs containing all the files generated as a result of processing a source file in ABBYY FlexiCapture (e.g. a source file converted to searchable PDF, files with signature images, files with captured data, etc., depending on the export settings specified in the ABBYY FlexiCapture project). This field accepts values of type IEnumerable<KeyValuePair<String, Byte[]>>.
    • VerificationUrl is a link that opens a document processing task on the ABBYY FlexiCapture Web Verification Station, where the user can verify the captured data. This field accepts values of type String.
      Note: An activity returns a URL for which Windows authentication is required. If you plan to send this URL to a verification operator, make sure that the corresponding ABBYY FlexiCapture account is registered on the ABBYY FlexiCapture server.
  • The FlexiCapture Connection Settings section contains the settings required to connect to the ABBYY FlexiCapture server. You will need to provide the server address and the credentials of the account that will be used to connect to the server. Click Test Connection to check if the connection has been successfully established. Then specify the project and batch type that will accept files from the UiPath workflow process. If you are using ABBYY FlexiCapture Cloud or a local multi-tenant system, specify your company (tenant) name. The values for these parameters can be either be specified using a VB expression enclosed in quotes, or passed as variables of type String.
    Note: The ABBYY FlexiCapture user must have either a) the role of Administrator or b) the role of Scanning Operator (to send documents) and the role of Verification Operator (to receive URLs linking to document verification pages on the ABBYY FlexiCapture 12 Web Verification Station) for the given project and batch type. To set up user permissions, use the Administration and Monitoring Console.
  • Open the activity properties and navigate to Common. Here, you can set a custom timeout (in milliseconds) for awaiting FC processing results. When the specified time period expires, the activity will throw an exception. The default timeout value is 300,000 milliseconds.
  • If you are using a proxy, fill in the Server URL, Username, and Password fields in the Proxy Settings (optional) section.
  • If a transparent proxy is used, specify the server address and port in the Server URL field and leave the Username and Password fields empty.
    • If the proxy uses NTLM authentication, specify the server address and port in the Server URL field and leave the Username and Password fields empty. The credentials under which the UiPath process is running will be used.
    • If the proxy uses Basic authentication, specify the server address and port in the Server URL field and fill in the Username and Password fields.