INQUIRE JOURNALNAME

Retrieve information about the status of the system log and general logs.

Syntax

Warning: System commands are powerful as they provide information about the state of the system and allow changes to be made to it. System commands should be used only by authorized applications and users.

Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).

INQUIRE JOURNALNAME

Conditions: END, ILLOGIC, JIDERR, NOTAUTH

NOHANDLE, RESP, and RESP2 are common options that can be added to all EXEC CICS commands to process error conditions. They are not explicitly included in the command syntax diagram and option descriptions. For information about these common options and EXEC CICS command syntax, see EXEC CICS command format and programming considerations. For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

This command is threadsafe.

Description

The INQUIRE JOURNALNAME command returns information about the journals (including the system log and general logs) on your system.

INQUIRE JOURNALNUM is obsolete and is replaced by INQUIRE JOURNALNAME.

Browsing

You can also browse through all the journal entries in the journal names table on your system by using the browse options (START, NEXT, and END) on INQUIRE JOURNALNAME commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

JOURNALNAME(data-value)

Specifies a 1- to 8-character journal name.

To inquire on journals defined with a numeric identifier in the range 1 – 99, specify journal name DFHJnn, where nn is the journal number.

To inquire on the system log, specify DFHLOG.

STATUS(cvda)

Indicates the status of the journal. CVDA values are as follows:

DISABLED: The journal has been disabled by a CEMT, or EXEC CICS, SET JOURNALNAME(…) command. It cannot be used until it is re-enabled by the STATUS(ENABLED) or ACTION(RESET) options on a SET JOURNALNAME command.
ENABLED: The journal is installed and is available for use.
FAILED: The journal has experienced a log stream failure. It cannot be used until it is re-enabled by the STATUS(ENABLED) or ACTION(RESET) options on a SET JOURNALNAME command, or until after the next CICS restart. The log stream should be deleted from the z/OS® System Logger inventory before being used again.

STREAMNAME(data-area)

Returns the log stream name (LSN) associated with the journal name.

The name can be up to 26 characters in length. Names less than 26 character are padded with trailing blanks (X'40'). If the journal is defined by a journal model that specifies a type of DUMMY or SMF, CICS returns 26 blanks.

TYPE(cvda)

Indicates the type of log stream format. CVDA values are:

DUMMY: Records are not written to any log stream.
MVS: Records are written to a z/OS System Logger log stream.
SMF: Records are written to the z/OS SMF log stream.

Conditions

END

RESP2 values:

2: All authorized resource definitions have been retrieved. All data areas specified on this command are left unchanged.

ILLOGIC

RESP2 values:

1: A START has been given when a browse is already in progress, or a NEXT, or an END, has been given without a preceding START.

JIDERR

RESP2 values:

1: The specified journal name was not found.

NOTAUTH

RESP2 values:

100: The user is not authorized for this command.
101: The user does not have the required access to the specified journal. (Not applicable to INQUIRE JOURNALNAME START, INQUIRE JOURNALNAME NEXT, or INQUIRE JOURNALNAME END commands.)