The INQUIRE_SYSTEM call

The INQUIRE_SYSTEM call gives you access to CICS® system data in the AP domain.

INQUIRE_SYSTEM

  DFHSAIQX [CALL,]
     [CLEAR,]
     [IN,
     FUNCTION(INQUIRE_SYSTEM),
     [GMMTEXT(name4),]]
     [OUT,
     [CICSREL(name4 | *),]
     [CICSSTATUS(ACTIVE | FINALQUIESCE |
                      FIRSTQUIESCE| INITIALIZING),]
     [CICSSYS(name1 | *),]
     [CICTSLEVEL(name6 | *),]
     [COLDSTATUS(COLD | INITIAL | NOTCOLD),]
     [CWA(name4 | (Rn) | *),]
     [CWALENGTH(name2 | *),]
     [DATE(name4|*),]
     [DTRPRGRM(name8 | *),]
     [GMMLENGTH(name2 | *),]
     [GMMTRANID(name4 | *),]
     [INITSTATUS(FIRSTINIT | INITCOMPLETE | SECONDINIT |
                      THIRDINIT),]
     [JOBNAME(name8 | *),]
     [MESSAGECASE(UPPER | MIXED),]
     [MVSSMFID(name4 | *),]
     [MVSSYSNAME(name8 | *),]
     [OPREL(name2 | *),]
     [OPSYS(name1 | *),]
     [OSLEVEL(name4 | *),]
     [PLTPI(name2 | *),]
     [SDTRAN(name4 | *),]
     [SECURITYMGR(EXTSECURITY | NOSECURITY),]
     [SHUTSTATUS(CONTROLSHUT | NOTSHUTDOWN | SHUTDOWN),]
     [STARTUP(COLDSTART | EMERGENCY | WARMSTART),]
     [STARTUPDATE(name4| *),]
     [TERMURM(name8 | *),]
     [TIMEOFDAY(name4| *),]
     [XRFSTATUS(NOXRF | PRIMARY | TAKEOVER),]
     RESPONSE (name1 | * ),
     REASON (name1 | * )]

This command is threadsafe.

CICSREL(name4 | *)

returns the level number of the CICS code under which the CICS region is running.

name4: The name of a 4-byte location that is to receive the level number characters as hexadecimal values.

CICSSTATUS(ACTIVE|FINALQUIESE|FIRSTQUIESCE|INITIALIZING)

returns the status of the CICS region.

ACTIVE: The CICS region is active and ready to receive work.
FINALQUIESCE: The CICS region is shutting down, and is in the final stage of quiescing.
FIRSTQUIESCE: The CICS region is shutting down, and is in the first stage of quiescing.
INITIALIZING: The CICS region is initializing.

CICSSYS(name1 | *)

returns the operating system for which the running CICS has been built.

name1: The name of a 1-byte area that is to receive the hexadecimal character of the operating system. A value of X represents MVS.

CICSTSLEVEL(name6 | *)

returns the release of CICS Transaction Server under which CICS is running.

name6: The name of a 6-byte area that is to receive the release characters as hexadecimal values.

COLDSTATUS(COLD|INITIAL|NOTCOLD)

returns a CVDA value that indicates whether CICS performed a cold start or an initial start.

The CVDA values are as follows:

COLD: CICS performed a cold start. Log information about local resources was erased, but information about the outcome of local units of work, needed to allow remote systems or RMI-connected resource managers to resynchronize their resources, was preserved.
INITIAL: CICS performed an initial start. All log information about both local and remote resources was erased.
NOTCOLD: CICS performed neither a cold nor an initial start.

CWA(name4 | (Rn) | *)

returns the address of the common work area.

name4: The name of a 4-byte field that is to receive the address of the CWA.
(Rn): A register to receive the address of the CWA.

CWALENGTH(name2 | *)

returns the length in bytes of the CWA.

name2: The name of a 2-byte field that is to receive the length of the CWA.

DATE(name4 | *)

returns today's date in packed-decimal form—4-bytes 0Cyyddds, where:

Cis a century indicator. (0=1900, 1=2000, 2=2100, and so on.)
yy=years.
ddd=days.
s is the sign.

name4: The name of a 4-byte location that is to receive the date.

DTRPRGRM(name8 | *)

returns the name of the dynamic routing program.

name8: The name of an 8-byte area that is to receive the name of the dynamic routing program.

GMMLENGTH(name2 | *)

returns the length in bytes of the good morning message.

name2: The name of a 2-byte area that is to receive the length of the good morning message.

GMMTEXT(name4)

specifies the address of an area of storage, at least 244 bytes in length and owned by the caller, into which CICS is to return the good morning message.

name4: The address of an area of storage that is to receive the good morning message.

Note: The GMMTEXT parameter must follow the IN statement as an input parameter.

GMMTRANID(name4 | *)

returns the transaction identifier of the CICS good morning transaction.

name4: The name of a 4-byte area that is to receive the CICS good morning transaction id.

INITSTATUS(FIRSTINIT|INITCOMPLETE|SECONDINIT|THIRDINIT)

returns a value indicating the stage reached during CICS initialization.

FIRSTINIT: The first stage of CICS initialization.
INITCOMPLETE: CICS initialization is complete.
SECONDINIT: The second stage of CICS initialization. This stage corresponds to the period when first phase PLTPI programs are run; that is those programs in a PLT that are defined before the DFHDELIM statement.
THIRDINIT: The third stage of CICS initialization. This stage corresponds to the period when second phase PLTPI programs are run; that is those programs in a PLT that are defined after the DFHDELIM statement.

JOBNAME(name8 | *)

returns the 8-character MVS™ job name under which the CICS region is running.

name8: The name of a 8-byte area that is to receive the MVS job name.

MESSAGECASE(UPPER|MIXED)

returns a CVDA value that shows how the message domains display mixed case messages, as set by the MSGCASE system initialization parameter. The CVDA values are as follows:

MIXED: All messages that are displayed by the CICS message domain or by the CICSPlex® SM message domain remain in mixed case.
UPPER: The message domain displays all mixed case messages in uppercase only.

MVSSMFID(name4 | *)

returns a 4-byte value that indicates the MVS system identification. This field is copied from the SMCASID field of the SMCA MVS control block.

name4: The name of a 4-byte area to receive the MVS system identification.

MVSSYSNAME(name8 | *)

returns an 8-byte value that indicates the MVS system name. This field is copied from the CVTSNAME field of the MVS CVT control block.

name8: The name of an 8-byte area to receive the MVS system name.

OPREL(name2 | *)

returns the last 2 digits of the level number of the MVS element of z/OS®, under which the CICS region is running.

name2: The name of a 2-byte area that is to receive, as a half-word binary value, the level number of the MVS element of z/OS. For example, z/OS Release 3 MVS is represented by 03.

Note: This field is supported for compatibility purposes only. The information is derived from the last two numbers held in the MVS CVTPRODN field. For example, CVTPRODN holds SP5.2.2 for MVS/ESA SP Version 5 Release 2.2 (in which case OPREL returns 22), and SP6.0.3 for z/OS Release 3. You are recommended to use the OSLEVEL field for the full version and release number of the z/OS product.

OPSYS(name1 | *)

returns the type of operating system on which the CICS regions is running.

name1: The name of a 1-byte area that is to receive the hexadecimal character of the operating system on which CICS is running. A value of X represents MVS.

OSLEVEL(name4 | *)

is the version, release, and modification level of the z/OS product on which CICS is running.

name1: The name of a 4-byte area that is to receive the version and release number of z/OS on which CICS is running. A value of 0240 represents z/OS Release 4.

PLTPI(name2 | *)

returns the suffix that identifies the program list table (PLT) containing the list of programs to be run during CICS initialization—the program list table post initialization (PLTPI) list.

name2: The name of a 2-byte area that is to receive the suffix.

SDTRAN(name4 | *)

returns the name of the “shutdown assist” transaction to be run at the beginning of normal or immediate shutdown. The shutdown assist transaction is described in The shutdown assist utility program, DFHCESD.

name4: The name of a 4-byte area to receive the name.

SECURITYMGR(EXTSECURITY|NOSECURITY)

returns a value indicating whether security is active.

EXTSECURITY: CICS is using an external security manager (for example, RACF®).
NOSECURITY: Security is not in use in the CICS region—SEC=NO is specified as a system initialization parameter.

SHUTSTATUS(CONTROLSHUT|NOTSHUTDOWN|SHUTDOWN)

returns the shutdown status of the CICS region.

CONTROLSHUT: CICS is performing a controlled shutdown; that is, a normal shutdown with a warm keypoint.
NOTSHUTDOWN: CICS is not in shutdown mode.
SHUTDOWN: CICS is performing an immediate shutdown.

STARTUP(COLDSTART|EMERGENCY|WARMSTART)

returns the type of startup the CICS region performed.

COLDSTART: CICS performed a cold start, either because this was explicitly specified on the system initialization parameter, or because CICS forced a cold start because of the state of the global catalog.
EMERGENCY: CICS performed an emergency restart because the previous run did not shut down normally with a warm keypoint.
WARMSTART: CICS performed a warm restart following the normal shutdown of the previous run.

STARTUPDATE(name4 | *)

returns the start-up-date of this CICS region, in packed decimal form (4-bytes 00yydddc where yy=years, ddd=days, c is the sign).

name4: The name of a 4-byte location that is to receive the startup date of this CICS system.

TERMURM(name8 | *)

returns the name of the autoinstall user program for terminals.

name8: The name of an 8-byte area that is to receive the name of the autoinstall user program for terminals.

TIMEOFDAY(name4 | *)

returns the current time-of-day in packed decimal form (4-bytes hhmmsstc where hh=hours, mm=minutes, ss=seconds, t=tenths of a second, and c is the sign).

name4: The name of a 4-byte location that is to receive the time.

XRFSTATUS(NOXRF|PRIMARY|TAKEOVER)

returns the XRF status of the CICS region.

NOXRF: CICS was started with the system initialization parameter XRF=NO specified. XRF is not active.
PRIMARY: The CICS region was started as an active CICS in an XRF environment.
TAKEOVER: The CICS region was started as an alternate CICS, with the START=STANDBY system initialization parameter.

RESPONSE and REASON values for INQUIRE_SYSTEM

RESPONSE	REASON
OK	None
INVALID	INVALID_FUNCTION
EXCEPTION	LENGTH_ERROR
	UNKNOWN_DATA
DISASTER	INQ_FAILED
PURGED	None