Connectors

Connector Fields table

Use the Connector Fields table (afm_conn_flds) to map connections between the source and destination fields of Archibus and the remote system. Access this table from the Fields tab on the System / System Administrator / Configure Connectors task.

Property Name

Description

Value

Example

Connector Code

(connector)

Uniquely identifies the connector

String

My Connector

Position

(position)

Orders the fields. This is a required .  Enter consecutive integers starting with 0.  The position is critical for text and XLS file imports. 

Integer

100

Source Field

(field)

For an export OUT OF Archibus, the Source Field is the field within the Archibus schema (afm_flds.field_name).

For an import INTO Archibus, the Source Field is the field name in the Remote system.

String

Generic: Import: blId, Export: bl_id

XML Import: Record/blId

Destination Field

(destination)

For an import INTO Archibus, the Destination Field is the field within the Archibus schema (afm_flds.field_name).

For an export OUT OF Archibus, the Destination Field is the field name in the Remote system; in the case of a text or Excel file, the Destination Field represents column header for that field.

String

Generic: Import: bl_id, Export: blId

Generic: Import: bl_id, Export: blId

Rule Code

(rule)

Rules that describe the behavior of the mapping.  The rule definitions are stored in the afm_conn_rule_cat table.

There are many type of rules available and each is described in Connector Custom Rules

String - Select Value

SET VALUE IF NULL

Parameters

(parameter)

Many of rules require further parameters to control their behavior; this field holds the parameter values for each field/rule combination.

String, non-validated

SomeValue

Validating Table

(validating_table)

Use a reference table from afm_flds other than the one on this field (POPULATE TABLE, VALIDATE ADD/SKIP, LOOKUP VALUE)

String, validated on afm_tbls

site

Use Archibus Field in Transfer?

(is_schema_field)

If set to Yes, this means that the Destination Field (import) or Source Field (export) specifies a field in the respective Archibus table. This is new beginning with V22.1 and should be set to Yes for backward compatibility.

If set to No, the field's value will not be used to update that table (import).

Boolean (Yes/No)

Yes

Cache Validating Table

(cache)

For very long-running imports for which a lot of validation is required, the connector can cache in memory the contents of the Validating Table to reduce the number of required database queries.  Care should be taken for very large validating tables.

Boolean

Yes

Field Width

(result)

Fields are automatically truncated, zero-padded to the left (numbers), or space-padded to the right (text).

Integer or text

100

Note: The rule_order and msg_part fields are intended for future development and are not currently in use.