Connection



Properties

Name Description Type
qId

Identifier of the connection. Is generated by the engine and is unique.

String
qName

Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.

String
qConnectionString

One of:

  • ODBC CONNECT TO [<provider name>]
  • OLEDB CONNECT TO [<provider name>]
  • CUSTOM CONNECT TO [<provider name>]
  • "<local absolute or relative path, UNC path>"
  • "<URL>"

Connection string. This parameter is mandatory and must be set when creating or modifying a connection.

String
qType

One of:

  • ODBC
  • OLEDB
  • <Name of the custom connection file>
  • folder
  • internet

Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive.

String
qUserName

Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name.

String
qPassword

Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password.

String
qModifiedDate

Is generated by the engine. Creation date of the connection or last modification date of the connection.

String
qMeta

Information about the connection.

NxMeta
qLogOn

Select which user credentials to use to connect to the source.

  • LOG_ON_SERVICE_USER: Disables
  • LOG_ON_CURRENT_USER: Enables

One of:

  • LOG_ON_SERVICE_USER
  • LOG_ON_CURRENT_USER
String