The autoinstall control program at INSTALL
On invocation, CICS® passes a parameter list to the autoinstall control program by means of a communication area addressed by DFHEICAP. The communications area is mapped by a copybook that is supplied in each of the languages supported by CICS.
The assembler form of the parameter list is as follows:
- PGAC_PROGRAM
- passes the 8-byte name of the object to be autoinstalled. This is an input-only field, which your user-replaceable program must not alter.
- PGAC_MODULE_TYPE
- passes a 1-byte indicator of the type of object to be installed.
The equated values are:
- PGAC_TYPE_PROGRAM
- A program
- PGAC_TYPE_MAPSET
- A mapset
- PGAC_TYPE_PARTITIONSET
- A partitionset.
This is an input-only field, which your user-replaceable program must not alter.
- PGAC_MODEL_NAME
- allows your control program to specify the 8-byte autoinstall
model name to be used. If you do not set this field, CICS uses
the default model name for the type of object:
- DFHPGAPG
- For a program
- DFHPGAMP
- For a mapset
- DFHPGAPT
- For a partitionset.
- PGAC_LANGUAGE
- allows your control program to specify, in a 1-byte field, the
language of the program to be autoinstalled. The equated values are:
- PGAC_ASSEMBLER
- Assembler
- PGAC_COBOL
- COBOL
- PGAC_C370
- C
- PGAC_LE370
- Language Environment®
- PGAC_PLI
- PL/I.
If you do not set this field, the autoinstall routine uses the language defined in the model, if one is specified. However, when control is passed to the program, CICS determines the language from the program itself, and overrides any specification provided.
You should not need to specify the language of executable programs that have been translated using the EXEC CICS translator before compiling.
- PGAC_CEDF_STATUS
- allows you to specify, in a 1-byte field, the execution diagnostic
facility (EDF) status of the program to be autoinstalled. The equated
values are:
- PGAC_CEDF_YES
- EDF can be used with this program.
- PGAC_CEDF_NO
- EDF cannot be used with this program.
- PGAC_DATA_LOCATION
- allows you to specify, in a 1-byte field, the data location for
task-lifetime storage. The equated values are:
- PGAC_LOCATION_BELOW
- Task-lifetime storage must be located below 16 MB.
- PGAC_LOCATION_ANY
- Task-lifetime storage can be below or above 16 MB.
- PGAC_EXECUTION_KEY
- allows you to specify, in a 1-byte field, the execution key for
the program. The equated values are:
- PGAC_CICS_KEY
- The program is to execute in CICS key.
- PGAC_USER_KEY
- The program is to execute in user key.
- PGAC_LOAD_ATTRIBUTE
- allows you to specify, in a 1-byte field, the load attributes
for the object. The equated values are:
- PGAC_RELOAD
- CICS is to load a fresh copy of the object for each request.
- PGAC_RESIDENT
- CICS is to make the object permanently resident.
- PGAC_TRANSIENT
- The storage for this object is to be released whenever the use count reaches zero.
- PGAC_REUSABLE
- CICS can use any copy of the object currently in storage.
- PGAC_USE_LPA_COPY
- allows you to specify, in a 1-byte field, whether CICS is
to use an LPA-resident copy of the program. The equated values are:
- PGAC_LPA_YES
- CICS is to use a copy from the LPA.
- PGAC_LPA_NO
- CICS is to load a private copy from its own DFHRPL or dynamic LIBRARY concatenation.
- PGAC_EXECUTION_SET
- allows you to specify, in a 1-byte field, whether or not the program
is restricted to using the distributed program link (DPL) subset of
the CICS API. The equated values are:
- PGAC_DPLSUBSET
- The program is to be restricted to the DPL subset of the EXEC CICS API.
- PGAC_FULLAPI
- The program can use the full API.
- PGAC_REMOTE_SYSID
- allows you to specify, in a 4-byte field, the name of the remote system where the program is to execute. CICS function ships any request for this program to the specified remote CICS.
- PGAC_REMOTE_PROGID
- allows you to specify, in an 8-byte field, the name by which the program is known in the remote CICS region. For a remote program, the remote name defaults to the local name if you set this field to blank.
- PGAC_REMOTE_TRANSID
- allows you to specify, in a 4-byte field, the name of the CICS mirror transaction under which the program, if remote, is to run. By default, this is set to the name of the CICS mirror transaction, CSMI.
- PGAC_DYNAMIC_STATUS
- allows you to specify, in a 1-byte field, whether, if the program
is the subject of a program-link request, the request can be dynamically
routed. The equated values are:
- PGAC_DYNAMIC_NO
- If the program is the subject of a program-link request, the dynamic
routing program is not invoked.
For a distributed program link (DPL) request, the server region on which the program is to execute must be specified explicitly on the REMOTESYSTEM option of the PROGRAM definition or on the SYSID option of the EXEC CICS LINK command; otherwise it defaults to the local region.
- PGAC_DYNAMIC_YES
- If the program is the subject of a program-link request, the dynamic routing program is invoked. Providing that a remote server region is not named explicitly on the SYSID option of the EXEC CICS LINK command, the routing program can route the request to the region on which the program is to execute.
- PGAC_CONCURRENCY
- allows you to specify, in a 1-byte field, whether or not the program
is written to threadsafe standards. The equated values are:
- PGAC_QUASIRENT
- The program is quasi-reentrant only, and relies on the serialization
provided by CICS when accessing shared resources.
The program is restricted to the CICS permitted programming interfaces, and must comply with the CICS quasi-reentrancy rules.
- PGAC_THREADSAFE
- The program is written to threadsafe standards, and when it accesses shared resources it takes into account the possibility that other programs may be executing concurrently and attempting to modify the same resources.
- PGAC_JVM
- allows you to specify, in a 1-byte field, whether the program
is to be run under a JVM. The equated values are:
- PGAC_JVM_YES
- The program is a Java™ bytecode program and must run under the control of a JVM.
- PGAC_JVM_NO
- The program does not require a JVM for its execution.
- PGAC_JVM_CLASS_LEN
- allows you to specify, as a two-byte binary value, the length of the Java class name supplied in PGAC_JVM_CLASS_DATA.
- PGAC_JVM_CLASS_DATA
- allows you to specify, as a 256-byte field, the name of the Java class to be invoked.
- PGAC_JVM_PROFID
- allows you to specify, in an 8-byte field, the name of the JVM profile to be used for the JVM in which the program is to run.
- PGAC_RETURN_CODE
- allows you to specify, in a 1-byte field, the autoinstall control
program's return code to CICS. The equated values are:
- PGAC_RETURN_OK
- Install the program definition using the values returned in the communications area parameter list.
- PGAC_RETURN_DONT_DEFINE_PROGRAM
- Do not define the program.