M-Files export settings and field mapping reference

These settings appear in the M-Files - ExportScript - Configure by script.cs script and in the default.config.xml configuration file.

Connection settings

Setting	Description
Server	The URL used to access M-Files over the Internet. For example, `<Server>http://m-files-server</Server>`.
Username	The name of the user in M-Files. This can be either a domain name or a local name on the M-Files server. For example, `<Username>username</Username>`.
Password	The user’s password. For example, `<Password>password</Password>`.
Repository	The name of the document vault in M-Files. For example, `<Repository>DocumentVault</Repository>`.

For instructions on configuring web access, see the M-Files User Guide.

Document naming settings

Setting	Description
FolderPath	The object type name. For example, `<FolderPath>Document</FolderPath>`.
FileName	The name of the document that is created at the time of export. For example, `<FileName><Batch>_<Identifier></FileName>`.

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 < for < and > for >. The following tags are available:

Tag	Value it inserts
`Project`	The name of the project in ABBYY FlexiCapture
`Batch`	The name of the batch
`DocumentDefinition`	The name of the Document Definition in ABBYY FlexiCapture
`SourceFile`	The name of the source file
`Identifier`	The document identifier in the batch
`BatchType`	The name of the batch type
`Time`	The current time in `yyyy-MM-dd_HH-mm-ss` format

The following example produces a document name with a static part:

<FileName>My_static_prefix_&lt;DocumentDefinition&gt;_&lt;Identifier&gt;and_postfix</FileName>

The following example produces a document name without a static part:

<FileName>&lt;Project&gt;_&lt;Identifier&gt;</FileName>

Runtime replacement tags for updating the original document

Runtime replacement tags update documents that were sent from M-Files to ABBYY FlexiCapture for processing. They apply when the ABBYY FlexiCapture batch was created by the M-Files workflow activity Abbyy.MFiles.FlexiCapture.Activity.dll.

Tag	Where to use it
`<FolderPath>`	In the FolderPath configuration field, instead of an explicit object type name
`<Template>`	In the DmsMetadataTemplate configuration field, instead of an explicit class name
`<FileName>`	In the FileName configuration field, instead of an explicit document name

The M-Files workflow activity creates the batch registration parameters, and these tags are replaced with the values of those parameters. ABBYY FlexiCapture then updates the original document in M-Files based on the same registration parameters.

These tags are case-sensitive. Preserve the character case shown in the table.

Name conflict resolution

NameConflictResolution resolves name conflicts. It takes one of the following values:

Value	Result
`NewVersion`	A new version of the document is created.
`NewName`	A new document with a new name is created.

For example:

<CreationPolicy> 
  <NameConflictResolution>NewVersion</NameConflictResolution> 
</CreationPolicy>

NewVersion updates the document in M-Files only when the name and format specified in the script match the name and format of the document in M-Files. If they do not match, a new document is created in M-Files.

Document class

DmsMetadataTemplate contains the name of the document class in M-Files. For example:

<DmsMetadataTemplate>
  <Name>Invoice</Name>
</DmsMetadataTemplate>

Field mapping

FieldPairs contains a collection of field pairs. It maps ABBYY FlexiCapture Document Definition fields to M-Files property definitions.

Map fields in an XML file

If your export settings are stored in an XML file, map the fields as follows:

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

AfcField – The full path to the ABBYY FlexiCapture Document Definition field that data is read from at the time of export
DmsField – The name of the M-Files property definition that data is written to at the time of export

Map fields in a script

If your export settings are stored in the script, map the fields in a dictionary as follows:

Dictionary<string, string> pairs = new Dictionary<string, string>()
{
    { @"Invoice Layout\InvoiceNumber", "Invoice number" },
    { @"Invoice Layout\InvoiceDate", "Invoice date" },
};

In each pair, the value before the comma is the full name of a field in the ABBYY FlexiCapture Document Definition. The value after the comma is the name of the respective property definition in M-Files. For instructions on preparing the M-Files side of the mapping, see Configure the M-Files metadata structure.

Image settings

Setting	Description
SaveDocumentImages	Specifies whether to export the image. When set to `true`, the connector sends both the document image and the extracted fields to M-Files. Otherwise, it sends only the extracted fields.
ExportImageSavingOptions	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.

M-Files-specific options

DmsSpecificOptions holds the settings that are specific to M-Files.

Option	Description
`Workflow`	Optional. The name or alias of the workflow assigned to the document after export from ABBYY FlexiCapture to M-Files completes.

For example:

<DmsSpecificOptions>
    <Option>
      <Name>Workflow</Name>
      <Value xsi:type="xsd:string">Invoice.Workflow</Value>
    </Option>
  </DmsSpecificOptions>

UiPath

Blue Prism

Automation Anywhere

WinActor

Appian

Pega

M-Files

Laserfiche

NX Manager

M-Files export settings and field mapping reference

Connection settings

Document naming settings

Dynamic tags for document names

Runtime replacement tags for updating the original document

Name conflict resolution

Document class

Field mapping

Map fields in an XML file

Map fields in a script

Image settings

M-Files-specific options

​Connection settings

​Document naming settings

​Dynamic tags for document names

​Runtime replacement tags for updating the original document

​Name conflict resolution

​Document class

​Field mapping

​Map fields in an XML file

​Map fields in a script

​Image settings

​M-Files-specific options

Connection settings

Document naming settings

Dynamic tags for document names

Runtime replacement tags for updating the original document

Name conflict resolution

Document class

Field mapping

Map fields in an XML file

Map fields in a script

Image settings

M-Files-specific options