PROGRAM Resource Table

A CICS® Resource that describes a program in an active CICS system being managed by CICSPlex® SM.

The First key field for this resource is PROGRAM.

The following actions are supported:
DISABLE
Disable the program.
DISCARD
Remove the installed program.
ENABLE
Enable the program.
NEWCOPY
Load a new copy of the program.

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.

PHASEIN
CICS will use a new copy of the program for all new transaction requests. CICS continues to use the old copy for all currently running transactions until they have finished, and have a RESCOUNT value of 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.
RELEASE
Release a program that is previously loaded by a LOAD command. Therefore, the issuing task can no longer use the resource unless another LOAD is issued.
Note:
  1. The PLATFORM, APPLICATION, APPLMAJORVER, APPLMINORVER, and APPLMICROVER parameters are all required when the GET operation is in the context of an application that is deployed on a platform.
  2. The CVDA value returned by CICS for the attribute APIST(CICSAPI) conflicts with an existing CVDA value. To retain the attribute's uniqueness, CICSPlex SM adds 8000 to the value returned by CICS. For more information about translating CVDA values, see TRANSLATE command.

External resource name(CMCI)
CICSProgram
Object type
CICS Resource
Length
800
Usage
API, WUI, CICS Management Client Interface(CMCI), EVALDEF
API view
Yes
CMAS context
No
SCOPE applies
Yes
Only query CMASs in workload
No
Copybook identifier
EYUt0017
Security Class
OPERATE.PROGRAM
CICS Commands subject to CICS Security
INQUIRE
INQUIRE PROGRAM
Unsupported CICS Releases
None
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   APPLICATION(value) No
    APPLMAJORVER(value) No
    APPLMICROVER(value) No
    APPLMINORVER(value) No
    PLATFORM(value) No
SET   None N/A
PERFORM SET, PERFORM OBJECT DISABLE None N/A
  DISCARD None N/A
  ENABLE None N/A
  NEWCOPY None N/A
  PHASEIN None N/A
  RELEASE None N/A
Table 2. PROGRAM FEEDBACK error codes
Value Code Description
1 PROGRAM_INCOMP_APPLCON Incomplete application qualifier
Table 3. PROGRAM resource table attributes
Name Datatype Source CICS Source CICS Field Len Sum Set Description Default Get Invalid Set Invalid GraphQL Field
EYU_CICSNAME CHAR CPSM     8 DIFF No CICS System Name       regionName
EYU_CICSREL CHAR CPSM     4 DIFF No CICS Release       CICSRelease
EYU_RESERVED CHAR CPSM     4 N/A No Reserved        
 PROGRAM-1  CHAR INQ   Calculated 8 DIFF No Program name       name
ALOADTIME INT16US CPSM   Calculated 4 AVG No Average load time       averageLoadTime
APIST CVDAS INQ PROGRAM APIST 4 LIKE No API status       APIStatus
APIST Output valid values
  • CICSAPI
  • OPENAPI
APPLICATION CHAR INQ PROGRAM APPLICATION 64 DIFF No Application Name       applicationName
APPLMAJORVER BINARY INQ PROGRAM APPLMAJORVER 4 MAX No Major Version       majorVersion
APPLMICROVER BINARY INQ PROGRAM APPLMICROVER 4 MAX No Micro Version       microVersion
APPLMINORVER BINARY INQ PROGRAM APPLMINORVER 4 MAX No Minor Version       minorVersion
BASDEFINEVER BINARY CPSM   Calculated 1 AVG No BAS resource definition version 0     basdefinever
CEDFSTATUS CVDAS INQ PROGRAM CEDFSTATUS 4 LIKE Yes CEDF status       CEDFStatus
CEDFSTATUS Input/output valid values
  • CEDF
  • NOCEDF
CEDFSTATUS Output valid values
  • NOTAPPLIC
CHANGEAGENT CVDAS INQ PROGRAM CHANGEAGENT 4 LIKE No Last modification agent       changeAgent
CHANGEAGENT Input/output valid values
  • CSDAPI
  • CSDBATCH
  • DREPAPI
  • OVERRIDE
  • DREPBATCH
  • SYSTEM
  • AUTOINSTALL
  • DYNAMIC
  • CREATESPI
  • NOTAPPLIC
  • N_A
CHANGEAGREL CHAR INQ PROGRAM CHANGEAGREL 4 DIFF No Last modification agent release       changeAgentRelease
CHANGETIME DATETIME INQ PROGRAM CHANGETIME 8 MAX No Last modification time       changeTime
CHANGEUSRID CHAR INQ PROGRAM CHANGEUSRID 8 DIFF No Last modification user ID       changeUserID
COBOLTYPE CVDAS INQ PROGRAM COBOLTYPE 4 LIKE No COBOL type       COBOLType
COBOLTYPE Output valid values
  • COBOL
  • COBOLII
  • NOTINIT
  • NOTAPPLIC
CONCURRENCY CVDAS INQ PROGRAM CONCURRENCY 4 LIKE No Concurrency option       concurrency
CONCURRENCY Output valid values
  • THREADSAFE
  • QUASIRENT
  • REQUIRED
COPY CVDAS INQ PROGRAM COPY 4 LIKE Yes Newcopy required status       newcopyStatus
COPY Input valid values
  • NEWCOPY
  • PHASEIN
COPY Output valid values
  • REQUIRED
  • NOTREQUIRED
CURRENTLOC EYUDA STAT DFHLDRDS LDRLOCN 4 LIKE No CICS DSA in which current copy is located       currentLocation
CURRENTLOC Output valid values
  • NOCOPY
  • DSA
  • CDSA
  • UDSA
  • LPA
  • EDSA
  • ECDSA
  • EUDSA
  • ERDSA
  • ELPA
  • ESDSA
  • RDSA
  • SDSA
  • PCDSA
  • EPCDSA
  • PUDSA
  • EPUDSA
DATALOCATION CVDAS INQ PROGRAM DATALOCATION 4 LIKE No Data location       dataLocation
DATALOCATION Output valid values
  • BELOW
  • ANY
  • NOTAPPLIC
DEFINESOURCE CHAR INQ PROGRAM DEFINESOURCE 8 DIFF No Source of the resource definition       defineSource
DEFINETIME DATETIME INQ PROGRAM DEFINETIME 8 MAX No Creation time       defineTime
DYNAMSTATUS CVDAS INQ PROGRAM DYNAMSTATUS 4 LIKE No Dynamic routing type       routingType
DYNAMSTATUS Output valid values
  • DYNAMIC
  • NOTDYNAMIC
ENTRYPOINT ADDRESS INQ PROGRAM ENTRYPOINT 4 MAX No Program entry point       entryPoint
EXECKEY CVDAS INQ PROGRAM EXECKEY 4 LIKE No Program execution key       executionKey
EXECKEY Output valid values
  • CICSEXECKEY
  • USEREXECKEY
  • NOTAPPLIC
EXECUTIONSET CVDAS INQ PROGRAM EXECUTIONSET 4 LIKE Yes API subset restriction type       executionSet
EXECUTIONSET Input/output valid values
  • DPLSUBSET
  • FULLAPI
EXECUTIONSET Output valid values
  • NOTAPPLIC
FETCHCNT BINARY STAT DFHLDRDS LDRFC 4 AVG No Number of times program loaded into storage       fetchCount
FETCHTIME INT16US STAT DFHLDRDS LDRFT 4 MAX No Total time for all program fetches       fetchTime
HOLDSTATUS CVDAS INQ PROGRAM HOLDSTATUS 4 LIKE No Hold status       holdStatus
HOLDSTATUS Output valid values
  • HOLD
  • NOHOLD
  • NOTAPPLIC
HOTPOOLING CVDAS INQ     4 LIKE Yes Hot pooling status   E640+ E640+ hotPooling
HOTPOOLING Input/output valid values
  • HOTPOOL
  • NOTHOTPOOL
HOTPOOLING Output valid values
  • NOTAPPLIC
INSTALLAGENT CVDAS INQ PROGRAM INSTALLAGENT 4 LIKE No Installation agent       installAgent
INSTALLAGENT Input/output valid values
  • CSDAPI
  • CREATESPI
  • SYSTEM
  • AUTOINSTALL
  • DYNAMIC
  • GRPLIST
  • BUNDLE
INSTALLTIME DATETIME INQ PROGRAM INSTALLTIME 8 MAX No Installation time       installTime
INSTALLUSRID CHAR INQ PROGRAM INSTALLUSRID 8 DIFF No Installation user ID       installUserID
JVMCLASS CHAR INQ PROGRAM JVMCLASS 255 DIFF Yes Java virtual machine class       JVMClass
JVMDEBUG CVDAS INQ PROGRAM JVMDEBUG 4 LIKE Yes Java virtual machine (JVM) debug status   E610+    
JVMDEBUG Input/output valid values
  • DEBUG
  • NODEBUG
JVMPROFILE CHAR INQ     8 DIFF Yes Java virtual machine (JVM) profile name DFHJVMPR E680+   JVMProfile
JVMSERVER CHAR INQ PROGRAM JVMSERVER 8 DIFF No Java virtual machine (JVM) server       jvmserver
LANGUAGE CVDAS INQ PROGRAM LANGDEDUCED 4 LIKE No Language       language
LANGUAGE Output valid values
  • COBOL
  • C
  • LE370
  • PLIPL1
  • ASSEMBLER
  • NOTDEFINED
  • NOTAPPLIC
  • LEVSE
  • JAVA
LENGTH CNUMERIC INQ PROGRAM LENGTH 4 MAX No Program length       length
LIBRARY CHAR INQ PROGRAM LIBRARY 8 DIFF No LIBRARY name       library
LIBRARYDSN CHAR INQ PROGRAM LIBRARYDSN 44 DIFF No Load data set name       DSName
LOADPOINT ADDRESS INQ PROGRAM LOADPOINT 4 MAX No Program load point       loadPoint
LPASTAT CVDAS INQ PROGRAM LPASTATUS 4 LIKE No Link pack area (LPA) status       LPAStatus
LPASTAT Output valid values
  • LPA
  • NOTLPA
  • NOTAPPLIC
  • SVA
  • NOTSVA
NEWCOPYCNT BINARY STAT DFHLDRDS LDRTN 4 AVG No Number of NEWCOPY requests issued       newcopyCount
OPERATION CHAR INQ PROGRAM OPERATION 64 DIFF Yes Operation Name       operationName
PGRJUSECOUNT BINARY STAT DFHPGRDS PGR_JVMPROGRAM_USECOUNT 4 AVG No Number of times JVM program used since last reset       JVMUseCount
PLATFORM CHAR INQ PROGRAM PLATFORM 64 DIFF No Platform Name       platformName
PROGTYPE CVDAS INQ PROGRAM PROGTYPE 4 LIKE No Program type       programType
PROGTYPE Output valid values
  • PROGRAM
  • MAP
  • PARTITIONSET
REMOTENAME CHAR INQ PROGRAM REMOTENAME 8 DIFF No Program name in remote system       remoteName
REMOTESYSTEM CHAR INQ PROGRAM REMOTESYSTEM 4 DIFF No Remote system name       remoteSystem
REMOVECNT BINARY STAT DFHLDRDS LDRRPC 4 AVG No Number of times removed by program compression       removeCount
RESCOUNT CNUMERIC INQ PROGRAM RESCOUNT 4 SUM No Number of times program currently accessed       concurrentUseCount
RESIDENCY CVDAS INQ PROGRAM RESIDENCY 4 MAX No Program residency       residency
RESIDENCY Output valid values
  • RESIDENT
  • NONRESIDENT
RLOADING RATE3 CPSM   Calculated 8 AVG No Rate of program loading       loadingRate
RPLID BINARY STAT DFHLDRDS LDRRPLO 4 AVG No Data set offset number       RPLNumber
RREMOVAL RATE3 CPSM   Calculated 8 AVG No Rate of program removal       removalRate
RUNTIME CVDAS INQ PROGRAM RUNTIME 4 LIKE Yes Runtime environment information       runtime
RUNTIME Input/output valid values
  • JVM
RUNTIME Input valid values
  • NOJVM
RUNTIME Output valid values
  • UNKNOWN
  • LE370
  • NONLE370
  • NOTAPPLIC
  • XPLINK
RUSE RATE3 CPSM   Calculated 8 AVG No Rate of program use       useRate
SHARESTATUS CVDAS INQ PROGRAM SHARESTATUS 4 LIKE Yes Share status       shareStatus
SHARESTATUS Input/output valid values
  • PRIVATE
  • SHARED
SHARESTATUS Output valid values
  • NOTAPPLIC
STATUS CVDAS INQ PROGRAM STATUS 4 LIKE Yes Enabled status       status
STATUS Input/output valid values
  • ENABLED
  • DISABLED
TRANSID CHAR INQ PROGRAM TRANSID 4 DIFF No Mirror transaction name for remote attach       mirrorTransaction
USEAGELSTAT BINARY STAT DFHLDRDS LDRTU 4 AVG No Number of times program was used since last reset       intervalUseCount
USECOUNT CNUMERIC INQ PROGRAM USECOUNT 4 SUM No Total number of times program was executed       useCount
USEFETCH AVERAGE3 CPSM   Calculated 8 AVG No Average number of program uses per fetch       usesPerFetch