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


Chapter 3 Tools : $GTFSET

$GTFSET
Enables or disables the rules tracing facility in the Execution Environment and the Data Object Broker.
This facility runs on the z/OS version of TIBCO Object Service Broker and writes a trace record to a Generalized Trace Facility (GTF) data set that can be used as input to the third-party product Trace Analyzer for Mainframe-built TIBCO Object Service Broker Rules (TAMBOR). (C)
Invocation
CALL $GTFSET(function, keyname[, userid, termid, all, dob])
 
A licence key is not required but, for compatibility with previous releases of TIBCO Object Service Broker, the value of this parameter must be 'TAMBOR'.
[OPTIONAL] The user ID of the session to be traced. If there are duplicate user IDs, the tracing facility is enabled for the first one encountered. To ensure that the facility is enabled for one specific user, use the termid argument.
[OPTIONAL] Enables or disables tracing for all users running under the current Execution Environment. If it is required, use 'ALL' for this parameter.
[OPTIONAL] Enables or disables tracing in the Data Object Broker to which the Execution Environment is connected. If present, must be one of the following:
 
Usage Notes
The trace facility produces four types of GTF records. Each GTF record has its own User Specified Event ID code (USR) contained in the GTF trace record header. The USR codes are:
For the userid, termid, and all parameters, $GTFSET acts on only the first non-null argument it encounters. If no parameter is specified, the trace facility for the session running the $GTFSET tool (the current session) is enabled or disabled.
The IBM Generalized Trace Facility (GTF) must be activated with USR=(0AA,0FC,0FD,0FE,0FF) if Data Object Broker tracing is turned on, or with USR=(0FC,0FD,0FE,0FF) otherwise.
Example
The following rule sets the tracing facility on in the Execution Environment for the current session:

 
SET_GTF_TRACE;
_
_ ------------------------------------------------------------------------
_ ------------------------------------------------------------+-----------
_ CALL $GTFSET('SET', 'TAMBOR', '', '', '', ''); | 1
_ ------------------------------------------------------------------------

 
To set the trace on in the Execution Environment for the USERXYZ user, use the following call:
CALL $GTFSET('SET', 'TAMBOR', 'USERXYZ', '', '', '');
or
CALL $GTFSET('SET', 'TAMBOR', 'USERXYZ', 'TERM9999', 'ALL', '');
To set the trace on in the Execution Environment for the user whose terminal ID is TERM9999, use the following call:
CALL $GTFSET('SET', 'TAMBOR', '', 'TERM9999', '', '');
To set the trace on in the Execution Environment and in the Data Object Broker for all users, use the following call:
CALL $GTFSET('SET', 'TAMBOR', '', '', 'ALL', 'ALSO');

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