Log manager domain’s specific gates

Table 63 summarizes the log manager domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gate, the functions provided by the gate, and whether or not the functions are available through the exit programming interface (XPI).

Table 63. Log manager domain’s specific gate
Gate Trace Function XPI
LGGL
LG 0201
LG 0202
OPEN
WRITE
FORCE
CLOSE
WRITE_JNL
FORCE_JNL
UOW_TIME
INITIALIZE
NO
NO
NO
NO
NO
NO
NO
NO
LGJN
LG 0301
LG 0302
LG 0314
LG 0325
INQUIRE
START_BROWSE
GET_NEXT
END_BROWSE
SET
DISCARD
EXPLICIT_OPEN
IMPLICIT_OPEN
INITIALIZE
STREAM_FAIL
PROCESS_STATISTICS
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
LGLD
LG 0401
LG 0402
LG 0411
LG 0412
LG 0415
INQUIRE
START_BROWSE
GET_NEXT
END_BROWSE
MATCH
INSTALL
DISCARD
INITIALIZE
NO
NO
NO
NO
NO
NO
NO
NO
LGST
LG 0501
LG 0502
LG 0514
LG 0517
LG 0526
INQUIRE
START_BROWSE
GET_NEXT
END_BROWSE
CONNECT
DISCONNECT
INITIALIZE
NO
NO
NO
NO
NO
NO
NO
LGPA
LG 0601
LG 0602
INQUIRE_PARAMETERS
SET_PARAMETERS
YES
YES
LGLB
LG 2001
LG 2002
CONNECT
DISCONNECT
GL_WRITE
GL_FORCE
DISCONNECT_ALL
NO
NO
NO
NO
NO
LGCC
LG 2101
LG 2102
SYSINI
CREATE_CHAIN_TOKEN
RELEASE_CHAIN_TOKEN
RESTORE_CHAIN_TOKEN
START_BROWSE_CHAINS
BROWSE_CHAINS_GET_NEXT
END_BROWSE_CHAINS
DELETE_ALL
SET_HISTORY
DELETE_HISTORY
SET_KEYPOINT_FREQUENCY
INQUIRE_KEYPOINT_FREQUENCY
SET_DEFER_INTERVAL
INQUIRE_DEFER_INTERVAL
INQUIRE_KEYPOINT_STATS
RESET_KEYPOINT_STATS
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
LGWF
LG 2201
LG 2202
WRITE
FORCE_DATA
NO
NO
LGCB
LG 2301
LG 2302
START_CHAIN_BROWSE
CHAIN_BROWSE_GET_NEXT
END_CHAIN_BROWSE
NO
NO
NO
LGBA
LG 2401
LG 2402
START_BROWSE_ALL
BROWSE_ALL_GET_NEXT
END_BROWSE_ALL
NO
NO
NO
LGMV
LG 2501
LG 2502
MOVE_CHAIN
NO
LGSR
LG 2601
LG 2602
WRITE
FORCE_DATA
NO
NO

LGBA gate, BROWSE_ALL_GET_NEXT function

Returns the next record in the browse all object.

Input parameters

None
 

Output parameters

USER_TOKEN
is a user token that was passed in by RESTORE_CHAIN_TOKEN.
USER_DATA
is the address of the CICS® record just read from the CICS system log.
USER_DATA_LENGTH
is the length of the CICS record just read from the chain.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION END_OF_DATA

LGBA gate, END_BROWSE_ALL function

Destroys the browse all object.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGBA gate, START_BROWSE_ALL function

Creates a browse all object for the CICS system log.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCB gate, CHAIN_BROWSE_GET_NEXT function

Creates a browse object for the chain denoted by CHAIN_TOKEN.

Input parameters

CHAIN_TOKEN
is a chain token.

Output parameters

USER_DATA
is the address of the CICS record just read from the chain.
USER_DATA_LENGTH
is the length of the CICS record just read from the chain.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION END_OF_DATA

LGCB gate, END_CHAIN_BROWSE function

Destroys the chain browse object denoted by CHAIN_TOKEN.

Input parameters

CHAIN_TOKEN
is a chain token.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCB gate, START_CHAIN_BROWSE function

Creates a browse object for the chain denoted by CHAIN_TOKEN.

Input parameters

CHAIN_TOKEN
is a chain token.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, SYSINI function

Creates a primary and secondary log stream objects of type MVS™ that comprises the CICS system log.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, CREATE_CHAIN_TOKEN function

Creates a CHAIN TOKEN.

Input parameters

None
 

Output parameters

CHAIN_TOKEN
is a new chain token token, which can be used as input to RELEASE_CHAIN_TOKEN, RESTORE_CHAIN_TOKEN, START_CHAIN_BROWSE, CHAIN_BROWSE_GET_NEXT, END_CHAIN_BROWSE, MOVE_CHAIN
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, RELEASE_CHAIN_TOKEN function

Destroys the chain token in CHAIN_TOKEN

Input parameters

CHAIN_TOKEN
is a chain token that must have been created by CREATE_CHAIN_TOKEN or RESTORE_CHAIN_TOKEN

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, RESTORE_CHAIN_TOKEN function

Creates a chain token and adds the last record (viewed as a chain element) read from the system log during a BROWSE_ALL_GET_NEXT

Input parameters

USER_TOKEN
is a user token that is returned by BROWSE_CHAINS_GET_NEXT and BROWSE_ALL_GET_NEXT.

Output parameters

CHAIN_TOKEN
is a new chain token token, which can be used as input to RELEASE_CHAIN_TOKEN, RESTORE_CHAIN_TOKEN, START_CHAIN_BROWSE, CHAIN_BROWSE_GET_NEXT, END_CHAIN_BROWSE, MOVE_CHAIN.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, START_BROWSE_CHAINS function

Creates a chains browse object and initializes the browse cursor position.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, BROWSE_CHAINS_GET_NEXT function

Returns the next chain token and moves the browse cursor position to the next chain.

Input parameters

None
 

Output parameters

CHAIN_TOKEN
is the chain token of the next chain in the chains browse list.
USER_TOKEN
is a user token that was passed in by RESTORE_CHAIN_TOKEN.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION END_OF_CHAINS

LGCC gate, END_BROWSE_CHAINS function

Destroys the browse chains object.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, DELETE_ALL function

Deletes all of the data on both log streams of the CICS system log.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, SET_HISTORY function

Evaluates and saves the current history point for both log streams of the CICS system log. The history point of a log stream is the oldest block id that CICS knows of on the log stream.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, DELETE_HISTORY function

Deletes all blocks of data, for both log streams of the CICS system log, that are older than the corresponding history point saved during a call of SET_HISTORY.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, SET_KEYPOINT_FREQUENCY function

Sets the activity frequency to KEYPOINT_FREQUENCY.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION OUT_OF_RANGE

LGCC gate, INQUIRE_KEYPOINT_FREQUENCY function

Returns the activity keypoint frequency value in KEYPOINT_FREQUENCY.

Input parameters

None
 

Output parameters

KEYPOINT_FREQUENCY
is the current keypoint frequency value.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, SET_DEFER_INTERVAL function

Sets the log defer interval.

Input parameters

DEFER_INTERVAL
is the number of milliseconds for which a forced log write will be deferred. The maximum value that may be specified is 65535 milliseconds.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION OUT_OF_RANGE

LGCC gate, INQUIRE_DEFER_INTERVAL function

Returns the number of millisecoonds for which a forced log write will be deferred.

Input parameters

None
 

Output parameters

DEFER_INTERVAL
is the number of millisecoonds for which a forced log write will be deferred.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, INQUIRE_KEYPOINT_STATS function

Return the number of keypoints that have occurred since the count was last reset.

Input parameters

None
 

Output parameters

KEYPOINT_COUNT
is the number of keypoints that have occurred since the count was last reset.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGCC gate, RESET_KEYPOINT_STATS function

Reset the count of the number of keypoints.

Input parameters

None
 

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call.

LGGL gate, OPEN function

Opens a general log and returns a log token. The log token is used by the WRITE, FORCE and CLOSE operations.

Input parameters

STREAM_NAME
The 26-byte log stream name to be opened
JNL_NAME
The 8-byte journal name to be opened

Either STREAM_NAME or JNL_NAME must be specified

COMPONENT
Identifies the component (e.g. FC) opening this stream
[USER_TOKEN]
A token that identifies to the calling component why this log stream was opened. It will be passed to the ERROR gate in the event that an error is detected on the log stream. For example for file control it might contain a pointer to the DSNBx
[ERROR_GATE]
The domain gate number that the logger should call using ERROR if an error occurs accessing the log stream.

Output parameters

LOG_TOKEN
The token to be used on subsequent WRITE, FORCE, CLOSE requests.
LOG_TYPE
The associated log stream type: It can have any one of these values:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
JNL_STREAM
The MVS logstream name associated with the journal being opened
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
ERROR_OPENING_LOG
LOG_IS_SYSTEM_LOG
LOG_IS_DISABLED
LOG_NOT_DEFINED
LOG_HAS_FAILED
INVALID_JNL_NAME
INVALID INVALID_PARAMETERS

LGGL gate, WRITE function

Write a record to a general log identified by a token from a previous OPEN.

Input parameters

LOG_TOKEN
The token returned by OPEN
DATA
The address of a reusable Iliffe vector describing the items of data to be written to the log stream.
[FORCE_NOW]
Indicates that the caller wishes to wait until the data has been successfully written to the log stream. It can have either of these values:
YES|NO

Default is NO

[FORCE_AT_SYNC]
Indicates that the caller wishes the log stream to be forced when the associated transaction reaches Syncpoint. It can have either of these values:
YES|NO

Default is NO

Note:
Force_at_Sync can be used in conjunction with FORCE_NOW. This is needed by File control for ESDS writes which have to be forced immediately but which also need the UOW structure to allow the calculation of Fuzzy backup recovery times.

Output parameters

[FORCE_TOKEN]
A token to be used on a subsequent FORCE to ensure that a specific records and any prior records have been hardened
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID Possible values are:
RESPONSE Possible REASON values
EXCEPTION
WRITE_ERROR
BUFFER_LENGTH_ERROR
INVALID UNKNOWN_LOG_TOKEN

LGGL gate, FORCE function

Ensures that the previously written records have been flushed from the buffer and hardened on the chosen log stream

Input parameters

LOG_TOKEN
The token returned by OPEN
[FORCE_TOKEN]
Token returned by WRITE to indicate a specific record to be written. If omitted all records are forced.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION WRITE_ERROR
INVALID UNKNOWN_LOG_TOKEN

LGGL gate, CLOSE function

Invalidates the LOG_TOKEN, on the last usage of a log stream disconnects from the log stream

Input parameters

LOG_TOKEN
The token returned by OPEN

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION WRITE_ERROR
INVALID UNKNOWN_LOG_TOKEN

LGGL gate, WRITE_JNL function

Write a record to a general log identified by a journal name

Input parameters

JNL_NAME
The 8-byte journal name to be written to
DATA
The address of a reusable Iliffe vector describing the items of data to be written to the log stream.
[FORCE_NOW]
Indicates that the caller wishes to wait until the data has been successfully written to the log stream. It can have either of these values:
YES|NO

Default is NO

[FORCE_AT_SYNC]
Indicates that the caller wishes the log stream to be forced when the associated transaction reaches Syncpoint. It can have either of these values:
YES|NO

Default is NO

Note:
Force_at_Sync can be used in conjunction with FORCE_NOW. This is needed by File control for ESDS writes which have to be forced immediately but which also need the UOW structure to allow the calculation of Fuzzy backup recovery times.
COMPONENT
Identifies the component (e.g. TC) writing this stream
SUSPEND
Supported for compatibility with old EXEC interface. Causes BUFFER_FULL exception to be raised if there is no space rather than waiting for space. The task may still be suspended for many other reasons! It can have either of these values:
YES|NO

Default is YES

Output parameters

[FORCE_TOKEN]
A token to be used on a subsequent FORCE_JNL to ensure that a specific record and any prior records have been hardened
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
WRITE_ERROR
ERROR_OPENING_LOG
LOG_IS_SYSTEM_LOG
LOG_IS_DISABLED
LOG_HAS_FAILED
LOG_NOT_DEFINED
BUFFER_FULL
INVALID_JNL_NAME
BUFFER_LENGTH_ERROR

LGGL gate, FORCE_JNL function

Ensures that the previously written records have been hardened on the chosen log.

Input parameters

JNL_NAME
The 8-byte journal name to be forced
[FORCE_TOKEN]
Token returned by WRITE_JNL to indicate a specific record to be written. If omitted all records are forced.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
WRITE_ERROR
LOG_IS_NOT_ACTIVE
LOG_IS_SYSTEM_LOG
LOG_IS_DISABLED
LOG_HAS_FAILED

LGGL gate, UOW_TIME function

Returns the oldest active transactions first log write time for use in calculating the recovery time for Backup while open.

Usually called by AKP processing when calculating the recovery time for non-RLS BWO files

Input parameters

UOW_TIME_STAMP
The 8-byte STCK format time of the oldest active transaction that has written log records with the FORCE_AT_SYNC option, or current time if there are no active transactions.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call

LGGL gate, INITIALIZE function

Establish subpools, locks, and anchor control blocks

Called as subroutine during domain initialization.

Input parameters

None

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call

LGJN gate, INQUIRE function

Returns information about the current state of a user journal

Also causes the stats information for a particular journal to be updated, when called as part of a FORCE_JNL request from LGGL.

Input parameters

JNL_NAME
The 8-byte Journal name to be inquired upon
[FORCE]
Indicates that a force of the data in the buffer has been requested.

This is used to indicate when the stats field in the journal info, which records the number of flushes, needs incrementing.

Output parameters

[LOG_TYPE]
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
[JNL_STATUS]
The associated log stream status:
Note:
Status will always appear as disconnected for journals that have not been used as user journals (i.e. system logs, forward recovery logs, fc auto journals) even though they may be in use
CONNECTED
Stream is currently connected
DISCONNECTED
Stream is not currently connected
DISABLED
Stream has been disabled by SPI/CEMT function
FAILED
The MVS log stream has failed
[STREAM_NAME]
The associated MVS log stream name. Blank for SMF or DUMMY
[SYSTEM_LOG]
Whether or not the journal is a system log. It can have either of these values:
YES|NO
[STREAM_TOKEN]
The log stream token if the journal is currently connected to an MVS log stream or the logbuf token for an SMF journal.

If specified the stream shared lock will be acquired and it its the callers responsibility to free the lock when they have finished with the stream token.

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION UNKNOWN_JNL_NAME

LGJN gate, START_BROWSE function

Initialize browse token for subsequent GET_NEXT requests

Input parameters

None.

Output parameters

BROWSE_TOKEN
Token for use on subsequent GET_NEXT requests
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this call

LGJN gate, GET_NEXT function

Return information for next Journal.

Input parameters

BROWSE_TOKEN
Token returned by START_BROWSE

Output parameters

JNL_NAME
The next 8-byte Journal name found
[LOG_TYPE]
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
[JNL_STATUS]
The associated log stream status:
Note:
Status will always appear as disconnected for journals that have not been used as user journals (i.e. system logs, forward recovery logs, fc auto journals) even though they may be in use
CONNECTED
Stream is currently connected
DISCONNECTED
Stream is not currently connected
DISABLED
Stream has been disabled by SPI/CEMT function
FAILED
The MVS log stream has failed
[STREAM_NAME]
The associated MVS log stream name. Blank for SMF or DUMMY
[SYSTEM_LOG]
Whether or not the journal is a system log. It can have either of these values:
YES|NO
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NO_MORE_DATA_AVAILABLE
INVALID INVALID_BROWSE_TOKEN

LGJN gate, END_BROWSE function

Terminate browse and invalidate browse token

Input parameters

BROWSE_TOKEN
Token returned by START_BROWSE

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_BROWSE_TOKEN

LGJN gate, SET function

Update the status of the Journal.

Will create journal if it does not currently exist (except for FLUSH)

Input parameters

JNL_NAME
The 8-byte Journal name to be updated
JNL_STATUS
The new status for the journal:
CONNECTED
Stream is to be connected
DISCONNECTED
Stream is to be disconnected
DISABLED
Stream is to be disabled from further use
FLUSH
The current log buffers are to be written to the log stream

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
JNL_ALREADY_IN_REQ_STATE
JNL_IS_NOT_ACTIVE
LOG_IS_SYSTEM_LOG
SYSTEM_LOG_CONFLICT
UNKNOWN_JNL_NAME
UNABLE_TO_CREATE_JNL
ERROR_OPENING_LOG
JNL_HAS_FAILED
INVALID_JNL_NAME
WRITE_ERROR

LGJN gate, DISCARD function

Remove a journal from the set of known journals to clean up the catalog or to allow it to be reinstalled with a new set of attributes.

Input parameters

JNL_NAME
The 8-byte Journal name to be discarded

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOG_IS_SYSTEM_LOG
UNKNOWN_JNL_NAME

LGJN gate, EXPLICIT_OPEN function

Inquire on a journal and if the journal does not already exist in the set of known journals perform the autoinstall process to define it.

The stream is explicitly opened for each call and so must eventually be explicitly closed using the LGST DISCONNECT function

Input parameters

JNL_NAME
The 8-byte Journal name to be Explicit_Opened
SYSTEM_LOG
Whether or not this journal is to be used as a system log It can have either of these values:
YES|NO

Output parameters

[LOG_TYPE]
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
[JNL_STATUS]
The associated log stream status:
Note:
Status will always appear as disconnected for journals that have not been used as user journals (i.e. system logs, forward recovery logs, fc auto journals) even though they may be in use
CONNECTED
Stream is currently connected
DISCONNECTED
Stream is not currently connected
DISABLED
Stream has been disabled by SPI/CEMT function
FAILED
The MVS log stream has failed
STREAM_TOKEN
The log stream token if the journal is currently connected to an MVS log stream or the logbuf token for an SMF journal.
[STREAM_NAME]
The associated MVS log stream name. Blank for SMF or DUMMY
[LOG_TOKEN]
The buffer manager's log token for the log stream
[STRUCTURE_NAME]
is the 16 byte name of the coupling facility structure of the log stream.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNABLE_TO_CREATE_JNL
SYSTEM_LOG_CONFLICT
JNL_IS_DISABLED
JNL_HAS_FAILED
ERROR_OPENING_LOG
INVALID_JNL_NAME

LGJN gate, IMPLICIT_OPEN function

Inquire on a journal and if the journal does not already exist in the set of known journals perform the autoinstall process to define it. If the associated log stream has not been opened then it is opened and the stream token returned.

Input parameters

JNL_NAME
The 8-byte Journal name to be Explicit_Opened
SYSTEM_LOG
Whether or not this journal is to be used as a system log It can have either of these values:
YES|NO
[FORCE]
Indicates that a force of the data in the buffer has been requested.

This is used to indicate when the stats field in the journal info, which records the number of flushes, needs incrementing. It can have either of these values:

YES|NO
[WRITE_BYTES]
The number of bytes of data being written, as a 64 bit value.

This field is used to update the bytes counter in the stats information for a journal, and also indicates that the writes counter also needs incrementing.

Output parameters

[LOG_TYPE]
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
[JNL_STATUS]
The associated log stream status:
Note:
Status will always appear as disconnected for journals that have not been used as user journals (i.e. system logs, forward recovery logs, fc auto journals) even though they may be in use
CONNECTED
Stream is currently connected
DISCONNECTED
Stream is not currently connected
DISABLED
Stream has been disabled by SPI/CEMT function
FAILED
The MVS log stream has failed
[STREAM_NAME]
The associated MVS log stream name. Blank for SMF or DUMMY
STREAM_TOKEN
The log stream token if the journal is currently connected to an MVS log stream or logbuf token for SMF.

If specified the stream shared lock will be acquired and it its the callers responsibility to free the lock when they have finished with the stream token.

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNABLE_TO_CREATE_JNL
SYSTEM_LOG_CONFLICT
JNL_IS_DISABLED
JNL_HAS_FAILED
ERROR_OPENING_LOG
INVALID_JNL_NAME

LGJN gate, INITIALIZE function

Establish subpools, locks, and anchor control blocks

Called as subroutine during domain initialization.

Input parameters

None

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this call

LGJN gate, STREAM_FAIL function

Marks all journals that have used the failing log stream as failed, issues a message, and closes the stream connection. This ensures that all subsequent activity for the log stream is rejected until either CICS is restarted or the operator explicitly reactivates the journal

Input parameters

STREAM_TOKEN
The token of the log stream that has failed
STREAM_NAME
The name of the log stream that has failed

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this call

LGJN gate, PROCESS_STATISTICS function

Deal with the various types of requests for journal statistics using the information in the STST parameter list.

Input parameters

STATS_PARMS
The address of the STST parameter list.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_JNL_NAME
NO_JOURNALS_DEFINED

LGLB gate, CONNECT function

Creates a log stream object and if of type MVS, a connection is made to the log stream, denoted by its name, through the MVS logger.

Input parameters

STREAM_NAME
is the name of the log stream to be connected. Only valid if the log type is MVS.
SYSTEM_LOG
is the system log indicator, which can assume the following values:
YES
The log stream being connected is part of the CICS system log.
NO
The log stream being connected is general log.
LOG_TYPE
is the log stream type, which can assume the following values:
MVS
A MVS logger log stream
SMF
The MVS SMF log
DUMMY
A dummy log
JOURNAL_NAME
is the journal name associated with the log stream on this request.
[STRUCTURE_NAME]
is the 16 byte name of the coupling facility structure of the log stream.

Output parameters

LOGBUF_TOKEN
is the token denoting the connected log stream, which can be used as input to GL_WRITE, GL_FORCE and DISCONNECT.
RESPONSE
is the response code, possible values are:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOG_NOT_DEFINED
CONNECT_FAILURE

LGLB gate, DISCONNECT function

Destroys the log stream object and if it is of type MVS, disconnects from the MVS logger.

Input parameters

LOGBUF_TOKEN
is the token of the log stream created during a call of CONNECT.

Output parameters

RESPONSE
is the response code, possible values are:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOG_NOT_DEFINED
CONNECT_FAILURE

LGLB gate, GL_WRITE function

Writes a record to a general log denoted by LOGBUF_TOKEN.

Input parameters

LOGBUF_TOKEN
is the token of the log stream created during a call of CONNECT.
DATA
is the address of the data to be written.
COMPONENT
identifies the original CICS component making this request.
SUSPEND
is a task suspend indicator, which can assume the following values:
YES
The task may be suspended if necessary.
NO
If there is no buffer space immediately available without suspending the current task then return an exception with a reason of BUFFER_FULL
JOURNAL_NAME
is the journal name associated with the log stream on this request.

Output parameters

FORCE_TOKEN
is the token denoting the output buffer which includes the data of this request. This token can be used as input to GL_FORCE.
RESPONSE
is the response code, possible values are:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
BUFFER_FULL
BUFFER_LENGTH_ERROR
WRITE_FAILURE

LGLB gate, GL_FORCE function

Ensures that the output buffer denoted by FORCE_TOKEN for the log stream denoted by LOGBUF_TOKEN has been written to the physical media.

Input parameters

LOGBUF_TOKEN
is the token of the log stream created during a call of CONNECT.
FORCE_TOKEN
is the token denoting the output buffer containing the data written during a call of GL_WRITE. A null token denotes the current output buffer.

Output parameters

RESPONSE
is the response code, possible values are:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION WRITE_FAILURE

LGLB gate, DISCONNECT_ALL function

Ensures that any data in the output buffer has been written to the physical media before the stream connection is destroyed for all connected streams.

Input parameters

None.
 

Output parameters

RESPONSE
is the response code, possible values are:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
No reason codes are defined for this call

LGLD gate, INQUIRE function

Returns information about the current state of a JournalModel

Input parameters

JOURNALMODEL_NAME
The 8-byte JournalModel name to be inquired upon

Output parameters

[JNL_TEMPLATE]
The associated journal name template
[LOG_TYPE]
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
[STREAM_PROTOTYPE]
The associated MVS log stream name prototype
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION UNKNOWN_JOURNALMODEL_NAME

LGLD gate, START_BROWSE function

Initialize browse token for subsequent GET_NEXT requests

Input parameters

None

Output parameters

BROWSE_TOKEN
Token for use on subsequent GET_NEXT requests
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this function.

LGLD gate, GET_NEXT function

Return information for next JournalModel entry

Input parameters

BROWSE_TOKEN
Token returned by START_BROWSE

Output parameters

JOURNALMODEL_NAME
The next 8-byte JournalModel name
[JNL_TEMPLATE]
The associated journal name template
[LOG_TYPE]
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
[STREAM_PROTOTYPE]
The associated MVS log stream name prototype
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NO_MORE_DATA_AVAILABLE
INVALID INVALID_BROWSE_TOKEN

LGLD gate, END_BROWSE function

Terminate browse and invalidate browse token

Input parameters

BROWSE_TOKEN
Token returned by START_BROWSE

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_BROWSE_TOKEN

LGLD gate, MATCH function

Find JournalModel entry that best matches a journal name. Variables in the stream name prototype are resolved and the resultant stream name is returned.

Input parameters

JNL_NAME
The journal name to be matched

Output parameters

LOG_TYPE
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
STREAM_NAME
The MVS log stream name
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION INVALID_JNL_NAME

LGLD gate, INSTALL function

Create/replace JournalModel entry

Input parameters

JOURNALMODEL_NAME
The 8-byte JournalModel name
JNL_TEMPLATE
The associated journal name template
LOG_TYPE
The associated log stream type:
MVS
MVS logger stream
SMF
SMF logging
DUMMY
No logging
STREAM_PROTOTYPE
The associated MVS log stream name prototype

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_JNL_TEMPLATE
INVALID_STREAM_PROTOTYPE

LGLD gate, DISCARD function

Remove a JournalModel from the set of defined JournalModels

Input parameters

JOURNALMODEL_NAME
The 8-byte JournalModel name to be discarded

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION UNKNOWN_JOURNALMODEL_NAME

LGLD gate, INITIALIZE function

Establish subpools, locks, and anchor control blocks

Called as subroutine during domain initialization.

Input parameters

None

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this function.

LGMV gate, MOVE_CHAIN function

Destroys the chain browse object denoted by CHAIN_TOKEN.

Input parameters

CHAIN_TOKEN
is a chain token denoting the chain to be moved.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this function.

LGPA gate, INQUIRE_PARAMETERS function

Inquire logger domain parameters.

Input parameters

None

Output parameters

[KEYPOINT_FREQUENCY]
How often, in terms of physical writes to the system log, activity keypoints are initiated. A value of zero indicates that activity keypoints are not initiated.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this function.

LGPA gate, SET_PARAMETERS function

Set logger domain parameters.

Input parameters

[KEYPOINT_FREQUENCY]
How often, in terms of physical writes to the system log, activity keypoints should be initiated. A value of zero indicates that activity keypoints should not be initiated.

Non-zero values outside the range from 200 to 65535 inclusive are invalid and cause the OUT_OF_RANGE exception to be returned.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION OUT_OF_RANGE

LGSR gate, LOGSTREAM_STATS function

Collects, and resets if required, the log stream statistics of either the log stream denoted by LOGSTREAM_NAME or of all log streams known to the log manager.

Input parameters

[ALL]
if specified then the request is for all log streams of type MVS known to the log manager.
[LOGSTREAM_NAME]
if specified then this is a log stream name, which must be of type MVS.
STATS_BUFFER_ADDR
is the address of a buffer to put the log stream statistics record(s).
STATS_BUFFER_LENGTH
is the length of the buffer.
[RESET]
is a request qualifier that assumes the following values:
YES
The log stream statistics data are to be reset after collection.
NO
The log stream statistics data are not to be reset.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION LOG_NOT_DEFINED

LGST gate, INQUIRE function

Returns information about the current state of a stream name

Input parameters

STREAM_NAME
The 26-byte stream name

Output parameters

[USE_CT]
The current number of users of the stream
[SYSTEM_LOG]
Whether or not this is a CICS system log It can have either of these values:
YES|NO
[FAILED]
Whether or not the stream has failed It can have either of these values:
YES|NO
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION UNKNOWN_STREAM_NAME

LGST gate, START_BROWSE function

Initialize browse token for subsequent GET_NEXT requests

Input parameters

None

Output parameters

BROWSE_TOKEN
Token for use on subsequent GET_NEXT requests
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this function.

LGST gate, GET_NEXT function

Return information for next stream entry

Input parameters

BROWSE_TOKEN
Token returned by START_BROWSE

Output parameters

STREAM_NAME
The 26-byte stream name
[USE_CT]
The current number of users of the stream
[SYSTEM_LOG]
Whether or not this is a CICS system log It can have either of these values:
YES|NO
[FAILED]
Whether or not the stream has failed It can have either of these values:
YES|NO
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NO_MORE_DATA_AVAILABLE
INVALID INVALID_BROWSE_TOKEN

LGST gate, END_BROWSE function

Terminate browse and invalidate browse token

Input parameters

BROWSE_TOKEN
Token returned by START_BROWSE

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_BROWSE_TOKEN

LGST gate, CONNECT function

Connect to an MVS log stream, or increment use count on subsequent call.

Input parameters

STREAM_NAME
The 26-byte stream name
SYSTEM_LOG
Whether or not this is a CICS system log It can have either of these values:
YES|NO

Output parameters

STREAM_TOKEN
A token to represent this stream
[STRUCTURE_NAME]
is the 16 byte name of the coupling facility structure of the log stream.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
SYSTEM_LOG_CONFLICT
LOG_HAS_FAILED
DEFINE_FAILURE
CONNECT_FAILURE,

LGST gate, DISCONNECT function

Decrement the stream use count and disconnect from the MVS logger on last use

Input parameters

STREAM_TOKEN
The token returned by CONNECT

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this function.

LGST gate, INITIALIZE function

Establish subpools, locks, and anchor control blocks

Called as subroutine during domain initialization.

Input parameters

None

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None defined for this function.

LGWF gate, FORCE_DATA function

Ensures that the output buffer denoted by FORCE_TOKEN has been written to the physical media.

Input parameters

FORCE_TOKEN
is a token denoting the output buffer containing the data written during a call of GL_WRITE. A null token denotes the current output buffer.

Output parameters

RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION AKP_KICK_OFF

LGWF gate, WRITE function

Writes a record to the CICS system log.

Input parameters

DATA
is the address of the data to be written.
CHAIN_TOKEN
is a token denoting the chain that this record belongs. A chain token is created by CREATE_CHAIN_TOKEN and RESTORE__CHAIN_TOKEN
SUSPEND
is a task suspend indicator, which can assume the following values:
YES
The task may be suspended if necessary.
NO
If there is no buffer space immediately available without suspending the current task then return an exception with a reason of BUFFER_FULL
FORCE
is a request qualifier, which can assume the following values:
YES
The data of this request including any other data already in the output buffer is to be written to the physical media before returning.
NO
The data of this request need only be written to the output buffer, but may get written to the physical media.
RAISE_LENGERR
is a request qualifier, which can assume the following values:
YES
If the data length is too large to fit into the output buffer then an EXCEPTION condition is returned to the caller.
NO
If the data length is too large to fit into the output buffer then the log manager terminates CICS.

Output parameters

FORCE_TOKEN
is the token denoting the output buffer which includes the data of the request. This token can be used as input to GL_FORCE.
RESPONSE
is the log manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
BUFFER_FULL
AKP_KICK_OFF
BUFFER_LENGTH_ERROR
[[ Contents Previous Page | Next Page Index ]]