LDLD gate, DEFINE_PROGRAM function

The DEFINE_PROGRAM function of the LDLD gate is used to introduce a new program to the CICS system or to update the details of an existing program.

Input Parameters

APPL_CONTEXT_TOKEN
Optional parameter
A token representing the application context of PLATFORM_ID, APPLICATION_ID, APPL_MAJOR_VER, APPL_MINOR_VER, and APPL_MICRO_VER.
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_MODULE
Optional Parameter
indicates whether the program definition should be written to one of the catalogs.
Values for the parameter are:
  • NO
  • YES
EXECUTION_KEY
Optional Parameter
is the execution key for the program. This is used to determine which DSA the program instance resides in.
Values for the parameter are:
  • CICS
  • USER
PLATFORM_ID
Optional parameter
The 64-character name of the platform associated with the task.
PROGRAM_NAME
specifies the name of the required program.
PROGRAM_ATTRIBUTE
Optional Parameter
is a residency attribute to be associated with the program.
Values for the parameter are:
  • RELOAD
  • RESIDENT
  • REUSABLE
  • TEST
  • TRANSIENT
PROGRAM_TYPE
Optional Parameter
is the type of program copy to be used.
Values for the parameter are:
  • PRIVATE
  • SHARED
  • TYPE_ANY
PROGRAM_USAGE
Optional Parameter
defines whether the program is part of the CICS nucleus, or is an application program defined by the user. This determines whether the program definition is written to the local catalog or to the global catalog.
Values for the parameter are:
  • APPLICATION
  • NUCLEUS
REQUIRED_AMODE
Optional Parameter
is the addressing mode required by CICS for the program. A program that does not have the required residency mode is not loaded.
Values for the parameter are:
  • AMODE_ANY
  • 24
  • 31
  • 64
REQUIRED_RMODE
Optional Parameter
is the residency mode required by CICS for the program. A program that does not have the required mode requirements is not loaded.
Values for the parameter are:
  • RMODE_ANY
  • 24
UPDATE
Optional Parameter
indicates whether the loader domain should update the program definition if the loader domain already has a program definition for the program. If UPDATE(NO) is specified, and the loader domain already has a program definition for the specified program, PROGRAM_ALREADY_DEFINED is returned.
Values for the parameter are:
  • NO
  • YES

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • CATALOG_ERROR
  • CATALOG_NOT_OPERATIONAL
  • INVALID_PROGRAM_NAME
  • PROGRAM_ALREADY_DEFINED
The following values are returned when RESPONSE is INVALID:
  • INVALID_MODE_COMBINATION
  • INVALID_TYPE_ATTRIB_COMBIN
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
NEW_APPL_CONTEXT_TOKEN
Optional parameter
A token to be used on subsequent calls, representing the application context of PLATFORM_ID, APPLICATION_ID, APPL_MAJOR_VER, APPL_MINOR_VER, and APPL_MICRO_VER.
NEW_PROGRAM_TOKEN
Optional Parameter
is the identifying token that may be used on subsequent ACQUIRE or RELEASE calls for this program name.


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