WBEPC - Web Error Program parms

  
  Licensed Materials - Property of IBM
  
  5655-Y04
  
  (C) Copyright IBM Corp. 1998, 2008 All Rights Reserved.
  
  
  These declarations define the commarea which is passed
  to the user replaceable Web Error program by the CICS WEB
  Interface
  via a Program Manager Domain EXEC_LINK call.
  
  Variable
  Meaning
  
  < wbep_length > (input)
  Length of DFHWBEPC copybook
  
  < wbep_eyecatcher >
  A character field to contain an eyecatcher
  to help with diagnostics.
  The caller sets this to '>wbepca '
  before calling the Web Error Program
  
  < wbep_version >
  Version of DFHWBEPC copybook being passed by CICS
  
  < wbep_error_code > (input)
  The two byte signed binary number indicating the cause of the
  original error. Constants which this field may contain can be
  found in copybook DFHWBUCC.
  
  < wbep_abend_code > (input)
  The four character abend code associated with this exception.
  
  < wbep_message_number > (input)
  Message number associated with this exception
  
  < wbep_message_ptr > (input)
  A pointer to the CICS message text associated with this exception
  
  < wbep_response_len > (input)
  The full word length of the HTTP error response to be returned to
  the
  the HTTP client. On entry to DFHWBEP this contains the default
  CICS
  HTTP error response for the reported error.
  
  < wbep_response_ptr > (input)
  A pointer to the 32K buffer containing the HTTP error response to
  be
  returned to the HTTP client. On entry to DFHWBEP this contains the
  default HTTP error response returned by CICS for the reported
  error.
  
  < wbep_response_len > (input)
  The full word length of the response message text associated with
  this exception.
  
  < wbep_client_address_len > (input)
  One byte field containing the length of the address contained in
  wbep_client_address
  
  < wbep_client_address > (input)
  The 39 character TCPIP address of the client.
  
  < wbep_server_address_len > (input)
  One byte field containing the length of the address contained in
  wbep_server_address
  
  < wbep_server_address > (input)
  The 39 character TCPIP address of the TCP/IP stack on which this
  request was received
  
  < wbep_tcpipservice_name > (input)
  Name of the TCPIPSERVICE associated with the failing request
  
  < wbep_converter_program < (input)
  The 8 character name of the converter program associated with this
  request
  
  < wbep_target_program > (input)
  The target program associated with the web request.
  
  < wbep_failing_program > (input)
  The program which CICS was invoking when the failure occurred
  
  < wbep_http_response_code > (input)
  HTTP error response code CICS is returning for this error.
  This can be overriden by changing the content of the buffer
  containing the HTTP response
  
  < wbep_analyzer_response > (input)
  Response code returned by analyzer program
  
  < wbep_analyzer_reason > (input)
  Reason code returned by analyzer program
  
  < wbep_converter_response > (input)
  Response code returned by converter program
  
  < wbep_converter_reason > (input)
  Reason code returned by converter program
  
  --------------------------------------------------------------------
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 208 DFHWBEPC
(0) CHARACTER 12 WBEP_PREFIX
(0) HALFWORD 2 WBEP_LENGTH
(2) CHARACTER 8 WBEP_EYECATCHER
(A) HALFWORD 2 WBEP_VERSION
(C) CHARACTER 196 WBEP_DATA
(C) HALFWORD 2 WBEP_ERROR_CODE
(E) BIT(8) 1 WBEP_FLAGS indicator flags
(E) 1... ....   WBEP_SUPPRESS_ABEND suppress if set
    The filler bits in WBEP_FLAGS are permanently reserved
    due to complexity of bit manipulation in cobol.
(E) .111 1111   * DO NOT USE
(F) UNSIGNED 1 WBEP_ACTIVITY
(10) CHARACTER 4 WBEP_ABEND_CODE
(14) FULLWORD 4 WBEP_MESSAGE_NUMBER
(18) ADDRESS 4 WBEP_MESSAGE_PTR
(1C) FULLWORD 4 WBEP_MESSAGE_LEN
(20) ADDRESS 4 WBEP_RESPONSE_PTR
(24) FULLWORD 4 WBEP_RESPONSE_LEN
(28) UNSIGNED 1 WBEP_CLIENT_ADDRESS_ LEN
(29) CHARACTER 15 WBEP_CLIENT_ADDRESS
(38) UNSIGNED 1 WBEP_SERVER_ADDRESS_ LEN
(39) CHARACTER 15 WBEP_SERVER_ADDRESS
(48) CHARACTER 8 WBEP_TCPIPSERVICE_ NAME
(50) CHARACTER 8 WBEP_CONVERTER_ PROGRAM
(58) CHARACTER 8 WBEP_TARGET_PROGRAM
(60) CHARACTER 8 WBEP_FAILING_PROGRAM
(68) FULLWORD 4 WBEP_HTTP_RESPONSE_ CODE
(6C) FULLWORD 4 WBEP_ANALYZER_ RESPONSE
(70) FULLWORD 4 WBEP_ANALYZER_REASON
(74) FULLWORD 4 WBEP_CONVERTER_ RESPONSE
(78) FULLWORD 4 WBEP_CONVERTER_REASON
(7C) CHARACTER 1 WBEP_CLOSE_CONN
(7D) CHARACTER 3 * unused/reserved
(80) UNSIGNED 1 WBEP_CLIENT_IPV6_ ADDRESS_LEN length next fld
(81) CHARACTER 39 WBEP_CLIENT_IPV6_ ADDRESS client addr
(A8) UNSIGNED 1 WBEP_SERVER_IPV6_ ADDRESS_LEN length next fld
(A9) CHARACTER 39 WBEP_SERVER_IPV6_ ADDRESS server addr
(D0) CHARACTER 0 *

Constants

Table 2.
Len Type Value Name Description
  --------------------------------------------------------------------
   WBEP Version number
  --------------------------------------------------------------------
2 DECIMAL 1 WBEP_VERSION_CTS130
2 DECIMAL 2 WBEP_VERSION_CTS410
2 DECIMAL 2 WBEP_CURRENT_VERSION
4 DECIMAL 0 WBEP_ACTIVITY_SERVER Acting as server
4 DECIMAL 1 WBEP_ACTIVITY_CLIENT Acting as client
4 DECIMAL 2 WBEP_ACTIVITY_PIPELINE
        Acting as pipeline
4 DECIMAL 3 WBEP_ACTIVITY_ ATOMSERVICE
        Acting as atomservice