Defining serviceability and trace options

For example, the OPTIONS statement allows you to specify which IMS traces should be activated automatically by the system during IMS initialization.

The word OPTIONS starting in position 1 identifies the OPTIONS statement. You can specify the parameters in any order, but you must separate them with commas. A blank must follow the last parameter. The remaining portion of the statement is not examined. You cannot continue an OPTIONS statement on a subsequent statement, but you can provide several statements. If an OPTIONS parameter appears more than once, its setting is determined by the last occurrence. The OPTIONS statement and all its parameters are optional.

If you specify OUTMED for DL/I and lock traces, IMS replaces this with a specification of OUTHIGH. If turning on external tracing for DL/I and lock, you should use the highest level of tracing.

Related reading: For more information about all these traces, see IMS Version 15.4 Diagnosis.

Valid environments for defining serviceability and trace options

The following table lists serviceability and trace options that can be activated for particular environments. If you attempt to activate a trace in an environment that does not support that type of trace, IMS ignores your request.

Control statements for defining serviceability and trace options

Notes:

• ¹ This parameter accepts values from the common options listed below.

Common options for defining serviceability and trace

ON

Turns on the trace table.

OUT

Initializes and turns on the trace table for output to the log. Log records 4096 bytes long are written to the log when trace records are written.

LOW

Turns on the trace for all low volume events.

MED

Turns on the trace for all low and medium volume events.

MEDIUM

Turns on the trace for all low and medium volume events.

HIGH

Turns on the trace for all low, medium, and high volume events.

OUTLOW

Initializes the trace table for output to the log and turns it on for tracing all low volume events.

OUTMED

Initializes the trace table for output to the log and turns it on for tracing all low and medium volume events.

OUTMEDIUM

Initializes the trace table for output to the log and turns it on for tracing all low and medium volume events.

OUTHIGH

Initializes the trace table for output to the log and turns it on for tracing all low, medium, and high volume events.

Related Reading: See IMS Version 15.4 Diagnosis for information about when and why trace tables are used, and defining and setting up trace facilities.

Parameter descriptions for defining serviceability and trace options

CSLT=

Activates an IMS trace that traces activity related to IMS's interaction with the Common Service Layer. This includes IMS's interaction with OM, RM, and SCI. No default value exists. If this parameter is omitted, the trace is not activated by the OPTIONS statement. It can be activated and deactivated by the online /TRACE command.

DIAG=

Activates the /DIAGNOSE command trace tables. If this parameter is omitted, the trace is not activated by the OPTIONS statement. It can be activated and deactivated by the online /TRACE command.

Related reading: For more details on the /DIAGNOSE and /TRACE commands, see IMS Version 15.4 Commands, Volume 1: IMS Commands A-M.

DISP=

Activates an IMS trace and traces the calls of the IMS dispatcher. No default value exists. If this parameter is omitted, the trace table is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

Restriction: DISP= is applicable to the online system only. The DISP trace is not allowed in a batch environment. If this trace is requested in a batch environment, the request is ignored.

DL/I=

Activates an IMS trace that traces the calls of certain DL/I modules and the functions invoked by these DL/I modules. The default value is ON. The only exception to this is for batch regions. For batch regions, the default is that the DL/I trace is off. To deactivate the DL/I trace table, issue the /TRACE command in an online environment.

The DL/I trace, the program isolation trace, and the lock trace share the same trace table.

This keyword can also be used to turn on the DL/I retrieve trace table, but it does not control the number of table entries, which is fixed at 255.

If you specify OUTMED for DL/I and lock traces, IMS replaces this with a specification of OUTHIGH. If turning on external tracing for DL/I and lock, you should use the highest level of tracing.

DLOG=

Activates an IMS trace. The DASD log trace traces the activity of the IMS DASD logger. No default value exists. If this parameter is omitted, the trace table is not activated by the OPTIONS statement. It can be activated deactivated by using the /TRACE command.

DUMP=

Provides a serviceability aid. If you specify NO or omit the parameter and an abnormal condition is encountered, the buffer handler issues a pseudoabend. If you specify YES and an abnormal condition is encountered, the buffer handler issues a standard abend, which results in the control region abnormally terminating also. If DUMP=YES and any abnormal termination occurs, the modified or newly created buffers in the pool at that time are not written to the data set.

For batch environments, if you specify NO or omit the parameter, a dump is taken and all modified buffers in all subpools are written to the data set. This cleans up any outstanding I/Os before purging the pools. If you specify YES, only a dump is taken. The modified buffers are not written to the data set.

DUMPIO=

Provides a serviceability aid for analyzing OSAM I/O errors. If you specify YES and an OSAM I/O error occurs, the IMS region abnormally terminates with a U0764. If the DUMPIO option is requested, the DFS0762I error message is not displayed.

FAST=

Activates an IMS trace that traces DBF trace entries from various Fast Path modules. No default exists. If this parameter is omitted, the trace is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

Recommendation: Run the FPTRACE in a test environment only. FPTRACE output is very large and can impact performance.

Restriction: The FAST trace is not allowed in a batch environment. If this trace is requested in a batch environment, the request is ignored.

Related reading: For more details on the FPTRACE, see IMS Version 15.4 Diagnosis.

FPTT=

Activates a Fast Path trace that traces certain Fast Path modules and the functions invoked by these Fast Path modules. The default value is OFF. To activate the Fast Path trace table, issue the /TRACE command in an online environment.

The Fast Path trace resides in its own trace table.

Related reading: For more details on the Fast Path trace, see IMS Version 15.4 Diagnosis.

IDC0=

Activates the tracing of errors in modules DFSCNXA0 and DFSIDC00. No default value exists. If this parameter is omitted, the trace table is not activated by the OPTIONS statement. It can be activated or deactivated by using the online /TRACE command.

Restriction: The IDC0 trace is not allowed in a batch or DBCTL environment. If this trace is requested in either a batch or DBCTL environment, the request is ignored.

ISSUE681=

Specifies the number of DFS681I messages to be issued per second within a batch or BMP region.

ALL

Allows all DFS681I messages generated to be issued. All is the default.

NONE

Allows no DFS681I messages to be issued.

NN

Is the number (1 - 99) of DFS681I messages that you allow to be issued. If some DFS681I messages are not issued, DFS683I is issued and states the number of DFS681I messages omitted.

ISSUE840=

Specifies whether message DFS0840I is issued if there is a duplicate segment in a unique secondary index, even if it is possible to back out prior changes for the call.

NO

Specifies that DFS0840I message is not issued for this condition. NO is the default.

YES

Specifies that DFS0840I message is issued for this condition.

LATC=

Activates an IMS trace. LATCH traces IMS latch activity. No default value exists. If this parameter is omitted, the trace table is not activated by the OPTIONS statement. It can be activated and deactivated by using by the /TRACE command.

Restriction: The LATC trace is not allowed in a batch environment. If this trace is requested in a batch environment, the request is ignored.

LOCK=

Activates an IMS trace that traces the lock activity of certain DL/I modules. The default value is ON. The only exception to this is for batch regions. For batch regions, the default is that the lock trace is off. To deactivate the LOCK trace table, issue the /TRACE command in an online environment.

The lock trace, the program isolation trace, and the DL/I trace share the same trace table.

If you specify OUTMED for DL/I and lock traces, IMS replaces this with a specification of OUTHIGH. If turning on external tracing for DL/I and lock, you should use the highest level of tracing.

Restriction: The LOCK trace is not allowed in a DCCTL environment. If this trace is requested in a DCCTL environment, the request is ignored.

LUMI=

Activates an IMS trace that traces LUM code that supports an LU 6.2 device. It contains the following information:

• Record written on entry and exit to selected LU 6.2 device modules
• Information from APPC/MVS™ verb with acceptable or unacceptable return code

If this parameter is omitted, the trace table is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

Restriction:  The LUMI trace is not allowed in a batch or DBCTL environment. If this trace is requested in one of these environments, the request is ignored.

MSCT=

Activates an IMS trace for Multiple Systems Coupling (MSC).

OCMD=

Activates an IMS trace that traces IMSplex command activity. No default value exists. If this parameter is omitted, the trace is not activated by the OPTIONS statement. It can be activated and deactivated by the online /TRACE command.

ORTT=

Activates an IMS trace that traces the IMS Database Recovery Facility activity in the IMS control region. If this parameter is omitted, the IMS Database Recovery Facility trace is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

Restriction:  The ORTT trace is not allowed in a batch or DC environment. If this trace is requested in this environment, the request is ignored.

OTMT=

Activates an IMS trace. OTMT traces the flow of control through IMS OTMA. No default exists. If this parameter is omitted, the trace is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

Restriction:  The OTMT trace is not allowed in a batch or DBCTL environment. If this trace is requested in any of these environments, the request is ignored.

QMGR=

Activates an IMS trace for an online system. QMGR traces calls made to the IMS queue manager. No default value exists. If you omit this parameter, the trace table is not activated by the OPTIONS statement. It can be activated and deactivated by using the online ⁄TRACE command.

Restriction: The QMGR trace is not allowed in a batch environment. If this trace is requested in a batch environment, the request is ignored.

RRST=

Activates an IMS trace for z/OS® Resource Recovery Services (RRS). No default value exists. If this parameter is omitted, the trace table is not activated by the OPTIONS statement. The trace can be activated and deactivated by using the online /TRACE command.

Restriction: The RRST trace is not allowed in a batch environment. If this trace is requested in a batch environment, the request is ignored.

SCHD=

Activates an IMS trace. SCHD traces the calls of the IMS scheduler. No default value exists. If this parameter is omitted, the trace table is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

Restriction:  The SCHD trace is not allowed in batch environments. If this trace is requested in either of these environments, the request is ignored.

SECT=

Activates the security trace table. If this parameter is omitted, the trace is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

SQTT=

Activates an IMS trace for an online system. SQTT traces the shared queues interface including:

• Initialization of the connection to CQS
• CQS requests
• Notification of work available from CQS
• Termination of the connection to CQS

No default value exists. If you omit this parameter, the trace table is not activated by the OPTIONS statement, but can be activated and deactivated by using means of the online /TRACE command.

Restriction: The SQTT trace is not allowed in a batch environment. If this trace is requested in a batch environment, the request is ignored.

STRG=

Activates an IMS trace. STRG traces all calls to the IMS storage manager that require modifications to one of the following pools:

• AOIP
• CESS
• CIOP
• CMDP
• DYNP
• EMHB
• FPWP
• HIOP
• LUMC
• LUMP
• SPAP

If this parameter is omitted, the trace table is not activated by the OPTIONS statement; instead, it can be activated and deactivated by using the online /TRACE command.

STRG= is applicable only to the online system.

Restriction: The STRG trace is not allowed in a batch environment. If this trace is requested in a batch environment, the request is ignored.

SUBS=

Activates an IMS trace. SUBS traces the connection and disconnection of Db2 for z/OS subsystems to the IMS control region. No default value exists. If this parameter is omitted, the trace is not activated by the OPTIONS statement. It can be activated and deactivated by using the online /TRACE command.

Restriction: The SUBS trace is not allowed in batch environments. If this trace is requested in either of these environments, the request is ignored.

Related reading: For additional information about the traces that you can define using these keywords, see IMS Version 15.4 System Utilities.