%META:TOPICPARENT{name="InstallServerOSX"}%
=Database Agent Environment Settings found in the Broker Rulebook=
%TOC%

==Common Agent Environment Settings==

|**Variable**|**Default Setting**|**Description**|
| <code>CURSOR_SENSITIVITY</code> | <code>LOW</code> | Enables or disables the row version cache used with dynamic cursors. When dynamic cursor sensitivity is set high, the Cursor Library calculates checksums for each row in the current rowset and compares these with the check-sums (if any) already stored in the row version cache for the same rows when fetched previously. If the check-sums differ for a row, the row has been updated since it was last fetched and the row status flag is set to {{{SQL_ROW_UPDATED}}}. The row version cache is then updated with the latest check-sums for the rowset. From the user's point of view, the only visible difference between the two sensitivity settings is that a row status flag can never be set to {{{SQL_ROW_UPDATED}}} when the cursor sensitivity is low. (The row status is instead displayed as {{{SQL_ROW_SUCCESS}}}.) In all other respects, performance aside, the two settings are the same. Deleted rows don't appear in the rowset. Updates to the row since the row was last fetched are reflected in the row data, and inserted rows appear in the rowset, if their keys fall within the span of the rowset. If your application does not need to detect the row status {{{SQL_ROW_UPDATED}}}, you should leave the '**High Cursor Sensitivity**' checkbox unchecked, as performance will be impacted. The calculation and comparison of check-sums for each row fetched carries an overhead. If this option is enabled, the table {{{oplrvc}}} must have been created beforehand using the appropriate script for the target database.|


==DB2==

|**Variable**|**Default Setting**|**Description**|
| <code>DB2DIR</code> | <code>/DB2</code> | Full path to the base directory for the DB2 installation. //**Note:** DB2 version 5 and below use the environment variable <code>DB2PATH</code> instead.// |
| <code>DB2INSTANCE</code> | <code>DB2</code> | Name of the instance you want to connect to. <code>DB2</code> is the default DB2 instance name. |


==Informix 5==

|**Variable**|**Default Setting**|**Description**|
| <code>INFORMIXDIR</code> | <code>/dbs/informix5</code> | Full path to the base directory for the Informix 5 installation. |
| <code>TBCONFIG</code> | <code>tbconfig</code> | Database server configuration file. |
| <code>FORCE_ONLINE_DATABASE</code> | <code>1</code> | Force mode to (<code>0</code>) SE or (<code>1</code>) ONLINE. |


==Informix 6==

|**Variable**|**Default Setting**|**Description**|
| <code>INFORMIXDIR</code> | <code>/dbs/informix6</code> | Full path to the base directory for the Informix 6 installation. |


==Informix 7+==

|**Variable**|**Default Setting**|**Description**|
| <code>INFORMIXDIR</code> | <code>/dbs/informix7</code> | Full path to the base directory for the Informix 7 installation. |
| <code>INFORMIXSERVER</code> | <code>online7</code> | The name of Informix 7 server that you want the agent to attach to. As long as you have I-Connect or I-Net installed, configured, and up-and-running this value can connect your database agent with remote Informix database servers. |
| <code>ONCONFIG</code> | <code>ONCONFIG</code> | Database server configuration file. |
| <code>FORCE_ONLINE_DATABASE</code> | <code>1</code> | Force mode: <code>0</code> for Standard Engine (SE); <code>1</code> for ONLINE. |
| <code>DELIMIDENT</code> | <code>Y</code> | When set to <b><code>Y</code></b>, SQL-92 rules are in effect for quoted identifiers and literals.  Literals must be wrapped in single-quotes.  Identifiers may be wrapped in double-quotes to get around reserved word and reserved character limitations.  When set to <b><code>N</code></b>, literals may be wrapped in either double- or single-quotes and identifiers may not be wrapped. |
| <code>OPL_INF_MULTISESS</code> | <code>Y</code> | Enables Informix multi-session mode. <code>Y</code>: Each ODBC connection gets its own database session. <code>N</code>: All ODBC connections share a single database connection. |
| <code>OPL_SPACEPADCHAR</code> | <code>Y</code> | Character data from a <code>CHAR</code> column is fetched with trailing spaces retained. The column data is padded up to the column width, if actual content is shorter. <code>N</code>: Trailing spaces will be stripped off. |


==Ingres==

|**Variable**|**Default Setting**|**Description**|
| <code>II_DATE_FORMAT</code> | <code>US</code> | Defines the output format for dates as <code>dd-mmm-yyyy</code>. This should not be changed inside the Rule Book since it enables the best compatibility with <nop>OpenLink. This will not affect any other Ingres applications. |
| <code>II_SYSTEM</code> | <code>/dbs</code> | Full path to the directory containing the <code>Ingres/</code> directory, e.g., if your Ingres installation directory is <code>/dbs/Ingres</code> then set this to <code>/dbs</code>. |
| <code>ING_SET</code> | <code>set lockmode session where readlock<nowiki>=</nowiki>nolock</code> | When the Ingres agent is started, the first thing it does is run this command. The command itself makes sure that a simple <code>SELECT</code> statement does not lock all the rows it selects. |
| <code>USE_OWNER</code> | <code>Y or N</code> | Only applicable for Ingres 6.4 databases. If set to <code>Y</code> forces the driver to return the Ingres internal table owner as the schema name for the table, as was necessary for early version of MSQuery. |


==ODBC-JDBC Bridge==

|**Variable**|**Default Setting**|**Description**|
| <code>JET_SQLSTATISTICSOFF</code> | <code>FALSE</code> | If it is set to '<code>TRUE</code>', the function <code>SQLStatistics()</code> returns an empty result set. This helps to resolve the problem with the <code>SQLStatistics()</code> output from some JDBC drivers. |
| <code>JET_DROPCATALOGFROMDBMETACALLS</code> | <code>FALSE</code> | If it is set to '<code>TRUE</code>', the <code>NULL</code> will be assigned to the field '<code>Catalog</code>' in the result sets of <code>SQLTables()</code>, <code>SQLColumns()</code> & <code>SQLStatistics()</code> calls. |
| <code>JET_DROPSCHEMAFROMDBMETACALLS</code> | <code>FALSE</code> | If it is set to '<code>TRUE</code>', the <code>NULL</code> will be assigned to the field '<code>Schema</code>' in the result sets of <code>SQLTables()</code>, <code>SQLColumns()</code> & <code>SQLStatistics()</code> calls. |
| <code>JET_NOSUPPORTOFQUOTEDIDENTIFIER</code> | <code>FALSE</code> | If it is set to '<code>TRUE</code>', the call <code><nop>SQLGetInfo(SQL_IDENTIFIER_QUOTE_CHAR)</code> will return the space (" "). This can be used if DBMS doesn't support quoted identifiers as in <code>SELECT * FROM "account"</code>. |
| <code>PATCHNULLSIZEOFSQLCHAR</code> | <code>	</code> | If DBMS is returning a field of type <code>SQLCHAR</code> or <code>SQLVARCHAR</code> with zero size, the size will be replaced with the value of <code>PATCHNULLSIZEOFSQLCHAR</code> |
|<code>OPL_JVM_OPTS</code> |  | List of standard [[http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html|java command line arguments]] to pass to the JVM on initiation of the session  |

==Oracle 7==

|**Variable**|**Default Setting**|**Description**|
| <code>ORACLE_HOME</code> | <code>/dbs/oracle7</code> | The home directory for the Oracle installation. |
| <code>ODBC_CATALOGS</code> | <code>Y</code> | Uncomment after running the "<code>odbccat7.sql</code>" script. |
| <code>MULTIPLEX_LDA</code> | <code>5</code> | Allow 5 <nop>OpenLink clients via a single database session. |
| <code>OPL_USER_TBLS_FIRST</code> | <code>N</code> | Set to <code>Y</code> to show <nop>OpenLink User Tables first. |
| <code>SHOW_REMARKS</code> | <code>N</code> | Set to <code>Y</code> to retrieve <code>SQLColumns</code> <code>REMARKS</code> field. |


==Oracle 8i, 9i, 10g, 11g==

|**Variable**|**Default Setting**|**Description**|
| <code>ORACLE_HOME</code> | <code>/dbs/oracle</code> | The home directory for the Oracle installation. |
| <code>ODBC_CATALOGS</code> | <code>Y</code> | Uncomment after loading the "<code>odbccat8.sql</code>" script. |
| <code>MULTIPLEX_LDA</code> | <code>5</code> | Allow 5 <nop>OpenLink clients via a single database session. |
| <code>OPL_USER_TBLS_FIRST</code> | <code>N</code> | Set to <code>Y</code> to show <nop>OpenLink User Tables first. |
| <code>SHOW_REMARKS</code> | <code>N</code> | Set to <code>Y</code> to retrieve <code>SQLColumns</code> <code>REMARKS</code> field. |
| <code>OCI_PREFETCH_ROWS</code> | <code>120</code> | Sets the number of rows to be prefetched. |
| <code>OCI_PREFETCH_MEMORY</code> | <code>64</code> | Kb of memory allocated for rows to be prefetched. |


==Progress==

|**Variable**|**Default Setting**|**Description**|
| <code>DLC</code> | <code>/dbs/dlc</code> | Must be full path to the Progress <code>dlc</code> directory.|
| <code>PROCFG</code> | <code>/dbs/dlc/progress.cfg</code> | Must be the full path and filename to the <code>progress.cfg</code> file. This parameter is optional. Use it if the license file can not be found.|
| <code>TABLEVIEW</code> | <code></code> | <b>SQL-89 only.</b> Must be the full path and filename to the table view file (<code>tableview.dat</code>). See detailed TABLEVIEW document for more information|
| <code>TABLEVIEW_QUALIFIER</code> | <code>Y</code> | <b>SQL-89 only.</b> Add owner information to <code>SELECT</code> statements. |
| <code>DEADLOCK_TIMEOUT</code> | <code>60</code> | Seconds to wait for lock to release. |
| <code>INSERT_LOGICAL</code> | <code>Y</code> | <b>SQL-89 only.</b> Rewrite character <code>TRUE/FALSE</code> to logical. |
| <code>UPDATE_LOGICAL</code> | <code>Y</code> | <b>SQL-89 only.</b> Rewrite character <code>TRUE/FALSE</code> to logical. |
| <code>SPACE_QUOTE_IDENTIFIER</code> | <code>Y </code> | If the <code>SPACE_QUOTE_IDENTIFIER</code> keyword is unset, it defaults to true, i.e., a space is returned as the quote character. To make the driver return an empty string for the quote character, this keyword must be set to <code>N</code>. Most applications work properly with the default behavior (<code>SPACE_QUOTE_IDENTIFIER <nowiki>=</nowiki> Y</code>). Known exceptions include some versions of Microsoft Visio, the Microsoft SQL Server DTS Wizard, and Business Objects.|
| <code>MIN_FIELD_LEN</code> | <code></code> | <b>SQL-89 only.</b> Minimum length for character fields or expressions. [[DataIsTruncated|More details]].|
| <code>MAX_FIELD_LEN</code> | <code></code> | <b>SQL-89 only.</b> Maximum length for character fields or expressions. [[DataIsTruncated|More details]].|
| <code>EXPR_PRECISION</code> | <code></code> | <b>SQL-89 only.</b> Fixed precision for numeric expressions.|
| <code>EXPR_SCALE</code> | <code></code> | <b>SQL-89 only.</b> Fixed scale for numeric expressions.|



==SQL Server==

|**Variable**|**Default Setting**|**Description**|
| <code>FREETDSCONF</code> | <code>/opt/openlink/bin/freetds.conf</code> | Passes the full path to a local <code>freetds.conf</code> file.|
| <code>DSQUERY</code> | <code>SQLSERVER</code> | Which section will be loaded  from the <code>freetds.conf</code> file.|
| <code>TDSHOST</code> | <code>sqlsrv.example.com</code> | DNS-resolvable hostname or IP address for the target SQL Server machine|
| <code>TDSPORT</code> | <code>1433</code> | [[HowDoIFindMySQLServerListenPort|The TCP/IP port on which your SQL Server listens for incoming connections]]. |
| <code>TDSVER</code> | <code>7.0</code> | Sets TDS compatibility.  May not match actual SQL Server nor TDS version. See [[ServerAgentAdminTDS|Table #2]]  for acceptable values. |
| <code>SQLSERVER_CATALOG</code> | <code>Y</code> | |


==Sybase==

|**Variable**|**Default Setting**|**Description**|
| <code>FREETDSCONF</code> | <code>/home/openlink/bin/freetds.conf</code> | Passes the full path to a local <code>freetds.conf</code> file. |
| <code>DSQUERY</code> | <code>SYBASE</code> | Which section will be loaded from the <code>freetds.conf</code> file. |
| <code>TDSHOST</code> | <code>sybhost.example.com</code> | DNS-resolvable hostname or IP address for the target Sybase machine. |
| <code>TDSPORT</code> | <code>4100</code> | The port on which your Sybase listens for incoming connections. |
| <code>TDSVER</code> | <code>5.0</code> | Sets TDS compatibility.  May not match actual Sybase nor TDS version.  See [[ServerAgentAdminTDS|Table #2]]  for acceptable values.  |
| <code>SQLSERVER_CATALOG</code> | <code>Y</code> | |