The communication area at INSTALL for consoles

The layout of the communication area is shown in Figure 1.
Figure 1. Autoinstall control program’s communication area at INSTALL for consoles
 
    Fullword 1       Standard Header
      Byte  1        Function Code           (X'FD' for INSTALL)
      Bytes 2 - 3    Component Code          Always 'ZC'
      Byte  4        Reserved                Always X'00'
    Fullword 2       Pointer to CONSOLENAME_FIELD
    Fullword 3       Pointer to MODELNAME_LIST
    Fullword 4       Pointer to SELECTED_PARMS
    Fullword 5       Reserved
The parameter list contains the following information:
  1. A standard header. Byte 1 indicates the request type (this is hexadecimal character X'FD' for INSTALL), and bytes 2 to 3 contain the component code, which is always ZC for consoles. (Byte 4 is reserved.)
  2. A pointer to a 2-byte length field, followed by the console name of the console which sent the message.
  3. A pointer to an array of names of eligible autoinstall models. The array is preceded by a 2-byte field containing the number of 8-byte name elements in the array. If there are no elements in the array, the number field is set to zero.
  4. A pointer to the area of storage that you use to return information to CICS®.

CICS passes a list of eligible autoinstall models in the area addressed by fullword 3 of the parameter list. From this list, the control program must select a model that is suitable for the console device, and move the model name to the first 8 bytes of the area addressed by fullword 4 of the parameter list. Before returning to CICS, the control program must supply a CICS 4-character terminal ID for the console being logged on, and set the return code field to X'00' if the autoinstall request is to be allowed. Your program can also set the delay period that is to follow the last use of a console before it is automatically deleted by CICS. On entry to your autoinstall control program, this value is set to a default value of 60 minutes. Override this by storing your own delay period, in minutes, as a fullword binary value. Setting this field to zero (0) means that CICS never deletes the console.

Figure 2 shows all of these fields in their required order.
Figure 2. Autoinstall control program’s parameter list at INSTALL
The picture shows, in graphical format, the communication area described in the preceding pages. The communication area consists of five fullwords, as follows: Standard Header. Byte 1 indicates the request type (this is hexadecimal character FD for INSTALL). Bytes 2 and 3 contain the CICS component code, 'ZC'. Byte 4 is reserved.Pointer to a 2-byte length field, followed by the name of the console to be installed.Pointer to an array of names of eligible autoinstall models. The array is preceded by a 2-byte field describing the number of 8-byte name elements in the array. Pointer to the area of storage that you use to return information to CICS. This storage area contains the following fields: Modelname8-byte output field.Terminal ID4-byte output field.Reserved4-byte reserved field.Reserved4-byte reserved field.Return code1-byte input/output field.Reserved8-byte reserved field.Reserved8-byte reserved field.Reserved3-byte reserved field.Delete delay4-byte input/output field.Reserved.