Skip to main content
ABBYY Vantage Connector for UiPath is shipped with a sample process that demonstrates how you can use ABBYY Vantage activities in your workflow, how to configure your UiPath process to pass input data to ABBYY Vantage activities, and how process data is received from ABBYY Vantage activities. A sample process also shows how you can configure the connector to create a multi-file transaction in ABBYY Vantage, set transaction and file registration parameters, and how you can process results from several documents of one transaction.
The sample process comes with Windows compatibility.
You can run this process and see how one person’s Bank Statement and Utility Bill documents are processed in a single transaction using the connector. The default location of the sample process is C:\Users\Public\ABBYY Vantage Connector for UiPath\SampleWorkflow\Vantage. The workflow will get input images from the predefined input location (\SampleWorkflow\Vantage\Input images) and send it to ABBYY Vantage for processing. Once the processing is complete, some of the processing results will be saved to \SampleWorkflow\Vantage\Results and others will appear in the workflow log in the Output panel. The following processing results will be saved to \SampleWorkflow\Vantage\Results:
  • A subfolder with the name equal to the transaction ID will be created.
  • In the transaction folder, a ResultFiles subfolder for saving all export files from all documents of the transaction will be created. Each file name will have the prefix containing the identifier of the document.
  • Next to the ResultFiles folder, text files for storing the classification confidence values and full-text recognition result (ClassificationConfidences and DocumentFullText parameters) of each document will be created. Each file name will have the prefix containing the identifier of the document.
In this sample, DocumentFullText will be filled with the default value and will not contain the results of full-text recognition, because the Default Process skill used to create a transaction in the sample process is not configured to export full-text recognition results to TXT. You can create a copy of the Default Process skill, change the export file settings in the Output activity, publish the skill, and then use it in the Use Skill activity.
The TXT file containing the classification confidence values is just an example of how the Classification Confidences value received by the Get Results activity can be processed. You do not need to save results to TXT files.
The following processing results obtained by the Get Results activity will be displayed in the workflow log in the Output panel:
  • Document Class
  • Is Classification Confident
  • Values of UiPath variables — these values contain data for individual fields of the document, mapped into Map Fields activities and filled while passing Map Fields activities when the process was executed. The process contains two Map Fields activities, each for a different document type.
The following fields are displayed in the log:
  • Bank Statement: Bank Name, Account Owner Name, Ending Balance of the Period
  • Utility Bill: Customer Name, Issuer Name, Bill Date, Current Charges, Description column from the LineItems table
For more details about getting processing results, see the Get Results Activity section.

Running the sample process

To run the sample process, complete the following steps:
  1. Copy the folder containing the sample process (C:\Users\Public\ABBYY Vantage Connector for UiPath\SampleWorkflow) into any folder accessible to the user running UiPath Studio.
  2. In UiPath Studio, open the Main.xaml file.
  3. In the Design tab, double-click the Send Files to ABBYY Vantage sequence and open the Variables panel. Specify the address of the ABBYY Vantage server and the credentials that were used to register your ABBYY Vantage account:
    • VantageServerUrl
    • VantageUserName
    • VantagePassword
    • VantageTenant (if your user is in multiple tenants)
    UiPath Designer showing the Vantage Scope activity with sample workflow variables filled in
  4. Run the workflow by clicking Debug File > Run File or by pressing Ctrl + F5.
Once you have completed the above steps, the workflow will send documents to ABBYY Vantage for processing.