Connector Properties table

Connector Code

(code)

Uniquely identifies the connector

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.

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).

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.

Import/Export

(import_export)

Data direction – import or export

ARCHIBUS Table

(destination_table)

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

Remote Source

(Table, XML, etc.)

(source_table)

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

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.

Text Qualifier

(text_qaulifier)

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

Skip First Line?

(skip_first_row)

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

Connection String

(conn_string)

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

Connection Username

(conn_user)

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

Connection Password

(conn_password)

Enter 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

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.

Pre Process

(pre_process)

Defines a Java Class and Method that should be executed prior to the Connector execution. The method must accept a single String as a parameter (the connection string).

A fully qualified class name is required, such as com.businesspartner.project.ClassName

Post Process

(post_process)

Defines a Java Class and Method that should be executed upon completion of the Connector execution. The method must accept a single String as a parameter (the connection string).

A fully qualified class name is required, such as com.businesspartner.project.ClassName

Assigned Connector

(assigned_connector)

Not implemented in this release.

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).

Notification Email Address

(notify_email_address)

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

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.

FTP Remote Folder

(ftp_folder)

Specify the folder - relative to the root location of the Host address - to where files should be accessed.

Secure FTP

(ftp_secure)

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

FTP Port

(ftp_port)

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

FTP Username

(ftp_user)

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

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.