Autoinstall user program at INSTALL

When the autoinstall user program is invoked for the installation of an IPCONN resource, CICS® passes it a parameter list in a communication area addressed by DFHEICAP.

The communication area at INSTALL for IPCONNs

The communications area is mapped by the assembler DSECT DFHISAIC, which is supplied in CICSTSnn.CICS.SDFHSAMP, where nn represents the CICS release. For example, CICSTS63.CICS.SDFHSAMP..
Figure 1. Autoinstall user program's communications area at INSTALL. For IPCONNs.
ISAIC_FUNCTION         DS CL1    Function code (X'F0' for Install)
ISAIC_RESPONSE         DS CL1    Response code
                       DS CL2    Reserved
ISAIC_IPCONN           DS CL8    Name for the autoinstalled IPCONN
ISAIC_APPLID           DS CL8    The applid of remote system
ISAIC_SUGGESTED_APPLID DS CL8    Suggested applid, if isaic_applid
*                                is blank
ISAIC_NETWORKID        DS CL8    Network ID of remote system
ISAIC_TCPIPSERVICE     DS CL8    Name of the TCPIPSERVICE on which
*                                this connect flow arrived
ISAIC_TEMPLATE         DS CL8    Name of the template IPCONN
ISAIC_HOST             DS CL116  Host name of remote system
ISAIC_PORT             DS F      Call back port number of
*                                remote system
ISAIC_RECEIVECOUNT     DS F      Number of receive sessions wanted
*                                by remote system
isaic_applid (Input/Output)
An 8-character field containing the applid of the remote system trying to connect, as sent on the connect flow. The user program can change this value only if it is blank on input (which indicates that the connecting system is probably a Java client). If it is blank on output, CICS uses the suggested applid pointed to by the isaic_suggested_applid field.
isaic_function (Input)
A 1-character code indicating the function for which the autoinstall user program has been invoked. Contains X'F0' for install.
isaic_host (Input/Output)
A 116-character field containing the host name of the remote system, as passed in the connect flow. The autoinstall user program is allowed to modify this because it is possible that it has a better idea of what the connecting system is known as locally than does the system itself.
isaic_ipconn (Output)
An 8-character field containing the name to be used for the autoinstalled IPCONN connection. The user program must supply the name.
isaic_networkid (Input)
An 8-character field containing the network ID of the system trying to connect, as sent on the connect flow.
isaic_port (Input/Output)
The call back port number for the client. -1 means that no call back is allowed. The autoinstall user program can modify this for the same reason that it can modify the host name, unless it is -1, in which case it cannot be changed. The autoinstall user program is also not allowed to change this value to -1.
isaic_receivecount (Input)
A 4-byte binary field containing the number of receive sessions that the remote system wants to be supported by this IPCONN. (These are send sessions at the remote system end.)
isaic_response (Output)
Response code: zero means OK.
isaic_suggested_applid (Input)
An 8-character field containing a remote system applid suggested by CICS. If the applid of the remote system pointed to by isaic_applid is blank, CICS uses a counter to generate an 8-character decimal digit name in the form 00000027.
isaic_tcpipservice (Input)
An 8-character field containing the name of the TCPIPSERVICE on which this connect flow arrived.
isaic_template (Input/Output)
An 8-character field containing the name of an installed IPCONN to be used as a template for the new IPCONN resource.
By default, this field is blank, and CICS supplies the information required to create the IPCONN resource.
The autoinstall user program can modify this field to name a template IPCONN resource. If the template IPCONN resource is out-of-service, the autoinstall request is rejected.