Skip to main content
These options set how export works, and you specify them either in the XML configuration file or in the script, depending on how you chose to configure your export settings. They cover the connection to Blue Prism, output image options, the method of naming export files, and field mapping.

Connection settings

Server contains the address of the server where the ABBYY FlexiCapture 12 Listener web service is located:
Username contains the name of the user in Blue Prism:
Password contains the Blue Prism user’s password:

Document naming

FileName contains the file name template for the document image file sent to the web service:

Dynamic tags for document names

A document name can have an unchanging static part and a changing dynamic part. Tags define the dynamic part, and ABBYY FlexiCapture replaces them with document property values at the time of export. Enclose each tag in angle brackets. In an XML file, write &lt; for < and &gt; for >. The following tags are available:
These tags are case-sensitive. Preserve the character case shown in the table.

Tags from registration parameters and index fields

If you use the FlexiCapture 12 VBO to send image files to ABBYY FlexiCapture, the batch created to process an image is assigned a FileNameWithoutExtension registration parameter. It receives the value from the FileName input parameter of the VBO. You can use these additional forms in your script for naming export files:

Field mapping

Map the fields to export recognized metadata. For each Document Definition field whose value you want to export, specify its name. The FlexiCapture 12 Listener process uses that name to save the field into the collection, which is created at runtime. Only mapped Document Definition fields are exported to Blue Prism. You can map any number of fields. FieldPairs contains the collection of field pairs.

Map fields in an XML file

If your export settings are stored in an XML file, map the fields as follows:
  • AfcField – The full path to the ABBYY FlexiCapture Document Definition field that data is read from at the time of export
  • DmsField – The field name in the Fields collection in the Blue Prism FlexiCapture 12 Listener process

Map fields in a script

If your export settings are stored in the script BluePrism - ExportScript - Configure by script.cs, map the fields as follows:
The value before the comma is the full path to a field in the ABBYY FlexiCapture Document Definition. The value after the comma is the name of the respective field in the Fields collection in the Blue Prism FlexiCapture 12 Listener process.

Image settings

SaveDocumentImages controls the export of image files. Set it to true to export images or false to skip them:
ExportImageSavingOptions contains the image saving options used at the time of export, such as the format of the exported image, its quality, and redacted areas. For a detailed description, see IExportImageSavingOptions.