Connector Properties table

Connector Code

(code)

Uniquely identifies the connector

String

Description - XML Template

(description)

Description of the connector’s function.  In the case of XML exports this field is used to hold a record XML template.

Memo

Connector Parameters

(conn_params)

Some Connector types, such as MS Excel or Custom Connectors may have additional optional configuration parameters.  These parameters are defined in this field using JavaScript Object Notation (JSON).

String - JSON

Connector Type

(type)

Type of foreign data system and data format the connector will integrate ARCHIBUS with such as a delimited text file, database, XML, etc.

Integer – Enumeration List

Import

(import_export)

Data direction – import or export

Integer – Enumeration List

ARCHIBUS Table

(destination_table)

The ARCHIBUS table to import/export data to/from.  This field always represents the ARCHIBUS table, whether importing or exporting.

String, validated on afm_tbls

Remote Source

(Table, XML, etc.)

(source_table)

For table, XML root element, Microsoft Excel Worksheet Name, etc., to import/export data to/from

String, non-validated

Delimiter

(delimiter)

Delimiter character found in the source or output text file.  Typically comma, tilde, pipe or fixed length. Can be overridden by "overrideDelimiter" parameter.

Enumeration list

Text Qualifier

(text_qualifier)

Used to wrap string data elements in a delimited text file (CSV) for example. Can be overridden by "overrideTextQualifier" parameter.

Enumeration List

Skip First Line?

(skip_first_row)

Interpreted as a number, skip N lines, where N is the number entered.

Integer

Connection String

(conn_string)

Defines the connection parameters (path, jdbc, ldap, etc.) to the foreign data system for the selected connector type.

String

Connection Username

(conn_user)

The username required to connect to the data source defined in the Connection String.

String

Connection Password

(conn_password)

The password required to connect to the data source defined in the Connection String.

NOTE: Password is encrypted by the server when the form is saved.  The password is stored on the database in an encrypted format. It

String

Restriction Clause

(where_clause)

Holds ‘WHERE’ keyword for database connectors – applies to import or export.  Do not include the "WHERE" keyword in the restriction clause.

Memo

Pre Process

(pre_process)

The method must have the qualifiers “public static void” and accept a single parameter. The parameter should be a String which will be the connection string, or if the useConfigInPreProcess connector parameter is set to true, the method parameter should be a ConnectorConfig object.

String: “Class|Method”

Post Process

(post_process)

The method must have the qualifiers “public static void” and accept a single parameter. The parameter should be a String which will be the connection string, or if the useConfigInPostProcess connector parameter is set to true, the method parameter should be a ConnectorConfig object.

String: “Class|Method”

Assigned Connector

(assigned_connector)

Not implemented in this release.

N/A

Notifications

(notify_user)

Determines whether and when email notifications are sent as Connectors execute.  Valid options are None (never email), Errors Only (only email when a Connector completes with errors), Connector Execution (every execution), or Both (errors and at completion).

Enumeration List

Notification Email Address

(notify_email_address)

List of email addresses to send messages to on Error and/or Completion.

String - comma separated list of email addresses

FTP Host

(ftp_string)

Defines the connection parameters to a remote FTP site where the Connector should copy the remote file to/from depending on the type of Connector.  The Connector will load the File to/from the location in the Connection String property before/after the Connector runs.

String FTP Host address/url

FTP Remote Folder

(ftp_folder)

Specify the folder - relative to the root location of the Host address - to where files should be accessed. If there is a folder delimiter it must be included at the end of this path.

String

Secure FTP

(ftp_secure)

Select whether or not SFTP (SSH) protocol is used to connect and transmit files.

Yes/No

FTP Port

(ftp_port)

Enter the network port number to which the FTP connection should be made.

Integer

FTP Username

(ftp_user)

Enter the username that should be used to connect to the FTP Host

String

FTP Password

(ftp_password)

Enter the password that should be used to connect to the FTP Host.

NOTE: Password is encrypted when the form is saved.  The password is stored on the database in an encrypted format.

String

compareFields

This defaults to false. When set to true, on import each field's value will be compared to the value in the ARCHIBUS database. If the value hasn't changed, it shouldn't be updated. If no value has changed, the transaction will not be applied.

Boolean

supportInserts

This defaults to true. When set to false, on import the connector should not insert new records into the ARCHIBUS database. (does not prevent update)

Boolean

supportUpdates

This defaults to true. When set to false, on import the connector should not update existing records in the ARCHIBUS database. (does not prevent insert)

Boolean