APLI gate, START_PROGRAM function

The START_PROGRAM function of the APLI gate is used to start a program.

Input Parameters

CEDF_STATUS
indicates whether or not 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:
  • CEDF
  • NOCEDF
COMMAREA
is an optional token identifying the communications area for the program.
EXECUTION_SET
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:
  • DPLSUBSET
  • FULLAPI
LANGUAGE_BLOCK
is a token identifying the current language block for the program.
LINK_LEVEL
is the 16-bit value indicating the link-level of the program.
PROGRAM
is the 8-character name of the program whose language is to be determined
DEFERRED_ABEND_FOR_XCTL
Optional Parameter
indicates whether a Runaway type abend should be started on completion of the current START_PROGRAM.
Values for the parameter are:
  • NO
  • YES
ENVIRONMENT_TYPE
Optional Parameter
is the environment type of the program.
Values for the parameter are:
  • EXEC
  • GLUE
  • PLT
  • SYSTEM
  • TRUE
  • URM
JVM_PROG
Optional Parameter
indicates whether the request is for establish language for a JVM program.
Values for the parameter are:
  • NO
  • YES
PARMLIST_PTR
Optional Parameter
is an optional token identifying the parameter list for the program.
SYNCONRETURN
Optional Parameter
defines whether or not a syncpoint is to be taken on return from the linked program.
Values for the parameter are:
  • NO
  • YES
SYSEIB_REQUEST
Optional Parameter
indicates whether or not an EXEC CICS LINK or EXEC CICS XCTL had the SYSEIB translator option specified.
Values for the parameter are:
  • NO
  • YES
TRANSACTION_BUILD
Optional Parameter
Values for the parameter are:
  • BUILD
  • TERMINATE

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • AUTOSTART_DISABLED
  • JVM_PROFILE_NOT_FOUND
  • JVM_PROFILE_NOT_VALID
  • JVMPOOL_DISABLED
  • SYSTEM_PROPERTIES_NOT_FND
  • TRANSACTION_ABEND
  • USER_CLASS_NOT_FOUND
The following values are returned when RESPONSE is INVALID:
  • INVALID_FUNCTION
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
ABEND_CODE
Optional Parameter
is the four-character transaction abend code.
IGNORE_PENDING_XCTL
Optional Parameter
indicates whether or not a pending XCTL should be ignored by program manager.
Values for the parameter are:
  • NO
  • YES


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