Retrieves information about Gateway-Library accounting.
COPY SYGWCOB.
01 IHANDLE PIC S9(9) USAGE COMP SYNC. 01 RETCODE PIC S9(9) USAGE COMP SYNC. 01 ACCOUNTING-FLAG PIC S9(4) USAGE COMP SYNC. 01 ACCOUNTING-FILENAME PIC X(8) VALUE IS SPACES. 01 MAXNUM-ACCT-RECORDS PIC 9(9) USAGE COMP SYNC.
CALL 'TDINFACT’ USING IHANDLE, RETCODE, ACCOUNTING-FLAG, ACCOUNTING-FILENAME MAXNUM-ACCT-RECORDS.
(I) A transaction-wide structure that contains information used to set up the Gateway-Library environment. This must be the same IHANDLE specified in the program’s initial TDINIT call. It corresponds to the context structure in Open Client Client-Library.
(O) Variable where the result of function execution is returned. Its value is one of the codes listed in Table 3-12.
(O) Accounting on/off indicator. This argument returns one of the following values:
TDS-TRUE (1) |
Accounting is on. |
TDS-FALSE (0) |
Accounting is off. |
(O) Variable where the name of the accounting log is returned.
Under CICS: This is the DATASET name from the CICS File Control Table (FCT) entry that describes the VSAM file used for this log. As installed, this name is SYTACCT1.
Under IMS TM and MVS: Leave this field blank. IMS TM and MVS ignore this value.
(O) Accounting log record limit.
Under CICS: This is the maximum number of records to be allocated for this accounting file. A value of -1 indicates the system maximum.
Under IMS TM: The IMS TM system log does not have a limit.
Under MVS: Use -1. The size of the log is determined by the space allocated to the sequential file used as the MVS log.
The RETCODE argument can contain any of the return values listed in Table 3-12.
Return value |
Meaning |
|---|---|
TDS-OK (0) |
Function completed successfully. |
TDS-INVALID-IHANDLE (-19) |
Invalid IHANDLE specification. Error in specifying a value for the IHANDLE argument. |
TDS-INVALID-PARAMETER (-4) |
Invalid parameter value. The value assigned to one or more of the arguments supplied in the call is not valid. The operation failed. |
The following code fragment processes a request for accounting information and returns that information to the client. This example is based on the sample program in Appendix G, “Sample Tracing and Accounting Program” which runs under CICS.
*---------------------------------------------------------------- TDINFACT. *----------------------------------------------------------------
MOVE LENGTH OF GWL-INFACT-STATUS TO WRKLEN1.
MOVE LENGTH OF CN-INFACT-STATUS TO WRKLEN2.
ADD +1 TO CTR-COLUMN.
MOVE 'TDESCRIB' TO MSG-SRVLIB-FUNC.
CALL 'TDESCRIB' USING GWL-PROC, GWL-RC, CTR-COLUMN, TDSINT4,
WRKLEN1, GWL-INFACT-STATUS, TDS-ZERO,
TDS-FALSE, TDSINT4, WRKLEN1,
CN-INFACT-STATUS, WRKLEN2.
IF GWL-RC NOT = TDS-OK THEN
MOVE 'N' TO SEND-DONE-SW
GO TO TDINFACT-EXIT
END-IF.
MOVE LENGTH OF GWL-INFACT-FILENAME TO WRKLEN1.
MOVE LENGTH OF CN-INFACT-FILENAME TO WRKLEN2.
ADD +1 TO CTR-COLUMN.
CALL 'TDESCRIB' USING GWL-PROC, GWL-RC, CTR-COLUMN, TDSCHAR,
WRKLEN1, GWL-INFACT-FILENAME,
TDS-ZERO, TDS-FALSE, TDSCHAR, WRKLEN1,
CN-INFACT-FILENAME, WRKLEN2.
IF GWL-RC NOT = TDS-OK THEN
MOVE 'N' TO SEND-DONE-SW
GO TO TDINFACT-EXIT
END-IF.
MOVE LENGTH OF GWL-INFACT-RECORDS TO WRKLEN1.
MOVE LENGTH OF CN-INFACT-RECORDS TO WRKLEN2.
ADD +1 TO CTR-COLUMN.
CALL 'TDESCRIB' USING GWL-PROC, GWL-RC, CTR-COLUMN, TDSINT4,
WRKLEN1, GWL-INFACT-RECORDS, TDS-ZERO,
TDS-FALSE, TDSINT4, WRKLEN1,
CN-INFACT-RECORDS, WRKLEN2.
IF GWL-RC NOT = TDS-OK THEN
MOVE 'N' TO SEND-DONE-SW
GO TO TDINFACT-EXIT
END-IF.
CALL 'TDINFACT' USING GWL-INIT-HANDLE, GWL-RC,
GWL-INFACT-STATUS,
GWL-INFACT-FILENAME,
GWL-INFACT-RECORDS.
IF GWL-RC NOT = TDS-OK THEN
MOVE 'N' TO SEND-DONE-SW
MOVE 'TDINFACT' TO MSG-SRVLIB-FUNC
GO TO TDINFACT-EXIT
END-IF.
CALL 'TDSNDROW' USING GWL-PROC, GWL-RC.
*----------------------------------------------------------------
TDINFACT-EXIT.
*----------------------------------------------------------------
EXIT.
You use this function to determine whether system-wide accounting recording is on or off and, under CICS, to learn the name of the accounting log.
This function returns accounting information recorded at the mainframe server. The TRS administrator can turn local accounting recording on and off at the TRS. Accounting at the mainframe and at the TRS are independent of each other.
Gateway-Library accounting records the total number of TDS bytes, packets, messages, rows, requests, and cancels sent and received by Open ServerConnect from the time a TDACCEPT function initializes the TDS environment until a TDFREE is issued, and the number of seconds and milliseconds that elapsed during the conversation.
To set accounting recording on or off, use TDSETACT.
The accounting flag is set to off when Gateway-Library is initialized. It remains off until the program explicitly turns it on with TDSETACT, then it remains on until the program explicitly turns it off with TDSETACT. No other Gateway-Library functions turn accounting on or off.
Accounting information is written to the accounting log after TDFREE is issued.
Under CICS: The accounting log is a VSAM ESDS file.
Under IMS TM: The accounting log is the IMS TM system log. For more information on this log, see your IMS TM documentation.
Under MVS: The accounting log is a sequential file. The DDNAME of this file is defined in SYGWXCPH.
See the Mainframe Connect Server Option Installation and Administration Guide for an explanation of the Gateway-Library accounting facility, instructions for using it, and the layout of the CICS accounting log.
Related functions
Related documents
Mainframe Connect Server Option Installation and Administration Guide
