PGIS gate, SET_PROGRAM function

The SET_PROGRAM function of the PGIS gate is used to set the characteristics of a program when it is loaded.

Input Parameters

PROGRAM_NAME
The name of the program resource to be defined.
PROGRAM_TOKEN
The token that identifies the program to be loaded.
APPLICATION_NAME
Optional parameter
The 64-character name of the application that is to be associated with the program.
AVAIL_STATUS
Optional Parameter
Defines whether the program can be used (ENABLED) or not (DISABLED).
Values for the parameter are as follows:
  • DISABLED
  • ENABLED
BUNDLE_CALLER
Optional Parameter
Defines whether the caller is either the RL client (YES) or a CICS® internal module (CICSOVERRIDE) and therefore allowed to modify the state of a program that is defined in a CICS bundle.
Values for the parameter are as follows:
  • CICSOVERRIDE
  • NO
  • YES
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
ENTRYPOINT_BUN_TOKEN
Optional parameter
An 8-byte token that represents the bundle that defined the application entry point.
ENTRYPOINT_RES_TOKEN
Optional parameter
An 8-byte token that represents the application entry point.
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 extended the 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
JVM
Optional Parameter
Indicates whether the program is to run under the control of a Java™ Virtual Machine (JVM).
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.
MAJOR_VERSION
Optional parameter
The fullword binary value that is the major version of the application to be associated with the program.
MINOR_VERSION
Optional parameter
The fullword binary value that is the minor version of the application to be associated with the program.
MICRO_VERSION
Optional parameter
The fullword binary value that is the micro version of the application to be associated with the program.
OPERATION_NAME
Optional parameter
The 64-character buffer to receive the name of the application operation to be associated with the program.
PLATFORM_NAME
Optional parameter
The 64-character buffer to receive the name of the platform to be associated with the program.
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
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:
  • APP_CONTEXT_NOT_FOUND
  • CEDF_STATUS_NOT_FOR_MAPSET
  • CEDF_STATUS_NOT_FOR_PTNSET
  • CEDF_STATUS_NOT_FOR_REMOTE
  • CONTEXT_ALREADY_SET
  • DEBUG_BUT_NO_JVM
  • DUPLICATE_OPERATION
  • EXEC_KEY_NOT_FOR_MAPSET
  • EXEC_KEY_NOT_FOR_PTNSET
  • EXEC_KEY_NOT_FOR_REMOTE
  • EXEC_SET_NOT_FOR_MAPSET
  • EXEC_SET_NOT_FOR_PTNSET
  • EXEC_SET_NOT_FOR_REMOTE
  • INCOMPATIBLE_BUNDLE_SET
  • INCOMPATIBLE_LIB_SET
  • JVM_BUT_NO_JVMCLASS
  • JVMSERVER_PROGRAM
  • OPERATION_NOT_FOR_REMOTE
  • OPERATION_NOT_FOR_MAPSET
  • OPERATION_NOT_FOR_PTNSET
  • OPERATION_NOT_FOR_REMOTN
  • NAME_CLASH
  • PROG_TYPE_NOT_FOR_REMOTE
  • PROGRAM_NOT_DEFINED_TO_LD
  • PROGRAM_NOT_DEFINED_TO_PG
  • PROGRAM_NOT_FOUND
The following values are returned when RESPONSE is INVALID:
  • INVALID_MODE_COMBINATION
  • INVALID_PROGRAM_NAME
  • INVALID_PROGRAM_TOKEN
  • INVALID_TYPE_ATTRIB_COMBIN
The values for the parameter are as follows:
  • NO_REASON
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_PGISset_program.html | Timestamp icon Last updated: Monday, 5 June 2017