Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 2 Operating Service Gateway for DB2 : Gateway Parameters

Gateway Parameters
You specify gateway startup parameters in the HDB2SRVC data set. For more information on specifying gateway parameters, refer to Specifying Gateway Parameters.
Parameters that you must set include PLAN, SSID, and TDS. You can add or modify the other parameters as required.
 
Name of the Gateway plan to be used if the browse flag is on. If omitted, the plan used is the one specified for the PLAN parameter.
COMMA – The DB2 subsystem uses commas to indicate decimal points.
PERIOD – Default. The DB2 subsystem uses periods to indicate decimal points.
USERID – Default. The TIBCO Object Service Broker session ID.
GROUP – The current TIBCO Object Service Broker security group. This group can be up to 16 characters but only 8 characters are supported. A SECURITYFAIL occurs for more than 8 characters.
1 – Activate Fail Safe Level 1. The Gateway informs the Data Object Broker that it can support Fail Safe level‑1 processing. If the Gateway is to attach to a z/OS Data Object Broker, the Data Object Broker’s connection attribute setting “commit level” must be set to 1. If not, the Gateway connection is rejected. Refer to Implementing Fail Safe Processing for more information. You must specify the TRXDB, FSTABLENAME, and RECOVERYID parameters.
0 – De-activate Fail Safe processing. The Gateway informs the Data Object Broker that it does not support Fail Safe level‑1 processing. If the Gateway is to attach to a z/OS Data Object Broker, the Data Object Broker’s connection attribute setting “commit level” must be set to 0. If not, the Gateway connection is rejected. Refer to Implementing Fail Safe Processing for more information.
Required only if FSLEVEL=1. Specifies the name of the TIBCO Object Service Broker DB2 table that maps to the DB2 transaction table.
Note: If you also specify the TRXDB parameter, the system uses TRXDB=creator.tablename and replaces the DB2 creator and tablename in the TIBCO Object Service Broker DB2 table specified in FSTABLENAME. If you have multiple TIBCO Object Service Broker DB2 initializer programs with the same SERVERID, the FSLEVEL, FSTABLENAME, TRXDB, and RECOVERYID gateway parameters must have the same values for each initializer program.
Each instance of the Gateway must have a unique IDPREFIX. This parameter is the prefix to be used to construct a unique name for each Gateway address space. The Gateway appends three decimal digits to this prefix and uses the result to log in to TIBCO Object Service Broker. It uniquely identifies each Gateway to TIBCO Object Service Broker. This parameter can have up to five characters. Default: DB2.
Default: the pattern assumed from the model specified for the TDS gateway parameter. For example, if you do not specify MDL and TDS=OSB0001, the Gateway uses the pattern OSBnnnn. If you do not specify MDL, ensure that the value of TDS is a valid VTAM ACB model.
Specifies whether the Gateway is marked as nonswappable after initialization. The Gateway must be running authorized for this parameter to take effect. Valid values are YES (default) and NO.
The optimum way to run a Gateway is authorized, as a started task, and nonswappable. This way the Gateway uses symmetrical cross memory services.
S6BDB2M attaches Gateway subtasks (S6BDB2S) without ESTAE EXIT. Include this parameter for abend debugging.
The Gateway plan name. The name must correspond to the name used in the bind input member XLINKDB5. Refer also to BROWSEPLAN and UPDATEPLAN. Default: S6BDB2S.
The amount of space (in kilobytes) to hold TIBCO Object Service Broker DB2 table definitions in the Gateway. This parameter take a value in the range 32 to 16384. An estimate of the minimum number of TIBCO Object Service Broker DB2 tables that can be accessed in a single transaction is POOLSIZE divided by the maximum CTABLESIZE. Refer to Estimating the CTABLESIZE Parameter for more information. Default: 256 (KB).
Applicable only if FSLEVEL=1 and SECLEVEL=1. Sets the DB2 primary authorization ID that you want to use during recovery when querying the DB2 transaction table to see if the transaction completed (in-doubt transactions). The ID can be up to eight characters and must have EXECUTE authority to the Gateway plan and SELECT access to the DB2 transaction table. Default: the ID used to start the Gateway.
Note: If you have multiple TIBCO Object Service Broker DB2 initializer programs with the same SERVERID, ensure that the FSLEVEL, TRXDB, FSTABLENAME, and RECOVERYID gateway parameters are assigned the same values for each initializer program.
The mode that the Gateway uses to respond to requests. You can use this mode to release a Gateway for a new transaction more quickly in read-only situations. Valid values:
ASYNC – Default. The Data Object Broker releases the Gateway from the transaction when it sends a transaction end message to the Gateway (it does not wait for transaction end confirmation from the Gateway). Note  This applies if the Gateway processed only query requests.
SYNC – Causes the Data Object Broker to wait for the Gateway to complete the end of transaction processing (SQL COMMIT success or failure result from DB2).
For use only with a Data Object Broker on z/OS. This parameter corresponds to the EARLY REL Gateway path management field. For more information, refer to Startup Prerequisites.
SESSION – Hold the connection for the life of the Gateway. The connection is not established until the first request for DB2 data is processed by the Gateway.
TRANSACTION – Hold the connection for the life of a TIBCO Object Service Broker transaction.
nnnn – Hold the connection for nnnn seconds beyond the end of the TIBCO Object Service Broker transaction. Valid entries are 0-9999.
0 – Default. Access the DB2 subsystem using the ID that started the Gateway. The ID is verified by the DB2 subsystem, not TIBCO Object Service Broker. Do not use an external security interface.
1 – Access the DB2 subsystem based on the user’s TIBCO Object Service Broker session ID or the current group name. Use an external security interface. If SECLEVEL=1 and FSLEVEL=1, review the default for the RECOVERYID parameter. If SECLEVEL=1, review the defaults for the EXTERNALUSERID and SCOPE parameters.
Identifies a pool of Gateways with common characteristics such as Gateway plan, POOLSIZE, DB2 subsystem, and the rest. If you have multiple TIBCO Object Service Broker DB2 initializer programs with the same SERVERID, ensure that the FSLEVEL, RECOVERYID, FSTABLENAME, and TRXDB gateway parameters have the same values for each initializer program.
You must specify a server ID when defining a TIBCO Object Service Broker DB2 table so the definition uses the correct version of SYSIBM.SYSTABLES and SYSIBM.SYSCOLUMNS. This parameter can be up to eight characters.
The number of Gateway tasks that the TIBCO Object Service Broker DB2 initializer program should attach to the Gateway address space at startup. This number can be from one to a value less than or equal to the value set in the Maximum Connection Count field in your network configuration. Default: 1.
Specifies the method of SQL creation. Specify STATICCURSORSELECT=EXACT or omit the parameter. EXACT forces dynamic SQL creation if an exact static handler cannot be found.
Invokes a debugging tool showing SQL errors and warnings, and SQL statements as they are passed to DB2 (for SELECT, INSERT, UPDATE, and DELETE processing). OPEN CURSOR, CLOSE CURSOR, and FETCH are not logged. To activate TRACE you must also:
1 - 80: The statement or error. Also shows the static handler load module name if Static SQL is used, and the SQL statements and value of any variables if Dynamic SQL is used.
81: The continuation marker.
82 - 89: The ID of the Gateway (IDPREFIX followed by Gateway number).
90 - 97: The TIBCO Object Service Broker transaction ID (use with the DEBUG parameter).
The transaction database. Required only if FSLEVEL=1 and if the actual Fail Safe DB2 transaction table name and/or creator are different from the ones to which the TIBCO Object Service Broker DB2 table name specified using the FSTABLENAME parameter points. The name of the DB2 transaction file to contain information about the last transaction processed by the Gateways.
Note: Alternatively, you can specify the FSTABLENAME parameter. If you have multiple TIBCO Object Service Broker DB2 initializer programs with the same SERVERID, the FSLEVEL, FSTABLENAME, and TRXDB gateway parameters must have the same values for each initializer program.
The name of the Gateway plan to be used if the browse flag is off. If omitted, the plan used is the one specified for the PLAN parameter.
Include this parameter if DB2 LIKE statements are to be generated instead of TIBCO Object Service Broker LIKE statements when using FORALL…LIKE statements to select data for evaluation. For more information, refer to FORALL Statement.
ANY – Default. Indicates that batch and online users can use the Gateway.
ONLINE – Reserves the Gateway for online users only.
When allocating a Gateway, the Data Object Broker first tries to allocate an online user to an online Gateway. If it cannot, it tries to allocate the user to a Gateway with USERTYPE=ANY. For use only with a Data Object Broker on z/OS. This parameter corresponds to the ONLINE ONLY Gateway path management field. For more information, refer to Startup Prerequisites.
Estimating the CTABLESIZE Parameter
When you select DB2 columns as TIBCO Object Service Broker DB2 fields, the number of fields that you can access using a TIBCO Object Service Broker DB2 table definition is dependent upon the CTABLESIZE Data Object Broker parameter. To estimate the number of bytes required to support a specified number of fields, execute the following rule:
 
ESTIMATETBLDFN(NUM_FIELDS)
 
You must supply one argument, which is the maximum number of fields accessed by a TIBCO Object Service Broker DB2 table in your system. The rule returns an estimate of the maximum CTABLESIZE required (for each TIBCO Object Service Broker table type) to support this number of fields.
Result of Executing ESTIMATETBLDEFN for 50 Fields

 
----------------------------- INFORMATION LOG --------------------------------
COMMAND ===> SCROLL ===> P
DATE: Nov 28,2006 REPORT ON ESTIMATE CTABLESIZE
FOR "50" FIELDS
 
Table Type CTablesize(K) XTablesize(K)
---------- ------------- -------------
 
ADA 5
DAT 7
DB2 5
IDM 6
IMS 6 3
MAP 4
SLK 4
204 6
TDS 3
 
 
 
 
 
 
 
PFKEYS: 2=NEXT LOG 3=EXIT 5=REPEAT FIND 12=EXIT 13=PRINT 9=RECALL

 
See Also
TIBCO Object Service Broker for z/OS Installing and Operating for information on TIBCO Object Service Broker network configuration.
Refer to TIBCO Object Service Broker Parameters for information about the CTABLESIZE Data Object Broker parameter.
Dynamically Changing Gateway Parameters
When a table is defined, attributes specific to external DBMS table types are held in the @SERVERPARMS control table, which is parameterized by table name. Each occurrence in the table specifies a value, such as SERVERID and SERVERTYPE, related to the external environment. The complete set of such attributes for a particular table type can be found in the @@SERVERPARMS control table parameterized by table type.
Sample @@SERVERPARMS Control Table for Table Type DB2

 
EDITING TABLE : @@SERVERPARMS(DB2)
COMMAND ==>
SCROLL: P
NUMBER NAME TYPE SYNTAX LENGTH DECIMAL DEFAULT
_ ----------- ---------------- - - ------ ------ ----------------
_ 1 SERVERID S C 8 0 DEFAULT
_ 2 SERVERTYPE S C 3 0
_ 3 CODEPAGE S C 32 0
_ 4 VERSION Q V 8 0 0
_ 6 DB2CREATOR S V 128 0
_ 7 DB2NAME S V 128 0
_ 8 DB2LOCATION S C 16 0
_ 9 STATICSQL S C 1 0 N
_ 10 STATICSQLHANDLER S C 8 0
 
 
 
 
 
 
PFKEYS: 1=HELP 5=FIND NEXT 9=RECALL 18=EXCLUDE 13=PRINT 3=END 14=EXPAND

 
Using SETXPARM and RESETXPARM
At runtime, you can dynamically modify the SERVERID gateway startup parameter using the SETXPARM and RESETXPARM shareable tools. This reduces the number of table definitions required to define the external data. The changes are stored in either of two session tables:
The changes are in effect for the duration of the session, until SETXPARM is invoked again, or the overrides are reset.
Gateway Parameters that Can Be Overridden at Runtime
The gateway parameters that can be dynamically changed with SETXPARM and RESETXPARM are SERVERID and SERVERTYPE. The value for SERVERTYPE is DB2.
Examples Using SETXPARM and RESETXPARM
CALL SETXPARM('TABLETYPE', 'DB2', 'SERVERID', 'TORONTO', '');
CALL RESETXPARM ('TABLETYPE', 'DB2', 'SERVERID', '');
See Also
TIBCO Object Service Broker Shareable Tools for detailed descriptions of the SETXPARM and RESETXPARM tools.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved