The communications area at INSTALL for Client virtual terminals

The communications area is mapped by the DSECT for the assembler version of DFHZATDX or DFHZATDY, which are supplied in CICSTS54.CICS.SDFHMAC.

Note: The communications area for INSTALL of virtual terminals is the same as that for INSTALL of shipped terminals and connections—that is why the field names contain the word “SHIPPED”.
Figure 1. Autoinstall control program's communications area at INSTALL
*--------------------------------------------------------------------------*
* Remote install parameter list - Client virtual terminal function   9     *
*--------------------------------------------------------------------------*
INSTALL_SHIPPED_COMMAREA           DSECT          Install Parameter List
*
INSTALL_SHIPPED_STANDARD           DS  F          Standard field
                                   ORG INSTALL_SHIPPED_STANDARD
INSTALL_SHIPPED_EXIT_FUNCTION      DS  XL1        Install type
INSTALL_SHIPPED_TERM               EQU X'F9'      Install virtual terminal
INSTALL_SHIPPED_EXIT_COMPONENT     DS CL2         Component ID 'ZC'
INSTALL_SHIPPED_CLASH              DS  CL1        Install clash Y/N
                                   ORG ,
INSTALL_SHIPPED_NETNAME_PTR        DS  A          Pointer to netname of Client
INSTALL_SHIPPED_SELECTED_PTR       DS  A          Pointer to return fields
INSTALL_SHIPPED_TERMID_PTR         DS  A          Pointer to incoming TERMID
INSTALL_SHIPPED_APPLID_PTR         DS  A          Pointer to applid of Client
INSTALL_SHIPPED_SYSID_PTR          DS  A          Pointer to sysid of Client
INSTALL_SHIPPED_CORRID_PTR         DS  A          Pointer to correlation ID
INSTALL_SHIPPED_SELECTED_PARMS     DSECT ,
                                   DS  CL8        Reserved
SELECTED_SHIPPED_TERMID            DS  CL4        Selected TERMID
                                   DS  CL4        Reserved
                                   DS  CL4        Reserved
SELECTED_SHIPPED_RETURN_CODE       DS  CL1        Selected return code
RETURN_OK                          EQU X'00'      Accept request
REJECT                             EQU X'01'      Reject request
*
INSTALL_SHIPPED_STANDARD
A fullword input field containing the following information:
INSTALL_SHIPPED_EXIT_FUNCTION
A 1-byte field that indicates the type of resource being installed. For install of Client virtual terminals the equated value is INSTALL_SHIPPED_TERM (X'F7').
INSTALL_SHIPPED_EXIT_COMPONENT
A 2-byte component code, which is set to ‘ZC'.
INSTALL_SHIPPED_CLASH
A 1-character input field that indicates whether the supplied TERMID is already in use in this region.
Y
The name passed to the CICS® autoinstall function is already in use in this region to identify an installed remote terminal or connection.
N
The name passed to the CICS autoinstall function is not already in use in this region to identify a remote terminal or connection.
INSTALL_SHIPPED_NETNAME_PTR
A fullword pointer to an 8-character field containing the netname of the Client workstation. This field contains the same value as the field pointed to by INSTALL_SHIPPED_APPLID_PTR.
INSTALL_SHIPPED_SELECTED_PTR
A fullword pointer to the return fields. The output fields, for use by your program, are:
SELECTED_SHIPPED_TERMID
A 4-character field used to specify the name by which the virtual terminal will be known to CICS. If the name is less than 4 characters long, it must be padded with trailing blanks. For a list of the characters you can use in terminal names, see TERMINAL attributes.

On invocation, if INSTALL_SHIPPED_CLASH is set to 'N' (indicating no conflict of terminal names), SELECTED_SHIPPED_TERMID contains the same value as the field pointed to by INSTALL_SHIPPED_TERMID_PTR (the supplied name). If INSTALL_SHIPPED_CLASH is set to 'Y', SELECTED_SHIPPED_TERMID contains a CICS-generated alias.

Your user program can override the suggested name.

SELECTED_SHIPPED_RETURN_CODE
The 1-character return code field. The equated values are:
RETURN_OK (X'00')
Install the virtual terminal. This is the default value. Your user program must return this value if the resource is to be autoinstalled.
REJECT (X'01')
Do not install the virtual terminal.
INSTALL_SHIPPED_TERMID_PTR
A fullword pointer to a 4-character input field containing the TERMID passed to the CICS autoinstall function (that is, the supplied name).
INSTALL_SHIPPED_APPLID_PTR
A fullword pointer to an 8-character input field containing the netname (applid) of the Client workstation.
INSTALL_SHIPPED_SYSID_PTR
A fullword pointer to a 4-character input field containing the name (sysid) of the connection to the Client workstation.
INSTALL_SHIPPED_CORRID_PTR
A fullword pointer to an 8-character input field that is not used for install of virtual terminals.