ZCCPS - CICS Client

      DESCRIPTIVE NAME = CICS Client control blocks
       This copybook provides the declarations and structures
       necessary for the CCIN and CTIN transactions.
     ------------------------------------------------------------------
    ====================================================================
      Data for CICS client CCIN transaction input
    ====================================================================
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 12 R Receive parameters !
(0) CHARACTER 12 CCIN_HEADER
(0) FULLWORD 4 CCIN_LEN
(4) UNSIGNED 1 CCIN_GROUP
(5) UNSIGNED 1 CCIN_FUNCTION
(6) UNSIGNED 1 CCIN_VERSION
(7) UNSIGNED 1 CCIN_RESPONSE
(8) UNSIGNED 2 CCIN_REASON
(A) UNSIGNED 2 CCIN_PARMNUM
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CCIN_APPLID_PARM
(0) FULLWORD 4 CCIN_APPLID_LENGTH
(4) UNSIGNED 1 CCIN_APPLID_PARM_TYPE
(5) CHARACTER * CCIN_APPLID
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CCIN_CODEPAGE_PARM
(0) FULLWORD 4 CCIN_CODEPAGE_LENGTH
(4) UNSIGNED 1 CCIN_CODEPAGE_PARM_ TYPE
(5) CHARACTER * CCIN_CODEPAGE
Table 4.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 8 CCIN_CAPABILITIES_ PARM
(0) FULLWORD 4 CCIN_CAPABILITIES_ LENGTH
(4) UNSIGNED 1 CCIN_CAPABILITIES_ PARM_TYPE
(5) BIT(8) 1 CCIN_ENVIRON_TYPE
(5) 1111 11..   *
(5) .... ..1.   CCIN_EBCDIC
(5) .... ...1   CCIN_BIGENDIAN
(6) BIT(16) 2 CCIN_CLIENT_ CAPABILITIES
(6) BIT(8) 1 *
(6) 1... ....   CCIN_EXIT_PROCESSING
(6) .1.. ....   CCIN_TRANSLATE_ CAPABLE
(6) ..1. ....   CCIN_DELETE_ENTRIES
(6) ...1 ....   CCIN_TCTUA_COMMAREA
(6) .... 1111   *
(7) BIT(8) 1 *
Table 5.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 10 CCIN_SECURITY_PARM
(0) FULLWORD 4 CCIN_SECURITY_LENGTH
(4) UNSIGNED 1 CCIN_SECURITY_PARM_ TYPE
(5) UNSIGNED 1 CCIN_ECIATTACH_USERID
(6) UNSIGNED 1 CCIN_ECIATTACH_ PASSWORD
(7) UNSIGNED 1 CCIN_EPIATTACH_USERID
(8) UNSIGNED 1 CCIN_EPIATTACH_ PASSWORD
(9) UNSIGNED 1 CCIN_CTINATTACH_REQS
Table 6.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 6 CCIN_TIMEOUT_PARM
(0) FULLWORD 4 CCIN_TIMEOUT_LENGTH
(4) UNSIGNED 1 CCIN_TIMEOUT_PARM_ TYPE
(5) BIT(8) 1 *
(5) 1... ....   CCIN_CONV_TIMEOUT_ SUPPORTED
(5) .111 1111   * 
    ====================================================================
      Data for CICS client CCIN transaction output
    ====================================================================
Table 7.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 12 S Send parameters !
(0) CHARACTER 12 CCIN_HEADER
(0) FULLWORD 4 CCIN_LEN
(4) UNSIGNED 1 CCIN_GROUP
(5) UNSIGNED 1 CCIN_FUNCTION
(6) UNSIGNED 1 CCIN_VERSION
(7) UNSIGNED 1 CCIN_RESPONSE
(8) UNSIGNED 2 CCIN_REASON
(A) UNSIGNED 2 CCIN_PARMNUM 
    ====================================================================
      Data for CICS client CTIN transaction input
    ====================================================================
Table 8.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 12 IN Input parameters !
(0) CHARACTER 12 CTIN_HEADER
(0) FULLWORD 4 CTIN_LEN
(4) UNSIGNED 1 CTIN_GROUP
(5) UNSIGNED 1 CTIN_FUNCTION
(6) UNSIGNED 1 CTIN_VERSION
(7) UNSIGNED 1 CTIN_RESPONSE
(8) UNSIGNED 2 CTIN_REASON
(A) UNSIGNED 2 CTIN_PARMNUM
Table 9.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CTIN_NETNAME_PARM
(0) FULLWORD 4 CTIN_NETNAME_LENGTH
(4) UNSIGNED 1 CTIN_NETNAME_PARM_ TYPE
(5) CHARACTER * CTIN_NETNAME
Table 10.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CTIN_MODELID_PARM
(0) FULLWORD 4 CTIN_MODELID_LENGTH
(4) UNSIGNED 1 CTIN_MODELID_PARM_ TYPE
(5) CHARACTER * CTIN_MODELID
Table 11.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CTIN_CODEPAGE_PARM
(0) FULLWORD 4 CTIN_CODEPAGE_LENGTH
(4) UNSIGNED 1 CTIN_CODEPAGE_PARM_ TYPE
(5) CHARACTER * CTIN_CODEPAGE
Table 12.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CTIN_APPLID_PARM
(0) FULLWORD 4 CTIN_APPLID_LENGTH
(4) UNSIGNED 1 CTIN_APPLID_PARM_TYPE
(5) CHARACTER * CTIN_APPLID
Table 13.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CTIN_TERMID_PARM
(0) FULLWORD 4 CTIN_TERMID_LENGTH
(4) UNSIGNED 1 CTIN_TERMID_PARM_TYPE
(5) CHARACTER * CTIN_TERMID
Table 14.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 6 CTIN_TERMSOC_PARM
(0) FULLWORD 4 CTIN_TERMSOC_LENGTH
(4) UNSIGNED 1 CTIN_TERMSOC_PARM_ TYPE
(5) UNSIGNED 1 CTIN_TERMSOC signon capability !
(5) 1... ....   CTIN_TERMSOC_IND 1 - required ! 0 - not required ! 
    ====================================================================
      Data for CICS client CTIN transaction output
    ====================================================================
Table 15.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 12 OUT Output parameters !
(0) CHARACTER 12 CTIN_HEADER
(0) FULLWORD 4 CTIN_LEN
(4) UNSIGNED 1 CTIN_GROUP
(5) UNSIGNED 1 CTIN_FUNCTION
(6) UNSIGNED 1 CTIN_VERSION
(7) UNSIGNED 1 CTIN_RESPONSE
(8) UNSIGNED 2 CTIN_REASON
(A) UNSIGNED 2 CTIN_PARMNUM
Table 16.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE * CTIN_TERMDETAILS_PARM
(0) FULLWORD 4 CTIN_TERMDETAILS_ LENGTH
(4) UNSIGNED 1 CTIN_TERMDETAILS_ PARM_TYPE
(5) CHARACTER * CTIN_TERMDETAILS
Table 17.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 6 CTIN_TERMSOCS_PARM like ctin_termsoc_parm
(0) FULLWORD 4 *
(4) UNSIGNED 1 *
(5) UNSIGNED 1 * Signon capability
(5) 1... ....   * 1 - capable 0 - incapable

Constants

Table 18.
Len Type Value Name Description 
  ====================================================================
   Declare the CCIN header block and response and reason codes
  ====================================================================
   Constants for ccin_group
1 DECIMAL 1 CCIN_CLIENT_FUNCTION 
   Constants for ccin_function
1 DECIMAL 1 CCIN_CLIENT_INSTALL_ REQUEST
1 DECIMAL 2 CCIN_CLIENT_INSTALL_ RESPONSE
1 DECIMAL 3 CCIN_CLIENT_UNINSTALL_ REQUEST 
   Constants for CCIN parameter types
1 DECIMAL 1 CCIN_APPLID_TYPE
1 DECIMAL 3 CCIN_CODEPAGE_TYPE
1 DECIMAL 4 CCIN_CAPABILITIES_TYPE
1 DECIMAL 9 CCIN_SECURITY_TYPE
1 DECIMAL 12 CCIN_TIMEOUT_TYPE 
   Constants for ccin_response
1 DECIMAL 0 CCIN_NORMAL
1 DECIMAL 1 CCIN_EXCEPTION
1 DECIMAL 2 CCIN_ERROR
1 DECIMAL 4 CCIN_DISASTER 
   Constants for ccin_reason
2 DECIMAL 0 CCIN_OK
2 DECIMAL 1 CCIN_ALREADY_INSTALLED
2 DECIMAL 4 CCIN_INSTALL_CANCELLED
2 DECIMAL 5 CCIN_SERVER_BUSY
2 DECIMAL 6 CCIN_INVALID_REQUEST
2 DECIMAL 7 CCIN_INVALID_CODEPAGE 
  ====================================================================
   Declare the CTIN header block and response and reason codes
  ====================================================================
   Constants for ctin_group
1 DECIMAL 1 CTIN_CLIENT_FUNCTION 
   Constants for ctin_function
1 DECIMAL 17 CTIN_TERMINAL_INSTALL_ REQUEST
1 DECIMAL 18 CTIN_TERMINAL_INSTALL_ RESPONSE
1 DECIMAL 19 CTIN_TERMINAL_ UNINSTALL_REQUEST 
   Constants for CTIN parameter types
1 DECIMAL 1 CTIN_APPLID_TYPE
1 DECIMAL 3 CTIN_CODEPAGE_TYPE
1 DECIMAL 5 CTIN_NETNAME_TYPE
1 DECIMAL 6 CTIN_MODELID_TYPE
1 DECIMAL 7 CTIN_TERMDETAILS_TYPE
1 DECIMAL 8 CTIN_TERMID_TYPE
1 DECIMAL 10 CTIN_TERMSOC_TYPE 
   Constants for ctin_response
1 DECIMAL 0 CTIN_NORMAL
1 DECIMAL 1 CTIN_EXCEPTION
1 DECIMAL 2 CTIN_ERROR
1 DECIMAL 4 CTIN_DISASTER 
   Constants for ctin_reason
2 DECIMAL 1 CTIN_ALREADY_INSTALLED
2 DECIMAL 2 CTIN_UNKNOWN_TERMINAL
2 DECIMAL 3 CTIN_UNKNOWN_MODEL
2 DECIMAL 4 CTIN_INSTALL_CANCELLED
2 DECIMAL 5 CTIN_SERVER_BUSY
2 DECIMAL 6 CTIN_INVALID_REQUEST
2 DECIMAL 7 CTIN_INVALID_CODEPAGE
2 DECIMAL 8 CTIN_INVALID_SIGNON
2 DECIMAL 9 CTIN_CCIN_INACTIVE
2 DECIMAL 10 CTIN_INVALID_TERMID 
   Constants for ctin_o_type
1 DECIMAL 7 CTIN_O_TERM_BPS