Appian export settings and field mapping reference

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

Connection settings

Setting	Description
Server	The address of the Appian server and the port used for the connection. The default port is 8080. For example, `<Server>http://computername.domain.com:8080</Server>`.
Username	The name of the user in Appian. For example, `<Username>username</Username>`.
Password	The user’s password. For example, `<Password>password</Password>`.
Repository	The identifier of the knowledge center in Appian. For example, `<Repository>5995</Repository>`.

Look up the ID of a knowledge center (Appian 12)

Select the knowledge center

Click Runtime Data in the workspace, and then select the knowledge center in the Documents section. The actions that can be performed on the selected knowledge center appear at the top of the workspace.

Open its properties

Click Properties at the top of the workspace. The Knowledge Center Properties dialog box opens and displays the ID.

Screenshot of the Knowledge Center Properties dialog box in the Appian workspace, showing the ID of the selected knowledge center.

Document naming settings (Appian 12)

Setting	Description
FolderPath	The name of the folder to be created in Appian. For example, `<FolderPath><Batch></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

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

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>

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>

Record type

DmsMetadataTemplate contains the name of the record type in plural form, which is the name visible in Tempo. Each ABBYY FlexiCapture Document Definition must have its own record type in Appian. For example:

<DmsMetadataTemplate>
  <Name>Account Payable Records</Name>
</DmsMetadataTemplate>

Field mapping

FieldPairs contains a 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:

<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 Appian data type field 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 as follows:

Dictionary<string, string> pairs = new Dictionary<string, string>()
{
    { @"Invoice Layout\InvoiceNumber", "InvoiceNumber" },
    ...
};
connectorSettings.MappedFields.FieldPairs = new MappedFields(pairs).FieldPairs;

The value before the comma is the full path to a field in ABBYY FlexiCapture. The value after the comma is the name of the respective field in the data type.

Map table fields

Mapping table values requires an auxiliary data type in Appian. For more information, see Create a data type. Map the fields as follows:

Dictionary<string, string> pairs = new Dictionary<string, string>()
{
    ...
    { @"Invoice Layout\LineItems\Description", @"LineItems\Description" },
    ...
};
connectorSettings.MappedFields.FieldPairs = new MappedFields(pairs).FieldPairs;

The second LineItems is the name of the field in the main data type that stores the array of objects of the auxiliary data type. Description is the name of the mapped field in the auxiliary data type.

UiPath

Blue Prism

Automation Anywhere

WinActor

Appian

Pega

M-Files

Laserfiche

NX Manager

Appian export settings and field mapping reference

Connection settings

Look up the ID of a knowledge center (Appian 12)

Document naming settings (Appian 12)

Dynamic tags for document names

Name conflict resolution

Record type

Field mapping

Map fields in an XML file

Map fields in a script

Map table fields

​Connection settings

​Look up the ID of a knowledge center (Appian 12)

​Document naming settings (Appian 12)

​Dynamic tags for document names

​Name conflict resolution

​Record type

​Field mapping

​Map fields in an XML file

​Map fields in a script

​Map table fields

Connection settings

Look up the ID of a knowledge center (Appian 12)

Document naming settings (Appian 12)

Dynamic tags for document names

Name conflict resolution

Record type

Field mapping

Map fields in an XML file

Map fields in a script

Map table fields