D Heterogeneous Services Initialization Parameters

D.1 HS Initialization Parameter File Syntax

The syntax for the initialization parameter file is as follows:

1. The file is a sequence of commands.

2. Each command should start on a separate line.

3. End of line is considered a command terminator (unless escaped with a backslash).

4. Each command can have one of the following forms:

   1. <param> = <value>

   2. set <param> = <value>

   3. private <param> = <value>

   4. set private <param> = <value>

   Where:

   <param> is an initialization parameter name.

   <value> is the initialization parameter value.

   'set' and 'private' are keywords.

5. The keywords 'set' and 'private' are reserved. You cannot use either as an initialization parameter name. The 'set' keyword indicates that the initialization parameter should be set as an environment variable in the agent. The 'private' keyword indicates that the initialization parameter should be private to the agent and should not be uploaded to the server. Most initialization parameters should not be private. If, however, you are storing something sensitive like a password in the initialization parameter file, then you may not want it uploaded to the server because the initialization parameters and values are not encrypted when uploaded. Making these initialization parameters private prevents the upload from happening.

6. An initialization parameter name is a string of characters starting with a letter and consisting of letters, digits and underscores. Initialization parameter names are case sensitive.

7. An initialization parameter value is either:

   1. A string of characters that does not contain any backslashes, white space or double quotation marks (")

   2. A quoted string beginning with a double quotation mark and ending with a double quotation mark. The following can be used inside a quoted string:

      • backslash (\) is the escape character

      • \n inserts a new line

      • \t inserts a tab

      • \" inserts a double quotation mark

      • \\ inserts a backslash

      A backslash at the end of the line continues the string on the next line. If a backslash precedes any other character then the backslash is ignored.

If there is a syntax error in an initialization parameter file, none of the settings take effect.

D.2 HS_FDS_CONNECT_INFO

Specifies the information needed to connect to the Microsoft SQL Server database.

This is a required parameter, whose format is:

HS_FDS_CONNECT_INFO=server_name.database_name

Where:

server_name is the name of the server machine for the Microsoft SQL Server data and database_name is the name of the database.

If you specify only database_name, omitting server_name (but including the period), the gateway uses the following subtree of the Microsoft Windows registry to determine server_name:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSSQLServer\Client\ConnectTo

D.3 HS_FDS_DEFAULT_OWNER

The name of the table owner that is used for the Microsoft SQL Server tables if an owner is not specified in the SQL statements.

D.4 HS_FDS_PARSER_TOKEN_SIZE

Used for setting the parser token size in case the default size is not sufficient. The default value can be changed in cases when the following error occurs:

pclex input buffer overflowed, try to increase the variable tokenSize in your evironment.

With default value of 1000, the gateway could handle SQL statements close to 2M. Note that the SQL statements sent to the gateway could be very different from the SQL statements issued by the users. If in doubt, turn on gateway trace. Increase this parameter to handle larger SQL statements sent to gateways.

D.5 HS_FDS_PROC_IS_FUNC

Enables return values from functions. By default, all stored procedures and functions do not return a return value to the user.

D.6 HS_FDS_RECOVERY_ACCOUNT

Specifies the name of the recovery account used for the commit-confirm transaction model. An account with user name and password must be set up at Microsoft SQL Server. For more information about the commit-confirm model, see the HS_FDS_TRANSACTION_MODEL parameter.

D.7 HS_FDS_RECOVERY_PWD

Specifies the password of the recovery account used for the commit-confirm transaction model set up at Microsoft SQL Server. For more information about the commit-confirm model, see the HS_FDS_TRANSACTION_MODEL parameter.

D.8 HS_FDS_REPORT_REAL_AS_DOUBLE

Enables Microsoft SQL gateway to treat SINGLE FLOAT PERCISION fields as DOUBLE FLOAT PERCISION fields.

D.9 HS_FDS_RESULTSET_SUPPORT

Enables result sets to be returned from stored procedures. By default, all stored procedures do not return a result set to the user.

D.10 HS_FDS_TRACE_LEVEL

Specifies whether error tracing is turned on or off for gateway connectivity.

The following values are valid:

• OFF disables the tracing of error messages.

• ON enables the tracing of error messages that occur when you encounter problems. The results are written to a gateway connectivity log file, in $ORACLE_HOME\tg4msql\trace.

D.11 HS_FDS_TRANSACTION_LOG

Specifies the name of the table created in the Microsoft SQL Server database for logging transactions. For more information about the transaction model, see the HS_FDS_TRANSACTION_MODEL parameter.

D.12 HS_FDS_TRANSACTION_MODEL

Specifies the type of transaction model that is used when the Microsoft SQL Server database is updated by a transaction.

The following values are possible:

• COMMIT_CONFIRM provides read and write access to the Microsoft SQL Server database and allows the gateway to be part of a distributed update. To use the commit-confirm model, the following items must be created in the Microsoft SQL Server database:

  • Transaction log table. The default table name is HS_TRANSACTION_LOG. A different name can be set using the HS_FDS_TRANSACTION_LOG parameter. The transaction log table must be granted SELECT, DELETE, and INSERT privileges set to public.

  • Recovery account. The account name is assigned with the HS_FDS_RECOVERY_ACCOUNT parameter.

  • Recovery account password. The password is assigned with the HS_FDS_RECOVERY_PWD parameter.

• READ_ONLY provides read access to the Microsoft SQL Server database.

• SINGLE_SITE provides read and write access to the Microsoft SQL Server database. However, the gateway cannot participate in distributed updates.

• TWO_PHASE_COMMIT provides read and write access to the Microsoft SQL Server database and allows the gateway to be part of a distributed update using the two phase commit protocol.