Programs - PROGRAM

The Programs (PROGRAM) views display information about currently installed programs.

Supplied views

To access from the main menu, click:

CICS operations views > Program operations views > Programs

Table 1. Views in the supplied Programs (PROGRAM) view set
View Notes
Programs

EYUSTARTPROGRAM.DETAIL1

Detailed information about the resource signature.
Programs

EYUSTARTPROGRAM.DETAILED

Detailed information about a selected program.
Programs

EYUSTARTPROGRAM.DISABLE

Disable a program.
Programs

EYUSTARTPROGRAM.DISCARD

Discard a program from the CICS system where it is installed. Note: Programs that have names beginning with DFH are supplied by CICS and cannot be disabled or discarded.
Programs

EYUSTARTPROGRAM.ENABLE

Enable a program.
Programs

EYUSTARTPROGRAM.NEWCOPY

CICS is to use a new copy of the program when the program ceases to be in use by any transaction. (You can determine whether a module is in use from the RESCOUNT option in an INQUIRE PROGRAM command. A value of zero means the program is not in use.) It is possible for CICS to replace the program with the new version during a single transaction, at a point when one use of the program has completed, and a subsequent use has yet to start.

CICS loads the new version from the DFHRPL or dynamic LIBRARY concatenation, or uses an LPA-resident version, depending on the PRIVATE or SHARED options. PRIVATE is the default setting.

Note: NEWCOPY cannot be specified for a program specified with the HOLD option, or for a Java program that runs in a JVM. Use the PERFORM JVMPOOL TERMINATE command to refresh Java programs.

Programs

EYUSTARTPROGRAM.PHASEIN

Load a new copy of the program now for all new transaction requests. CICS continues to use the old copy for all currently running transactions until they have finished (RESCOUNT equal to zero). CICS loads the new version from the DFHRPL or dynamic LIBRARY concatenation or uses an LPA-resident version, depending on the PRIVATE or SHARED options. PRIVATE is the default setting.

Note: PHASEIN cannot be specified for a program specified with the HOLD option, or for a Java program that runs in a JVM. Use the PERFORM JVMPOOL TERMINATE command to refresh Java programs.

PHASEIN performs a REFRESH PROGRAM function to inform the loader domain that a new version of the program has been cataloged and that this version of the named program should be used in all future ACQUIRE requests.

Until the program goes to a zero RESCOUNT and a subsequent ACQUIRE PROGRAM has been performed, CEMT INQUIRE PROGRAM ( ) will return information on the first copy of the program.

Programs

EYUSTARTPROGRAM.RELEASE

Release a program previously loaded by a LOAD command. This means that the issuing task can no longer use the resource unless another LOAD is issued.
Programs

EYUSTARTPROGRAM.SET

Set program attributes according to new values specified in input fields.
Programs

EYUSTARTPROGRAM.TABULAR

Tabular information about currently installed programs.

Actions

Table 2. Actions available for PROGRAM views
Action Description
DISABLE Disable a program.
DISCARD Discard a program from the CICS system where it is installed. Note: Programs that have names beginning with DFH are supplied by CICS and cannot be disabled or discarded.
ENABLE Enable a program.
GET (Optional) Specify the name of the platform from which installed programs should be displayed.
NEWCOPY CICS is to use a new copy of the program when the program ceases to be in use by any transaction. (You can determine whether a module is in use from the RESCOUNT option in an INQUIRE PROGRAM command. A value of zero means the program is not in use.) It is possible for CICS to replace the program with the new version during a single transaction, at a point when one use of the program has completed, and a subsequent use has yet to start.

CICS loads the new version from the DFHRPL or dynamic LIBRARY concatenation, or uses an LPA-resident version, depending on the PRIVATE or SHARED options. PRIVATE is the default setting.

Note: NEWCOPY cannot be specified for a program specified with the HOLD option, or for a Java program that runs in a JVM. Use the PERFORM JVMPOOL TERMINATE command to refresh Java programs.

PHASEIN Load a new copy of the program now for all new transaction requests. CICS continues to use the old copy for all currently running transactions until they have finished (RESCOUNT equal to zero). CICS loads the new version from the DFHRPL or dynamic LIBRARY concatenation or uses an LPA-resident version, depending on the PRIVATE or SHARED options. PRIVATE is the default setting.

Note: PHASEIN cannot be specified for a program specified with the HOLD option, or for a Java program that runs in a JVM. Use the PERFORM JVMPOOL TERMINATE command to refresh Java programs.

PHASEIN performs a REFRESH PROGRAM function to inform the loader domain that a new version of the program has been cataloged and that this version of the named program should be used in all future ACQUIRE requests.

Until the program goes to a zero RESCOUNT and a subsequent ACQUIRE PROGRAM has been performed, CEMT INQUIRE PROGRAM ( ) will return information on the first copy of the program.

RELEASE Release a program previously loaded by a LOAD command. This means that the issuing task can no longer use the resource unless another LOAD is issued.
SET Set program attributes according to new values specified in input fields.

Fields

Table 3. Fields in PROGRAM views
Field Attribute name Description
Average load time ALOADTIME The mean time taken for program load requests.
API status APIST Specifies the application programming interface restriction status.
  • CICSAPI - The program is restricted to use of the CICS application programming interfaces. CICS determines whether the program runs on the quasi-reentrant (QR) TCB, or on another TCB. This depends upon the value of the CONCURRENCY attribute in the PROGRAM resource definition. If the program is defined as threadsafe it may run on whichever TCB, in use by CICS at the time, is determined as suitable.
  • OPENAPI - The program is not restricted to the CICS application programming interfaces. CICS executes the program on its own open TCB dependent upon the value of the EXECKEY attribute in the PROGRAM resource definition. If, while executing a CICS command, CICS requires a switch to the QR TCB, it returns to the open TCB before handing control back to the application program. OPENAPI requires the program to be coded to threadsafe standards and be defined with CONCURRENCY(REQUIRED).
Application Name APPLICATION The application name of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.
Major Version APPLMAJORVER The major version number of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.
Micro Version APPLMICROVER The micro version number of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.
Minor Version APPLMINORVER The minor version number of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.
BAS resource definition version BASDEFINEVER The BAS version number of this definition.
CEDF status CEDFSTATUS The CEDF status of the program, which determines whether or not CEDF actions are enabled (CEDF or NOCEDF). A value of NOTAPPLIC is returned for remote programs, maps and partition sets.

Input Values: CEDF, NOCEDF

Last modification agent CHANGEAGENT The change agent identifier that made the last modification.
  • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CSDBATCH - The resource was last changed by a DFHCSDUP job.
  • DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
  • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
  • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
  • AUTOINSTALL - The resource was last autoinstalled.
  • DYNAMIC - The resource was last changed dynamically.
  • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
  • NOTAPPLIC - This is not applicable for this resource.
Last modification agent release CHANGEAGREL The CICS release level of the agent that made the last modification to the resource definition.
Last modification time CHANGETIME The local date and time when the definition was last changed.
Last modification user ID CHANGEUSRID The user ID that made the last modification to the resource definition.
COBOL type COBOLTYPE The type of COBOL being used, as one of the following:
  • COBOL - OS/VS COBOL
  • COBOLII - Enterprise COBOL or VS COBOL II
  • NOTINIT - The program is defined as a COBOL program, but it has not yet been loaded, so the type cannot be determined.
  • NOTAPPLIC - The program has been loaded and it is not a COBOL program, or the program has not been loaded and it is not defined as a COBOL program.
Concurrency option CONCURRENCY Specifies the concurrency attribute of the program.
  • QUASIRENT - The program is defined as being quasi-reeentrant, and is able to run only under the CICS QR TCB.
  • THREADSAFE - The program is defined as threadsafe, and is able to run under whichever TCB is in use when the program is given control. This could be either an open TCB or the CICS QR TCB. The program must be coded to threadsafe standards.
  • REQUIRED - The program is required to run on an open TCB. The type of open TCB used depends on the setting of the Application program interface attribute and the language of the program.
    • For Java programs a T8, J8 or J9 is used. J8 and J9 TCBs are obsolete from CICS Transaction Server 5.1 onwards.
    • For C or C++ XPLINK programs an X8 or X9 is used.
    • For Cobol, Pli, non-xplink C and assembler programs if CICSAPI is set, an L8 TCB is always used as CICS services run in CICS key or USER key regardless of the key of the TCB. If OPENAPI is set, then an L8 or an L9 TCB is used dependent upon the execution key of the program.
    The program must be coded to threadsafe standards.
Newcopy required status COPY The COPY status of the program, which determines whether or not a new copy of the program is required. A value of N/A is returned for CICS releases that do not support this field.
CICS DSA in which current copy is located CURRENTLOC The location of that copy of the program that is currently resident in storage, if any (CDSA, LPA, ECDSA, EUDSA, ERDSA, ELPA, UDSA, ESDSA, RDSA, or SDSA). A value of NOCOPY means no copy of the program is currently loaded.
Data location DATALOCATION Indicates whether the program can accept data addresses higher than 16MB:
  • ANY - Can accept an address above 16MB.
  • BELOW - Requires an address below 16MB.
  • NOTAPPLIC - This option is not available; the program is defined as remote, is a map set, or is a partition set.
Source of the resource definition DEFINESOURCE The source of the definition, depending on which agent made the last change.
Creation time DEFINETIME The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
Dynamic routing type DYNAMSTATUS The DYNAMIC routing status of the program. If DYNAMIC then it can be dynamically routed by the CICS dynamic routing exit. If NOTDYNAMIC then it cannot be routed by the CICS dynamic routing exit.
Program entry point ENTRYPOINT The entry point address of the most recently loaded copy of the program.

The high order bit of the address (hexadecimal 80) is set on if the program is defined with AMODE=31. A value of FF000000 means the program is not currently in use, or is a remote program, or is a Java program that runs in a JVM.

Program execution key EXECKEY The access key in which the program is executing:
  • CICSEXECKEY - The program executes in CICS key and has read and write access to both CICS-key and user-key storage.
  • USEREXECKEY. - The program executes in user key and has write access to user-key storage, but read-only access to CICS key storage.
  • NOTAPPLIC - This option is not available; either the program is defined as remote, or it is a map set or partition set.
API subset restriction type EXECUTIONSET Indicates whether the program is restricted to the API subset when running in the local CICS system:
  • DPLSUBSET - The program is restricted to the same subset of the CICS API that applies when it is linked to by a distributed program link (DPL) request.
  • FULLAPI - The program is not restricted to the DPL subset of the CICS API; it can use the full API.
  • NOTAPPLIC - This option is not available; either the program is defined as remote, or it is a map set or partition set.
Input Values: DPLSUBSET, FULLAPI
Number of times program loaded into storage FETCHCNT The number of times a copy of the program was loaded from the DFHRPL or LIBRARY concatenation into storage during the current CICS statistics interval.
Total time for all program fetches FETCHTIME The total time taken to perform all fetches of the program during the current CICS statistics interval.
Hold status HOLDSTATUS Indicates whether a copy of the program is currently loaded with the HOLD option (HOLD or NOHOLD). A value of NOTAPPLIC means either the program is not currently loaded, or it is a remote program.
Hot pooling status HOTPOOLING The HOTPOOLING option is obsolete.
Installation agent INSTALLAGENT The install agent identifier that made the installation.
  • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
  • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
  • SYSTEM - The resource was last installed by the CICS system.
  • AUTOINSTALL - The resource was autoinstalled.
  • DYNAMIC - The resource was installed dynamically.
  • GRPLIST - The resource was installed by GRPLIST INSTALL.
  • BUNDLE - The resource was installed by a bundle deployment.
Installation time INSTALLTIME The local date and time when the definition was installed.
Installation user ID INSTALLUSRID The user ID that installed the resource definition.
Java virtual machine class JVMCLASS This is the hyperlink to the PROGRAMJ panel, which details the contents of the JVM Class specification, and allows its modification.
Java virtual machine (JVM) debug status JVMDEBUG The JVMDEBUG option is obsolete, and CICS always returns NODEBUG if JVMDEBUG is specified.
Java virtual machine (JVM) profile name JVMPROFILE This is obsolete from CICS TS Version 5 Release 1. The name of the JVM profile. The default value is DFHJVMPR.
Java virtual machine (JVM) server JVMSERVER The name of the JVMSERVER resource used by this PROGRAM.
Language LANGUAGE The language in which the program is written (COBOL, C, PLIPL1 (for PLI or PL1), LE370, LEVSE, ASSEMBLER, or JAVA).

A value of NOTDEFINED is returned if the language was not specified in the resource definition. When the program is eventually loaded, the language is deduced and this value will then be used.

A value of NOTAPPLIC is returned for remote programs, maps and partition sets.

Program length LENGTH The length of the program in bytes. A value of 0 means the program has not been loaded in the current CICS session. A value of N_A means it is a remote program, or a Java program that runs in a JVM.
LIBRARY name LIBRARY The name of the LIBRARY resource from which this program was loaded. This will be blank if the program has not been loaded, or if the LPASTATUS is LPA (indicating that the program has been loaded from the LPA).
Load data set name LIBRARYDSN The name of the data set from which this program was loaded. This will be blank if the program has not been loaded, or if the LPASTATUS is LPA (indicating that the program has been loaded from the LPA).
Program load point LOADPOINT The load address of the most recently loaded copy of the program. A value of FF000000 means the program is not currently in use, or is a Java program that runs in a JVM.
Link pack area (LPA) status LPASTAT Indicates where the most recently loaded copy of the program was taken from:
  • LPA - CICS used a version in either the link pack area (LPA) or the extended link pack area (ELPA).
  • NOTLPA - CICS used a private version.
  • NOTAPPLIC - CICS has not used an LPA version, or a private version of the program.
Number of NEWCOPY requests issued NEWCOPYCNT The number of times a NEWCOPY request has been issued against this program during the current CICS statistics interval.
Operation Name OPERATION The name of the application operation for which this program is defined as an entry point. If this field is not set, this program is not defined as an entry point but may still be part of an application.
Number of times JVM program used since last reset PGRJUSECOUNT If this program is a Java program, the number of times it was accessed during the current CICS statistics interval.
Platform Name PLATFORM The platform name of the application for which this program is defined. If the OPERATION field is set, this program is defined as an entry point.
Program name PROGRAM The name of the program.
Program type PROGTYPE The type of program, as one of the following:
  • MAP - A map set.
  • PARTITION - A partition set.
  • PROGRAM - An executable program.
Program name in remote system REMOTENAME The name by which the program is known in the remote CICS system, if a remote system was defined. If this field is blank, no remote system was defined.
Remote system name REMOTESYSTEM The name of a remote CICS system to which a link request for this program is shipped. If this field is blank, no remote system was defined.
Number of times removed by program compression REMOVECNT The number of times a copy of this program has been removed from storage by the Dynamic Program Storage Compression (DPSC) facility during the current CICS statistics interval.
Number of times program currently accessed RESCOUNT The number of separate invocations of this program that are currently taking place. A value of N/A means it is a remote program, or a Java program that runs in a JVM.
Program residency RESIDENCY The residence status of the program, indicating whether or not the program is permanently resident in virtual storage once loaded.
Rate of program loading RLOADING The rate at which the program is loaded.
Data set offset number RPLID The offset into the DFHRPL DD program library concatenation.

Note: The offset values begin with zero for the first partitioned data set in the concatenation.

Rate of program removal RREMOVAL The rate at which the program is removed.
Runtime environment information RUNTIME Specifies information about the Runtime environment for a program. Users may SET values of:
  • JVM - The program is a Java program that will run in a Java Virtual Machine.
  • NOJVM - The program will execute as a CICS application outside the JVM environment.
If a value of NOJVM is specified, then this will be resolved to one of the following reported settings, based on the current application state:
  • LE370 - The program will run with LE370 runtime support.
  • NONLE370 - The program will run with a language specific runtime environment.
  • UNKNOWN - The program environment is unknown due to the fact that the program has not been loaded by CICS, and so its source language cannot be deduced.
  • XPLINK - The program is a C or C++ program which has been compiled using the XPLINK option.
  • NOTAPPLIC - RUNTIME does not apply because the module is a map set, or a partition set. Note that the above values cannot be directly set. They are reported only as a result of a NOJVM value being specified.
Rate of program use RUSE The rate at which the program is used.
Share status SHARESTATUS The shared status of the program, which determines whether the next new copy loaded will be a shared version (SHARED) or a private version (PRIVATE). A value of NOTAPPLIC is returned for remote programs, or Java programs that run in a JVM.

Input Values: SHARED, PRIVATE

Enabled status STATUS The enabled status of the program, which indicates whether it is available for use.

Input Values: ENABLED, DISABLED

Mirror transaction name for remote attach TRANSID The name of the server transaction the remote system is to attach when the program is defined as remote or dynamic. If this field is blank, the program is not defined as remote.
Number of times program was used since last reset USEAGELSTAT The number of times access to the program was requested during the current CICS statistics interval.
Total number of times program was executed USECOUNT The total number of times the program has been executed in the current CICS session. For CICS TS 3.2 and later regions, this field shows a use count for Java programs as well as for other types of program. For earlier regions, Java programs do not have a use count in this field. A value of N/A is returned for remote programs.
Average number of program uses per fetch USEFETCH The average number of program uses per fetch.


eyua3ui.html | Timestamp icon Last updated: Sunday, 4 June 2017