A CICS® Resource that describes a program in an active CICS system being managed by CICSPlex® SM.
The Primary key field for this resource class 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.
These actions require no unique parameter data.
Note:
The CVDA value returned by CICS for the attribute APIST(CICSAPI)
conflicts with an existing CVDA value. In order 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.
Note:
- External resource name
- CICSProgram
- Length
- 792
- Usage
- API or WUI or CICS Management Client Interface or EVALDEF
- API view
- Yes
- CMAS context
- No
- SCOPE applies
- Yes
- Only query CMASs in workload
- No
- Object type
- CICS Resource
- Copybook identifier
- EYUt0017
| Operations | Actions | Parameters | Required |
|---|---|---|---|
| GET | None | N/A | |
| SET | None | N/A | |
| PERFORM SET | DISABLE | None | N/A |
| DISCARD | None | N/A | |
| ENABLE | None | N/A | |
| NEWCOPY | None | N/A | |
| PHASEIN | None | N/A | |
| RELEASE | None | N/A |
| Name | Datatype | Source | Len | Sum | Set | Description | Default | Get Invalid | Set Invalid | Attr ID |
|---|---|---|---|---|---|---|---|---|---|---|
| EYU_CICSNAME | CHAR | CPSM | 8 | DIF | No | CICS System Name | ||||
| EYU_CICSREL | CHAR | CPSM | 4 | DIF | No | CICS Release | ||||
| EYU_RESERVED | CHAR | CPSM | 4 | N/A | No | Reserved | ||||
| ALOADTIME | INT16US | CPSM | 4 | AVG | No | Average load time | 37 | |||
| APIST | CVDAS | INQ | 4 | LIKE | No | API status | 45 | |||
| APIST Output valid values | CICSAPI, OPENAPI | |||||||||
| APPLICATION | CHAR | INQ | 64 | LIKE | Yes | Application Name | E640 E650 E660 E670 | 60 | ||
| APPLMAJORVER | BINARY | INQ | 4 | MAX | Yes | Major Version | E640 E650 E660 E670 | 63 | ||
| APPLMICROVER | BINARY | INQ | 4 | MAX | Yes | Micro Version | E640 E650 E660 E670 | 65 | ||
| APPLMINORVER | BINARY | INQ | 4 | MAX | Yes | Minor Version | E640 E650 E660 E670 | 64 | ||
| BASDEFINEVER | BINARY | CPSM | 1 | AVG | Yes | BAS resource definition version | 0 | E640 E650 | 57 | |
| CEDFSTATUS | CVDAS | INQ | 4 | LIKE | Yes | CEDF status | 14 | |||
| CEDFSTATUS Input/output valid values | CEDF, NOCEDF | |||||||||
| CEDFSTATUS Output valid values | NOTAPPLIC | |||||||||
| CHANGEAGENT | CVDAS | INQ | 4 | LIKE | No | Last modification agent | E640 E650 | 49 | ||
| CHANGEAGENT Input/output valid values | CSDAPI, CSDBATCH, DREPAPI, DREPBATCH, SYSTEM, AUTOINSTALL, CREATESPI, NOTAPPLIC | |||||||||
| CHANGEAGREL | CHAR | INQ | 4 | DIFF | No | Last modification agent release | E640 E650 | 50 | ||
| CHANGETIME | DATETIME | INQ | 8 | MAX | No | Last modification time | E640 E650 | 52 | ||
| CHANGEUSRID | CHAR | INQ | 8 | DIFF | No | Last modification user ID | E640 E650 | 48 | ||
| COBOLTYPE | CVDAS | INQ | 4 | LIKE | No | COBOL type | 23 | |||
| COBOLTYPE Output valid values | COBOL, COBOLII, NOTINIT, NOTAPPLIC | |||||||||
| CONCURRENCY | CVDAS | INQ | 4 | LIKE | No | Concurrency option | 30 | |||
| CONCURRENCY Output valid values | THREADSAFE, QUASIRENT, REQUIRED | |||||||||
| COPY | CVDAS | INQ | 4 | LIKE | Yes | Newcopy required status | 28 | |||
| COPY Input valid values | NEWCOPY, PHASEIN | |||||||||
| COPY Output valid values | REQUIRED, NOTREQUIRED | |||||||||
| CURRENTLOC | EYUDA | STAT | 4 | LIKE | No | CICS DSA in which current copy is located | 27 | |||
| CURRENTLOC Output valid values | NOCOPY, DSA, CDSA, UDSA, LPA, EDSA, ECDSA, EUDSA, ERDSA, ELPA, ESDSA, RDSA, SDSA | |||||||||
| DATALOCATION | CVDAS | INQ | 4 | LIKE | No | Data location | 16 | |||
| DATALOCATION Output valid values | BELOW, ANY, NOTAPPLIC | |||||||||
| DEFINESOURCE | CHAR | INQ | 8 | DIFF | No | Source of the resource definition | E640 E650 | 53 | ||
| DEFINETIME | DATETIME | INQ | 8 | MAX | No | Creation time | E640 E650 | 54 | ||
| DYNAMSTATUS | CVDAS | INQ | 4 | LIKE | No | Dynamic routing type | 29 | |||
| DYNAMSTATUS Output valid values | DYNAMIC, NOTDYNAMIC | |||||||||
| ENTRYPOINT | ADDRESS | INQ | 4 | MAX | No | Program entry point | 21 | |||
| EXECKEY | CVDAS | INQ | 4 | LIKE | No | Program execution key | 19 | |||
| EXECKEY Output valid values | CICSEXECKEY, USEREXECKEY, NOTAPPLIC | |||||||||
| EXECUTIONSET | CVDAS | INQ | 4 | LIKE | Yes | API subset restriction type | 20 | |||
| EXECUTIONSET Input/output valid values | DPLSUBSET, FULLAPI | |||||||||
| EXECUTIONSET Output valid values | NOTAPPLIC | |||||||||
| FETCHCNT | BINARY | STAT | 4 | AVG | No | Number of times program loaded into storage | 7 | |||
| FETCHTIME | INT16US | STAT | 4 | MAX | No | Total time for all program fetches | 17 | |||
| HOLDSTATUS | CVDAS | INQ | 4 | LIKE | No | Hold status | 9 | |||
| HOLDSTATUS Output valid values | HOLD, NOHOLD, NOTAPPLIC | |||||||||
| HOTPOOLING | CVDAS | INQ | 4 | LIKE | Yes | Hot pooling status | E640+ | E640+ | 35 | |
| HOTPOOLING Input/output valid values | HOTPOOL, NOTHOTPOOL | |||||||||
| HOTPOOLING Output valid values | NOTAPPLIC | |||||||||
| INSTALLAGENT | CVDAS | INQ | 4 | LIKE | No | Installation agent | E640 E650 | 51 | ||
| INSTALLAGENT Input/output valid values | CSDAPI, CREATESPI, SYSTEM, AUTOINSTALL, GRPLIST, BUNDLE | |||||||||
| INSTALLTIME | DATETIME | INQ | 8 | MAX | No | Installation time | E640 E650 | 56 | ||
| INSTALLUSRID | CHAR | INQ | 8 | DIFF | No | Installation user ID | E640 E650 | 55 | ||
| JVMCLASS | CHAR | INQ | 255 | DIFF | Yes | Java virtual machine class | 33 | |||
| JVMDEBUG | CVDAS | INQ | 4 | LIKE | Yes | Java virtual machine (JVM) debug status | E610+ | 32 | ||
| JVMDEBUG Input/output valid values | DEBUG, NODEBUG | |||||||||
| JVMPROFILE | CHAR | INQ | 8 | DIFF | Yes | Java virtual machine (JVM) profile name | DFHJVMPR | E680+ | 36 | |
| JVMSERVER | CHAR | INQ | 8 | DIFF | No | Java virtual machine (JVM) server | E640 E650 E660 | 58 | ||
| LANGUAGE | CVDAS | INQ | 4 | LIKE | No | Language | 2 | |||
| LANGUAGE Output valid values | COBOL, C, LE370, PLIPL1, ASSEMBLER, NOTDEFINED, NOTAPPLIC, LEVSE, JAVA | |||||||||
| LENGTH | CNUMERIC | INQ | 4 | MAX | No | Program length | 11 | |||
| LIBRARY | CHAR | INQ | 8 | DIFF | Yes | LIBRARY name | E640 | 46 | ||
| LIBRARYDSN | CHAR | INQ | 44 | DIFF | Yes | Load data set name | E640 | 47 | ||
| LOADPOINT | ADDRESS | INQ | 4 | MAX | No | Program load point | 22 | |||
| LPASTAT | CVDAS | INQ | 4 | LIKE | No | Link pack area (LPA) status | 13 | |||
| LPASTAT Output valid values | LPA, NOTLPA, NOTAPPLIC, SVA, NOTSVA | |||||||||
| NEWCOPYCNT | BINARY | STAT | 4 | AVG | No | Number of NEWCOPY requests issued | 3 | |||
| OPERATION | CHAR | INQ | 64 | LIKE | Yes | Operation Name | E640 E650 E660 E670 | 62 | ||
| PGRJUSECOUNT | BINARY | STAT | 4 | AVG | No | Number of times JVM program used since last reset | 44 | |||
| PLATFORM | CHAR | INQ | 64 | LIKE | Yes | Platform Name | E640 E650 E660 E670 | 61 | ||
| PROGRAM-1 | CHAR | INQ | 8 | DIFF | Yes | Program name | 1 | |||
| PROGTYPE | CVDAS | INQ | 4 | LIKE | No | Program type | 15 | |||
| PROGTYPE Output valid values | PROGRAM, MAP, PARTITIONSET | |||||||||
| REMOTENAME | CHAR | INQ | 8 | DIFF | No | Program name in remote system | 24 | |||
| REMOTESYSTEM | CHAR | INQ | 4 | DIFF | No | Remote system name | 25 | |||
| REMOVECNT | BINARY | STAT | 4 | AVG | No | Number of times removed by program compression | 18 | |||
| RESCOUNT | CNUMERIC | INQ | 4 | SUM | No | Number of times program currently accessed | 6 | |||
| RLOADING | RATE3 | CPSM | 8 | AVG | No | Rate of program loading | 39 | |||
| RPLID | BINARY | STAT | 4 | AVG | No | Data set offset number | 12 | |||
| RREMOVAL | RATE3 | CPSM | 8 | AVG | No | Rate of program removal | 40 | |||
| RUNTIME | CVDAS | INQ | 4 | LIKE | Yes | Runtime environment information | 31 | |||
| RUNTIME Input/output valid values | JVM | |||||||||
| RUNTIME Input valid values | NOJVM | |||||||||
| RUNTIME Output valid values | UNKNOWN, LE370, NONLE370, NOTAPPLIC, XPLINK | |||||||||
| RUSE | RATE3 | CPSM | 8 | AVG | No | Rate of program use | 41 | |||
| SHARESTATUS | CVDAS | INQ | 4 | LIKE | Yes | Share status | 10 | |||
| SHARESTATUS Input/output valid values | PRIVATE, SHARED | |||||||||
| SHARESTATUS Output valid values | NOTAPPLIC | |||||||||
| STATUS | CVDAS | INQ | 4 | LIKE | Yes | Enabled status | 8 | |||
| STATUS Input/output valid values | ENABLED, DISABLED | |||||||||
| TRANSID | CHAR | INQ | 4 | DIFF | No | Mirror transaction name for remote attach | 26 | |||
| USEAGELSTAT | BINARY | STAT | 4 | AVG | No | Number of times program was used since last reset | 5 | |||
| USECOUNT | CNUMERIC | INQ | 4 | SUM | No | Total number of times program was executed | 4 | |||
| USEFETCH | AVERAGE3 | CPSM | 8 | AVG | No | Average number of program uses per fetch | 38 | |||
