| Oracle® Transparent Gateway for DRDA Installation and User's Guide 10g Release 2 (10.2) for Microsoft Windows Part Number B16218-01 |
|
|
View PDF |
| Oracle® Transparent Gateway for DRDA Installation and User's Guide 10g Release 2 (10.2) for Microsoft Windows Part Number B16218-01 |
|
|
View PDF |
This appendix contains the DRDA-specific parameters defined in the gateway initialization file. Read and understand the information on each parameter, taking special note of parameters that have defaults that do not apply to your system.
This appendix contains the following sections:
If you change any parameters in the gateway initialization file, then you must stop and restart the gateway in order for them to take effect. If you change certain parameters, then you must also rebind the DRDA package. Any parameters that affect the DRDA package have a note in their description that rebinding is required.
Parameters specific to the gateway are stored in the gateway initialization file, initsid.ora.
Parameters and their values are specified according to the syntax rules put forth by heterogeneous services. The general form is:
[set] [private] drda_parameter = drda_parameter_value
where:
drda_parameter is one of the DRDA parameters
drda_parameter_value is a character string with contents dependent on the drda_parameter
The set and private keywords are optional and have the following effect. If the set keyword is present, then the parameter and its value will be pushed into the process environment. If the private keyword is present, then the parameter and its value will not be uploaded to the Oracle server. In general, Oracle recommends that the private keyword not be used unless the parameter contains sensitive information (a user ID or password, for example).
For further information on heterogeneous services and initialization parameters, see the section "Setting Initialization Parameters" in the Oracle Database Heterogeneous Connectivity Administrator's Guide.
Following is a list of gateway-specific initialization file parameters and their descriptions. In addition to these parameters, generic Heterogeneous Services initialization file parameters may be set. Refer to the Oracle Database Heterogeneous Connectivity Administrator's Guide for a list of additional parameters.
Default value: TRUE
Range of values: {TRUE|FALSE}
Syntax: DRDA_CACHE_TABLE_DESC={TRUE|FALSE}
DRDA_CACHE_TABLE_DESC directs the gateway to cache table descriptions once per transaction. This can reduce the number of table lookups requested of the DRDA Server by Oracle and can speed up processing of SQL statements. You may wish to turn this option off if you will be altering the structure of a remote table and if you will be examining it within the same transaction.
Default value: none
Range of values: Refer to Native Semantics
Syntax: DRDA_CAPABILITY={FUNCTION/{ON|OFF}},...
DRDA_CAPABILITY specifies which Oracle mapped functions will be treated natively. In other words, no special preprocessing or postprocessing will be done for these functions. They will be passed to the DRDA Server unmodified.
Default value: codepage.map
Range of values: any valid file path
Syntax: DRDA_CODEPAGE_MAP=codepage.map
DRDA_CODEPAGE_MAP specifies the location of the codepage map. You may specify only the file name, which will be searched for within the ORACLE_HOME\tg4drda\admin directory, or you may specify the full path name of the file.
Default value: 32767
Range of values: 512 through 32767
Syntax: DRDA_COMM_BUFLEN=num
DRDA_COMM_BUFLEN specifies the communications buffer length. This is a number indicating the size of the SNA send/receive buffer in bytes.
Default value: DRDACON1
Range of values: any alphanumeric string 1 to 8 characters in length
Syntax: RDA_CONNECT_PARM=name
DRDA_CONNECT_PARM specifies the Side Information name. Refer to Chapter 6, "Configuring Microsoft SNA Server or Host Integration Server" and Chapter 7, " Configuring IBM Communication Server" for details.
Default value: DRDACON1:446
Range of values: Any alphanumeric string 1 to 255 characters in length
Syntax: DRDA_CONNECT_PARM={hostname|ip_address}{:port}
DRDA_CONNECT_PARM specifies the TCP/IP host name or IP Address of the DRDA Server and, as an option, the Service Port number on which the DRDA Server is listening. For more information about the port number, refer to "Port Number".
Default value: FALSE
Range of values: {TRUE |FALSE}
Syntax: DRDA_CMSRC_CM_IMMEDIATE={TRUE|FALSE}
DRDA_CMSRC_CM_IMMEDIATE sets the SNA session allocation mode. A setting of FALSE will cause the gateway to wait for a free session if no free sessions exist. A setting of TRUE will cause the gateway to fail the allocation immediately if no free sessions exist.
Default value: none
Range of values: any supported DRDA Server CCSID
Syntax: DRDA_DEFAULT_CCSID=ccsid
DRDA_DEFAULT_CCSID specifies the default CCSID or character set code page for character set conversions when the DRDA Server database indicates that a character string has a CCSID of 65535. DRDA Servers use CCSID 65535 for columns specified as "FOR BIT DATA". In most cases, this parameter should not be specified, permitting CCSID 65535 to be treated as an Oracle RAW data type.
This parameter is for supporting databases (in particular, DB2/400) that use CCSID 65535 as the default for all tables created. Permitting CCSID 65535 to be treated as another CCSID can save such sites from having to modify every table.
Default value: TRUE
Range of values: {TRUE|FALSE}
Syntax: DRDA_DESCRIBE_TABLE={TRUE|FALSE}
DRDA_DESCRIBE_TABLE directs the gateway to use the DRDA operation "Table Describe" to return the description of tables. This is an optimization that reduces the amount of time and resources that are used to look up the definition of a table.
Default value: TRUE
Range of values: {TRUE|FALSE}
Syntax: DRDA_DISABLE_CALL={TRUE|FALSE}
DRDA_DISABLE_CALL controls stored procedure usage, and it is also used to control how the package is bound on the target database. This parameter should be set to FALSE only for supported target DRDA servers and should be set to TRUE otherwise. See Chapter2, "DB2 Considerations" for supported target servers.
Default value: SESSION
Range of values: {SESSION|COMMIT}
Syntax: DRDA_FLUSH_CACHE={SESSION|COMMIT}
DRDA_FLUSH_CACHE specifies when the cursor cache is to be flushed. With DRDA_FLUSH_CACHE=COMMIT, the cursor cache is flushed whenever the transaction is committed. With DRDA_FLUSH_CACHE=SESSION, the cache is not flushed until the session terminates.
Default value: 0
Range of values: 0 through 127
Syntax: DRDA_GRAPHIC_PAD_SIZE=num
DRDA_GRAPHIC_PAD_SIZE is used to pad the size of a Graphic column as described by the DRDA Server. This is sometimes necessary depending on the character set of the DRDA database and the Oracle database. If the Oracle database is based on EBCDIC and the DRDA database is based on ASCII, then a pad size of 2 may be needed.
Default value: FALSE
Range of values: {TRUE|FALSE}
Syntax: DRDA_GRAPHIC_LIT_CHECK={TRUE|FALSE}
DRDA_GRAPHIC_LIT_CHECK directs the gateway to evaluate string literals within INSERT SQL statements to determine if they need to be converted to double-byte format for insertion into a Graphic column at the DRDA Server database. This is done by querying the column attributes of the table in the SQL statement to determine if a string literal is being applied to a column with a Graphic data type. If the table column is Graphic, and if this parameter is TRUE, then the gateway will rewrite the SQL statement with the literal converted to double-byte format. Existing double-byte characters in the string will be preserved, and all single-byte characters will be converted to double-byte characters.
Default value: FALSE
Range of values: {TRUE|FALSE}
Syntax: DRDA_GRAPHIC_TO_MBCS={TRUE|FALSE}
DRDA_GRAPHIC_TO_MBCS directs the gateway to convert Graphic data that has been fetched from the DRDA Server into Oracle multibyte data, translating double-byte characters into single-byte characters where possible.
Default value: 4
Range of values: 1 through 4
Syntax: DRDA_GRAPHIC_CHAR_SIZE=num
DRDA_GRAPHIC_CHAR_SIZE is used to define the character conversion size to be used for GRAPHIC data types. It is a tuning parameter which affects the maximum size of a GRAPHIC data type when the column is described.
Default value: CHG for DB2/400, CS for DB2/OS390, DB2/UDB, DB2/VM
Range of values: {CHG|CS|RR|ALL|NC}
Syntax: DRDA_ISOLATION_LEVEL={CHG|CS|RR|ALL|NC}
DRDA_ISOLATION_LEVEL specifies the isolation level that is defined to the package when it is created. All SQL statements that are sent to the remote DRDA database are run with this isolation level. Isolation level seriously affects performance of applications. Use caution when specifying an isolation level other than the default. For information on isolation levels, refer to IBM database manuals.
The following table lists isolation levels and their descriptions. The levels are specified in ascending order of control, with CHG having the least reliable cursor stability and RR having the most. Note that higher stability uses more resources on the server and can lock those resources for extended periods.
Range of values: any alphanumeric string 1 to 8 characters in length
Syntax: DRDA_LOCAL_NODE_NAME=name
DRDA_LOCAL_NODE_NAME specifies the name by which the gateway will be known to the DRDA Server. This name is used internally by the DRDA Server to identify the local node.
Default value: FALSE
Range of values: {TRUE|FALSE}
Syntax: DRDA_MBCS_TO_GRAPHIC={TRUE|FALSE}
DRDA_MBCS_TO_GRAPHIC directs the gateway to convert multibyte data (that has been sent from Oracle to the DRDA database) into pure double-byte characters. This parameter is primarily intended to be used with bind variables to ensure that the data is properly formatted and will therefore be acceptable to the DRDA Server. It applies only to INSERT SQL statements that are using bind variables. When used in combination with the DRDA_GRAPHIC_LIT_CHECK parameter, this parameter can help ensure that data that is being inserted into a Graphic column is handled correctly by the target DRDA Server.
Default value: TRUE
Range of values: {TRUE|FALSE}
Syntax: DRDA_OPTIMIZE_QUERY={TRUE|FALSE}
DRDA_OPTIMIZE_QUERY turns on or off the distributed query optimizer (DQO) capability. Refer to Performing Distributed Queries in Chapter 11, "Using the Gateway". The DQO capability is useful for optimizing queries that access large amounts of data, but it can add overhead to small queries.
This parameter is valid only if the DRDA Server is DB2/OS390 or DB2/VM. If the DRDA Server is DB2/400 or DB2/UDB, then you must set the value to FALSE.
Default value: ORACLE
Range of values: an alphanumeric string 1 to 18 characters in length
Syntax: DRDA_PACKAGE_COLLID=collection_id
DRDA_PACKAGE_COLLID specifies the package collection ID. Note that in DB2/400, the collection ID is actually the name of an AS/400 library.
Default value: none, use the sample provided
Range of values: a 16-digit hexadecimal number
Syntax: DRDA_PACKAGE_CONSTOKEN=hexnum
DRDA_PACKAGE_CONSTOKEN specifies the package consistency token. This is a 16-digit hexadecimal representation of an 8-byte token. Oracle Corporation recommends that you do not change the consistency token. The consistency token used at run time must match the one used when the package is bound. The value depends on the DRDA Server being used.
Default value: G2DRSQL
Range of values: an alphanumeric string 1 to 18 characters in length
Syntax: DRDA_PACKAGE_NAME=name
DRDA_PACKAGE_NAME specifies the package name. Note that the package is stored in the DRDA Server under this name as a SQL resource. Refer to the DRDA Server documentation for length limitations on package names. Many typical implementations restrict the length to 8 characters.
Default value: none
Range of values: any valid user ID
Syntax: DRDA_PACKAGE_OWNER=userid
DRDA_PACKAGE_OWNER specifies the database user ID that owns the package. This enables the owner to be a user other than the connected user ID when the package is created. The package owner must be the same user as the owner of the ORACLE2PC table. This is not valid for DB2/VM.
Default value: 100
Range of values: any integer between 1 and 65535
Syntax: DRDA_PACKAGE_SECTIONS=num
DRDA_PACKAGE_SECTIONS specifies the number of cursors declared at the remote database when the package is bound. This is the maximum number of open cursors permitted at any one time. Change this parameter only if an application needs more than 100 open concurrent cursors.
Default value: FALSE
Range of values: {TRUE|FALSE}
Syntax: DRDA_READ_ONLY={TRUE|FALSE}
DRDA_READ_ONLY specifies whether the gateway runs in a read-only transaction mode. In this mode, SQL statements which modify data are not permitted.
Default value: none
Range of values: any valid password
Syntax: DRDA_RECOVERY_PASSWORD=passwd
DRDA_RECOVERY_PASSWORD is used with the DRDA_RECOVERY_USERID parameter. The recovery user connects to the IBM database if a distributed transaction is in doubt. For more information, refer to "Two-Phase Commit Processing". Also refer to Chapter 13, "Security Considerations" for information about security and about encrypting passwords.
Default value: ORARECOV
Range of values: any valid user ID
Syntax: DRDA_RECOVERY_USERID=userid
DRDA_RECOVERY_USERID specifies the user ID that is used by the gateway if a distributed transaction is in doubtful state. This user ID must have execute privileges on the package and must be defined to the IBM database.
If a distributed transaction is in doubtful state, then the Oracle integrating server determines the status of the transaction by connecting to the IBM database, using the DRDA_RECOVERY_USERID. If this parameter is missing, the gateway attempts to connect to a user ID of ORARECOV. For more information, refer to "Two-Phase Commit Processing".
Default value: DB2V2R3
Range of values: an alphanumeric string 1 to 18 characters in length
Syntax: DRDA_REMOTE_DB_NAME=name
DRDA_REMOTE_DB_NAME specifies the DRDA Server location name. This is an identifying name that is assigned to the server for DRDA purposes. A technique for determining this name by using a SQL SELECT statement is discussed in each of the server-specific installation sections in Chapter 5, "Configuring the DRDA Server".
Default value: PROGRAM
Range of values: {PROGRAM|SAME}
Syntax: DRDA_SECURITY_TYPE={PROGRAM|SAME}
DRDA_SECURITY_TYPE specifies the type of security used for SNA communications. For more information about types of security and about setting DRDA_SECURITY_TYPE, refer to Chapter 13, "Security Considerations". Also refer to Chapter 15 for information about security and encrypting passwords.
Default value: TG4DRDA_DB2MVS
Range of values: Refer to the list below for valid values
Syntax: FDS_CLASS=TG4DRDA_DB2MVS
FDS_CLASS specifies the capability classification used by the Oracle Database server and the gateway. These values might change from release to release, depending on whether the gateway capabilities change.
The valid default values for FDS_CLASS are as follows:
For a DB2/OS390 database: TG4DRDA_DB2MVS
For a DB2/VM database: TG4DRDA_DB2VM
For a DB2/400 database: TG4DRDA_DB2400
For a DB2/UDB database: TG4DRDA_DB2UDB
Default value: 10.1.0.2.0
Range of values: 10.1.0.2.0
Syntax: FDS_CLASS_VERSION=1
FDS_CLASS_VERSION specifies the version of the FDS_CLASS capabilities. Do not specify this parameter unless directed to do so by Oracle Support Services.
Default value: DRD1
Range of values: the name of the gateway SID
Syntax: FDS_INSTANCE=drdahoa1
FDS_INSTANCE specifies a subset of the FDS_CLASS capabilities that may be modified by the user, based on initialization file parameters. If you do not specify this parameter, then its value will be the Oracle SID that is defined in the TNS Listener entry.
Default value: 20
Range of values: any integer between 1 and 1000
Syntax: HS_FDS_FETCH_ROWS=num
HS_FDS_FETCH_ROWS specifies the fetch array size. This is the number of rows to fetch at one time from the DRDA Server and to return to the Oracle Database server. This parameter will be affected by the HS_RPC_FETCH_SIZE and HS_RPC_FETCH_REBLOCKING parameters. For further information on these parameters, refer to the section "Controlling the Array Fetch Between Agent and Non-Oracle Database server" in the Oracle Database Heterogeneous Connectivity Administrator's Guide.
Default value: none
Range of values: any valid language specification
Syntax: HS_LANGUAGE=language[_territory.character_set ]
HS_LANGUAGE specifies the language and the character set that the gateway will use to interact with the DRDA Server. Care must be taken in choosing the value of these parameters, especially when the gateway will be accessing GRAPHIC data. For additional details, refer to Appendix D, "National Language Support" and to the Oracle Database Heterogeneous Connectivity Administrator's Guide.
Default value: none
Range of values: any valid character set specification
Syntax: HS_NLS_NCHAR=character_set
HS_NLS_NCHAR specifies the character set that the gateway will use to interact with the DRDA Server when accessing GRAPHIC data. Set this parameter to the same value as the character set component of the HS_LANGUAGE parameter. For additional details, refer to Appendix D, "National Language Support" and to the Oracle Database Heterogeneous Connectivity Administrator's Guide.
Default value: ORACLE_HOME\tg4drda\log\gateway sid_pid.log
Range of values: any valid file path
Syntax: LOG_DESTINATION=logpath
LOG_DESTINATION specifies the destination for gateway logging and tracing. This parameter should specify a file. If the file already exists, then it will be overwritten.
After any failure to open the log path, a second attempt to open the default is made.
Usually, LOG_DESTINATION should specify a directory. If it is specified as a file and if two or more users simultaneously use the same instance of the gateway, then they are writing to the same log. The integrity of this log is not guaranteed. If you do not specify this parameter, then the default is assumed.
Default value: 4712-12-31
Range of values: any valid date less than 4712-12-31
Syntax: ORA_MAX_DATE=yyyy-mm-dd
ORA_MAX_DATE specifies the gateway maximum date value. If the fetched date value is larger than 4712-12-31, then the gateway replaces the date value with the value defined by the ORA_MAX_DATE parameter. Any date between January 1, 4712 BC and December 31, 4712 AD is valid.
Default value: ORACLE_HOME\nls\data
Range of values: any valid NLS directory path
Syntax: SET ORA_NLS10=nlspath
ORA_NLS10 specifies the directory to which the gateway loads its character sets and other language data. Normally, this parameter does not need to be set. Some configurations, however, may require that it be set.
Default value: none
Range of values: any valid file path
Syntax: ORACLE_DRDA_TCTL=tracecontrolpath
ORACLE_DRDA_TCTL specifies the path to the DRDA internal trace control file. This file contains module tracing commands. A sample file is stored in ORACLE_HOME\tg4drda\admin\debug.tctl. This parameter is used for diagnostic purposes.
Default value: value specified for LOG_DESTINATION
Range of values: any valid file path
Syntax: ORACLE_DRDA_TRACE=logpath
ORACLE_DRDA_TRACE is used to specify a different log path for DRDA internal tracing. This tracing is separate from the rest of the gateway tracing, as specified by the LOG_DESTINATION parameter. By default, this parameter will append the DRDA internal trace to the gateway trace. This parameter is used for diagnostic purposes.
