Skip to main content
In the XML configuration file or in the script (depending on how you have chosen to configure your export settings), you must specify the options that will be used for export. These include connection parameters to be used to connect to Blue Prism, output image options, method of naming export files, and field mapping. Server contains the address of the server where the ABBYY FlexiCapture 12 Listener web service is located: 
connectorSettings.DmsConnectionSettings.Server = "http://BluePrism:8181/ws/FlexiCapture12Listener";
Username contains the name of the user in Blue Prism. For example: 
connectorSettings.DmsConnectionSettings.Credentials.Username = "admin";
Password contains the Blue Prism user’s password. For example, 
connectorSettings.DmsConnectionSettings.Credentials.Password = "Pass@123";
FileName contains the file name template for the document image file sent to the web service. For example: 
connectorSettings.DmsDocumentDestination.FileName = "<Batch>";
The name of the document may have an unchanging static part and a changing dynamic part. The dynamic part is defined by tags, which are replaced by the ABBYY FlexiCapture document property values at the time of export. Each tag must be enclosed in angle brackets. In the XML file:
  • ‘&lt;’ stands for ‘<’
  • ‘&gt;’ stands for ‘>’
Possible tags for the dynamic part of the name:
  • Project for the name of the project in ABBYY FlexiCapture
  • Batch for the name of the batch
  • DocumentDefinition for the name of the Document Definition in ABBYY FlexiCapture
  • SourceFile for the name of the source file
  • Identifier for the document identifier in the batch
  • BatchType for the name of the batch type
  • Time for the current time in yyyy-MM-dd_HH-mm-ss format
If you use the FlexiCapture 12 VBO to send image files to ABBYY FlexiCapture, the batch created for processing an image will be assigned a FileNameWithoutExtension registration parameter. This parameter will receive the value from the FileName input parameter (from the VBO). You can also use the value of this registration parameter in your script for naming export files as follows: <FileNameWithoutExtension>. Other custom registration parameters can be used to name files in the following format: <RegParam:ParamName>. You can also use the values of index fields as follows: <Index:IndexField>.
These dynamically replaceable tags are case-sensitive and the register of the characters used in the tags above should be preserved.
Map the fields in order to export recognized metadata. For each Document Definition field whose value you want to export, you must specify its name. This name will be used by the FlexiCapture 12 Listener process to save the field into the collection. The collection of field names and values will be created at runtime. Only those Document Definition fields will be exported to the Blue Prism which have been mapped. Any number of fields can be mapped. FieldPairs contains a collection of field pairs. If your export settings are stored in an XML file, map the fields as follows: 
<FieldPairs>
 <FieldPair>
   <AfcField>Invoice Layout\InvoiceNumber</AfcField>
   <DmsField>InvoiceNumber</DmsField>
 </FieldPair>
</FieldPairs>
where:
  • AfcField is the full path to the FlexiCapture Document Definition field from which data are to be read at the time of export.
  • DmsField is the field Name in the Fields collection in the Blue Prism FlexiCapture 12 Listener process.
If your export settings are specified in the script (BluePrism - ExportScript - Configure by script.cs), map the fields as follows: 
{ @"Invoice Layout\InvoiceNumber", "InvoiceNumber" },
where the value before the comma is the full path to a field in ABBYY FlexiCapture Document Definition and the value after the comma is the name of the respective field in the Fields collection in the Blue Prism FlexiCapture 12 Listener process. ExportImageSavingOptions contains the image saving options to be used at the time of export, such as the format of the exported image, its quality, and redacted areas. For a detailed description of the image saving options, please refer to ABBYY FlexiCapture Developer’s Help. SaveDocumentImages controls the export of image files. Possible values are true (images will be exported) and false (no images will be exported). For example: 
connectorSettings.SaveDocumentImages = true;