Details of Multi-Tier Rulebook ConnectOptions, and Single-Tier and Multi-Tier DSN Options

For connections to DB2




Option Setting Details Example
<Native DB2 DSN> (no flag) Pass a native DB2 DSN, if the DB2 DBMS runs on a different machine than the OpenLink Request Broker and Database Agent. My_DB2_DSN

For connections to Informix




Option Setting Details Example
<Informix Instance Name> (no flag) Pass an Informix Instance Name, if connecting via TCP/IP stack (i.e., not shared memory). inf10inst1

For connections to Ingres




Option Setting Details Example
<Ingres vnode> (no flag) Pass an Ingres vnode, if the Ingres DBMS runs on a different machine than the OpenLink Request Broker and Database Agent. Ing_vnode

For connections to Microsoft SQL Server


















Option Setting Details Example
-H <hostname or IP address> Required Fully-qualified domain name (i.e., DNS-resolvable hostname) or IP address of the SQL Server host machine. -H sql-host.example.com
-V <version> Required TDSVer value. Optimal settings are 10.0 for SQL Server 2008 and later, 9.0 for SQL Server 2005 , 8.0 for SQL Server 2000, 7.0 for SQL Server 7.x. -V 9.0
-P <port number> TCP Port at which the target SQL Server instance is listening. Not required if -I or -S is properly set. Required otherwise. -P 1433
-I <instance-name> SQL Server instance name on the specified host (-H). Only the actual "InstanceName". This option should be used in preference to the -S option below for connecting to a named instance. -I mssql2k5
-S <FQDN of database host>\\<instance-name> Not recommended. -H and -I are preferred. Specifies a target SQL Server instance by combining the host and instance names as "<FQDN>\\<instance>", e.g., "sql-host.example.com\\demo-instance". Note the double backslash ("\\") required between the host and instance names. -S sql-host.example.com\\mssql2k5
-F <fail-over server name> Specifies the fail-over server name for Database Mirroring. -F failover-host.example.com
-O <value> Determines whether stored procedures are created on the server for every call to SQLPrepare(). Acceptable values are "2" (Full), "1" (Partial, the default), and "0" (None). Effects of this setting. -O 1
-L <language> The name of a Microsoft SQL Server-supported national language. The default language is English. -L English
-C <character set> The name of the character set the OpenLink driver should deliver to the client application, to be translated from the Server's character set. By default, this is taken from the application's environment. Only valid for non-Unicode drivers. Unicode drivers always deliver UCS-2 on Windows and UCS-4 on Mac OS X and Unix-like OS. -C ISO-8859-1
-A Turn off ANSI NULL handling. Effects of this setting. -A
-E Require SSL Strong Data Encryption for communications between Database Agent or Lite Driver and SQL Server. If SQL Server is not configured to support SSL, connections will fail. This is not necessary when the SQL Server is configured to require SSL communications; the Agent/Driver automatically support that requirement. -E
-R Require SSL Server Certificate Verification for SSL communications. Has no effect if SSL is not active. Not necessary in most cases. Will cause failure in server-forced SSL connections if -D (below) is not also set correctly. -R
-D <path to file> Full path including filename of Certificate Authority File to be used for SSL Certificate Verification. /usr/local/certs/auth.caf
-Z Turn on Snapshot Serializable Isolation. -Z
-M Turn on Multiple Active Result Sets (MARS), enabling concurrent processing of multiple statements, queries, and/or result sets, on a single database connection. -M
-N <size> Network Packet Size determines the number of bytes per network packet transferred between the Microsoft SQL Server and the Database Agent or Lite Driver. This attribute can have significant impact on performance. The default, and often optimal, setting is 8000. The maximum supported by Microsoft SQL Server is 32767. -N 0

For connections to MySQL




Option Setting Details Example
-H <hostname or IP address> Required Fully-qualified domain name (i.e., DNS-resolvable hostname) or IP address of the MySQL host machine. -H mysql-host.example.com

For connections to JDBC Data Sources




Option Setting Details Example
<JDBC Connection URL> (no flag) Required. Pass a JDBC connect URL as appropriate for the target JDBC Driver. jdbc:openlink://test.example.com:5000/UID=sa/PWD=admin/READONLY=N/FBS=10/SVT=SQLSERVER/DATABASE=pubs/OPTIONS=-H sqlhost.example.com -V 8.0 -P 1433/
NOTE. The JDBC Driver classname must be passed as the Database DSN attribute, and the associated jar file must be in the active CLASSPATH.

For connections to ODBC Data Sources




Option Setting Details Example
<local ODBC DSN> (no flag) Required. Pass an ODBC DSN as defined on the Broker host. my_odbc_dsn

For connections to Oracle





Option Setting Details Example
<Oracle SQL*Net or Net Service Name> (no flag) Pass an Oracle Service Name, as defined in tnsnames.ora. oracle.example.com
<Oracle Connection String> (no flag) Pass an Oracle connection string. "scott/tiger@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=oracle-host.example.com)(PORT=1521)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=oracle.example.com)))"

For connections to PostgreSQL




Option Setting Details Example
-H <hostname or IP address> Required Fully-qualified domain name (i.e., DNS-resolvable hostname) or IP address of the PostgreSQL host machine. -H postgresql-host.example.com

For connections to Progress / OpenEdge

The following options are not required for Shared Memory-mode connections -- which are only possible with SQL-89 drivers, and only when those drivers have been linked to exactly the same Progress library versions as are installed on the current host.

These options are all required for Sockets-mode connections. Any connection may be made in sockets mode if Progress instance has been started with this mode enabled.

Connection must be made in sockets mode when using --

  • a Single-Tier Driver (whether SQL-89 or SQL-92),
  • a SQL-92 Driver (whether Single-Tier or Multi-Tier),
  • a Multi-Tier Database Agent (whether SQL-89 or SQL-92) that is not located on the same host as the Progress instance, and
  • a SQL-89 Driver (whether Single-Tier or Multi-Tier) that has not been linked to the exact same Progress library versions as are installed on the current driver host.





Option Setting Details Example
-S <socket service name or port number> Socket service port number, or associated service name as set in /etc/services or equivalent. -S 1234
-H <hostname or IP address> Fully-qualified domain name (i.e., DNS-resolvable hostname) or IP address of the Progress host machine. -H progress-host.example.com
-N tcp Always use this value. -N tcp

For connections to Sybase










Option Setting Details Example
-H <hostname or IP address> Required Fully-qualified domain name (i.e., DNS-resolvable hostname) or IP address of the Sybase host machine. -H sybase-host.example.com
-V <version> Required TDSVer value. Sets the Sybase network protocol version the driver will use to communicate with the target instance. Acceptable values are 4.6 for Sybase SQL Server 4.x, and 5.0 for all other Sybase versions. -V 5.0
-P <port number> Required Sybase listen port -P 4100
-S <instance names> Sybase instance name. Generally not necessary when host and port are correctly specified, but sometimes required even then. -S MySybaseInstance
-N <size> Network Packet Size determines the number of bytes per network packet transferred from the Sybase server to the Database Agent or Lite Driver. This attribute can have significant impact on performance. When set to 0 (default), the driver uses the default packet size as specified in the Sybase server configuration. When set to -1, the driver computes the maximum allowable packet size on the first connect to the data source and saves the value in the system information. When set to an integer from 1 to 10, this indicates a multiple of 512 bytes (for example, Packet Size of 6 means to set the packet size to 6 * 512 equal 3072 bytes). For this setting to have any impact, the server must be configured for a maximum network packet size greater than or equal to the value specified here. -N 0
-C <character set> The name of the character set the OpenLink driver should deliver to the client application, to be translated from the Server's character set. By default, this is taken from the application's environment. Only valid for non-Unicode drivers. Unicode drivers always deliver UCS-2 on Windows and UCS-4 on Mac OS X and Unix-like OS. -C ISO-8859-1
-O <value> Determines whether stored procedures are created on the server for every call to SQLPrepare(). Acceptable values are "2" (Full), "1" (Partial, the default), and "0" (None). Effects of this setting. -O 1

Referenced by...