PGDD gate, DEFINE_PROGRAM function
The DEFINE_PROGRAM function of the PGDD gate is used to define a program resource.
Input Parameters
- APPLICATION_ID
- Optional parameter
- The 64-character name of the application associated with the task.
- APPL_MAJOR_VER
- Optional parameter
- The fullword binary value that is the major version of the application associated with the task.
- APPL_MINOR_VER
- Optional parameter
- The fullword binary value that is the minor version of the application associated with the task.
- APPL_MICRO_VER
- Optional parameter
- The fullword binary value that is the micro version of the application associated with the task.
- CATALOG_ADDRESS
- The token that identifies the program resource to be defined.
- INSTALL_TYPE
- Indicates how the program resource is defined and installed.
- Values for the parameter are as follows:
- AUTO
- CATALOG
- GROUPLIST
- MANUAL
- RDO
- SYSAUTO
- PLATFORM_ID
- Optional parameter
- The 64-character name of the platform associated with the task.
- PROGRAM_NAME
- The name of the program resource to be defined.
- AVAIL_STATUS
- Optional Parameter
- Defines whether the program can be used (ENABLED) or not (DISABLED).
- Values for the parameter are as follows:
- DISABLED
- ENABLED
- CEDF_STATUS
- Optional Parameter
- Indicates whether the EDF diagnostic screens are displayed when the program is running under the control of the execution diagnostic facility (EDF).
- Values for the parameter are as follows:
- CEDF
- NOCEDF
- CONCURRENCY
- Optional Parameter
- Indicates whether the program is threadsafe or only quasi-reentrant.
- Values for the parameter are as follows:
- QUASIRENT
- THREADSAFE
- DATA_LOCATION
- Optional Parameter
- Defines whether the program can handle only 24-bit addresses (data located below the 16 MB line) or can also handle 31-bit addresses (data located above or below the 16 MB line). The DATALOCATION options are independent from the addressing mode of the link-edited program.
- Values for the parameter are as follows:
- ANY
- BELOW
- DYNAMIC_STATUS
- Optional Parameter
- Indicates whether a request to LINK to the program can be dynamically routed.
- Values for the parameter are as follows:
- DYNAMIC
- NOTDYNAMIC
- EXECUTION_KEY
- Optional Parameter
- The key in which CICS® gives control to the program, and that determines whether the program can modify CICS-key storage. If the program is link-edited with the RENT attribute and the RMODE(ANY) mode statement, CICS loads the program into the extended read-only DSA (ERDSA), regardless of the EXECKEY option. The ERDSA is allocated from read-only extended storage only if RENTPGM=PROTECT is specified as a system initialization parameter.
- Values for the parameter are as follows:
- CICS
- USER
- EXECUTION_SET
- Optional Parameter
- Indicates whether you want CICS to link to and run the program as if it were running in a remote CICS region (with or without the API restrictions of a DPL program).
- Values for the parameter are as follows:
- DPLSUBSET
- FULLAPI
- HOTPOOL
- Optional Parameter
- Indicates whether the Java™ program object is to be run in a preinitialized Language Environment® enclave reused by multiple invocations of the program, under control of an H8 TCB. This parameter is obsolete and is ignored.
- Values for the parameter are as follows:
- NO
- YES
- JVM
- Optional Parameter
- Indicates whether the program is to be executed under the control of a JVM (Java Virtual Machine).
- Values for the parameter are as follows:
- NO
- YES
- JVM_CLASS
- Optional Parameter
- The name of the main class in a Java program to be run under the control of a JVM.
- JVM_PROFILE
- Optional Parameter
- Specifies the name of the data set member that contains the JVM profile. The named profile provides the attributes of the JVM that are needed to run the program.
- LANGUAGE_DEFINED
- Optional Parameter
- The language to be defined for the program.
- Values for the parameter are as follows:
- ASSEMBLER
- COBOL
- C370
- LE370
- NOT_DEFINED
- PLI
- MODULE_TYPE
- Optional Parameter
- The type of program resource to be defined.
- Values for the parameter are as follows:
- MAPSET
- PARTITIONSET
- PROGRAM
- MULTITCB
- Optional Parameter
- Reserved for future use.
- Values for the parameter are as follows:
- NO
- YES
- OPENAPI
- Optional Parameter
- Reserved for future use.
- Values for the parameter are as follows:
- NO
- YES
- PROGRAM_ATTRIBUTE
- Optional Parameter
- Defines the residence status of the program, and when the storage for this program is released.
- Values for the parameter are as follows:
- RELOAD
- RESIDENT
- REUSABLE
- TEST
- TRANSIENT
- PROGRAM_TYPE
- Optional Parameter
- The type of program.
- Values for the parameter are as follows:
- PRIVATE
- SHARED
- TYPE_ANY
- PROGRAM_USAGE
- Optional Parameter
- Defines whether the program is to be used as a CICS nucleus program, or as a user application program.
- Values for the parameter are as follows:
- APPLICATION
- NUCLEUS
- REMOTE_PROGID
- Optional Parameter
- The name by which the program is known in the remote CICS region. If you specify REMOTE_SYSID and omit REMOTE_PROGID, the REMOTE_PROGID parameter defaults to the same name as the local name (that is, the PROGRAM_NAME value).
- REMOTE_SYSID
- Optional Parameter
- The name of a remote CICS region if you want CICS to ship a distributed program link (DPL) request to another CICS region.
- REMOTE_TRANID
- Optional Parameter
- The name of the transaction you want the remote CICS to attach, and under which it is to run the remote program.
- REQUIRED_AMODE
- Optional Parameter
- The addressing mode of the program.
- Values for the parameter are as follows:
- AMODE_ANY
- 24
- 31
- 64
- REQUIRED_RMODE
- Optional Parameter
- The residence mode of the program.
- Values for the parameter are as follows:
- RMODE_ANY
- 24
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- CATALOG_ERROR
- CATALOG_NOT_OPERATIONAL
- INSUFFICIENT_STORAGE
- LOCK_ERROR
- The following values are returned when RESPONSE is EXCEPTION:
- PROGRAM_ALREADY_DEFINED
- PROGRAM_HAS_HOTPOOL
- PROGRAM_IN_USE
- The following values are returned when RESPONSE is INVALID:
- INVALID_CATALOG_ADDRESS
- INVALID_MODE_COMBINATION
- INVALID_PROGRAM_NAME
- INVALID_TYPE_ATTRIB_COMBIN
- The values for the parameter are as follows:
- NO_REASON
- NEW_PROGRAM_TOKEN
- The token assigned to program.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.