WBTDC - Web Interface Analyzer Parms

  
  Licensed Materials - Property of IBM
  
  5655-Y04
  
  (C) Copyright IBM Corp. 1996, 2009 All Rights Reserved.
  
  
  These declarations define the parameter list which
  is passed to the ANALYZER program by the server controller
  component on an EXEC CICS LINK.
  
  < Variable >
  Meaning
  
  < wbra_eyecatcher >
  A character field to contain an eyecatcher
  to help with diagnostics and provide a sanity check for
  the analyzer. Server Controller sets this to the value of constant
  WBRA_EYECATCHER_INIT before calling the analyzer.
  
  < wbra_response > (output)
  The fullword response value produced by the analyzer.
  Possible values are:
  
  - URP_OK
  - URP_EXCEPTION
  - URP_INVALID
  - URP_DISASTER
  
  < wbra_reason > (output)
  The fullword reason value returned by the analyzer for response
  values other than OK. No reason values are architected for
  the analyzer in the CICS Web Browser Interface.
  Users may define their own values.
  
  < wbra_server_program > (input output)
  @PQC
  The CICS program to be used for this HTTP request.
  
  < wbra_converter_program > (input output)
  @PQC
  The converter to be used for this HTTP request.
  
  < wbra_userid > (input output)
  @PQC
  The userid which is to be used on the EXEC CICS START for the
  alias transaction for this HTTP request.
  
  < wbra_alias_tranid > (input output)
  @PQC
  The alias transaction ID to be used for this HTTP request.
  
  < wbra_alias_termid > (output)
  The termid to be used on the START request for the alias.
  
  < wbra_user_token > (output)
  A char(8) token which uniquely identifies the HTTP request being
  processed.
  
  < wbra_dfhcnv_key > (output)
  A char(8) name to be used as the key into the DFHCNV table for the
  codepage translation of the user data for this request.
  
  < wbra_version > (input)
  @LIA
  A single-character parameter-list version identifier.
  It will change whenever the layout of the parameter list changes.
  Possible values:
  Binary zero (X'00') -- pre-CICS/TS4.1 version parameter list
  Character one (X'F1') -- CICS/TS4.1 version parameter list
  
  < wbra_client_ip_address > (input)
  The TCP/IP address of the client.
  
  < wbra_server_ip_address > (input)
  The TCP/IP address of the CICS system.
  
  < wbra_resource_escaped_ptr > (input)
  @P7C
  Pointer to a copy of the HTTP headers which have not been
  unescaped
  
  < wbra_method_ptr > (input)
  Pointer to the method specified on the HTTP request sent by the
  client.
  
  < wbra_http_version_ptr > (input)
  Pointer to a string identifying the HTTP version supported by the
  client.
  
  < wbra_http_resource_ptr > (input)
  Pointer to the CICS resource requested by the client. In HTTP
  protocol
  terminology, this is the "absolute path" information in the HTTP
  request. Because CICS does not have any concept of "paths" or
  the hierarchical file systems on which paths rely, we have elected
  to use a term more appropriate to CICS in our documentation.
  
  < wbra_request_header_ptr > (input)
  Pointer to the first HTTP header in the HTTP request. There are
  usually multiple HTTP headers for each HTTP request. Each header
  is delimited by a CR+LF. The end of the header information is
  delimited by a null header (that is, an additional CR+LF following
  final HTTP header).
  
  < wbra_user_data_ptr > (input)
  Pointer to the user data section of the input data. For a non-HTTP
  request this will point to the start of the received data.
  
  < wbra_method_length > (input)
  Length of the method specified on the HTTP request sent by the
  client.
  
  < wbra_http_version_length > (input)
  Length of the string identifying the
  version of HTTP supported by the client.
  
  < wbra_http_resource_length > (input)
  Length of the string containing the
  HTTP header information for this HTTP request.
  
  < wbra_request_header_length > (input)
  Length of the string identifying the
  CICS resource requested by supported by the client.
  This length includes the lengths of all the delimiting CR+LFs
  for all the headers, including the final CR+LF of the null header
  which signals the end of the headers.
  
  < wbra_user_data_length > (input output)
  @01C
  Length of the user data section of the input data. For a non-HTTP
  request this will be the length of the entire received block.
  
  < wbra_old_request_type > (input)
  @07C
  A value indicating whether the request to be analyzed is HTTP
  @07C
  or non-HTTP(note that this parameter has been relocated to
  @07C
  the end of the parameter list. This is because it was
  @07A
  defined as bin(8) which when converted for the PL/1
  @07A
  version of the commarea caused misalignment.
  @07A
  
  < wbra_unescape > (output)
  @L9A
  A value indicating whether the user forms data is to be unescaped
  by CICS.
  @01A
  < wbra_content_length > (input)
  @01A
  Length of the user data section of the input data as
  @01A
  specified in the <Content-Lenth> HTTP header.
  @01A
  
  < wbra_urimap > (input)
  @LBA
  The URIMAP associated with the request.
  
  < wbra_commarea > (output)
  @LCA
  A flag indicating that the server application is commarea style
  @LCA
  and we should therefore process as for HTTP/1.0
  @LCA
  Not setting this bit causes the default setting to apply - the
  @LCA
  application will be assumed to be WEB API style.
  @LCA
  
  < wbra_characterset > (output)
  @POC
  The IANA character set to be used during data convertion.
  
  < wbra_hostcodepage > (output)
  @POC
  The host IBM codepage to be used during data convertion.
  
  < wbra_hostname_ptr > (input)
  Pointer to the hostname on the HTTP request sent by the
  client. This will have been taken from the URI if it is
  absolute or from the host header if not.
  
  < wbra_querystring_ptr > (input)
  Pointer to the querystring (if any) on the HTTP request
  sent by the client.
  
  < wbra_hostname_length > (input)
  Length of the hostname.
  
  < wbra_querystring_length > (input)
  Length of the querystring.
  @07A
  < wbra_request_type > (input)
  @07A
  A value indicating whether the request to be analyzed is
  @07A
  HTTP or non-HTTP.
  @07A
  
  < wbra_client_ipv6_address > (input)
  @LIA
  The TCP/IP address of the client. If the client is ipv4 then a
  mapped formated of the ipv4 address will be available here.
  
  < wbra_server_ipv6_address > (input)
  @LIA
  The TCP/IP address of the CICS system. If the server is ipv4 then
  a
  mapped formatted of the ipv4 address wiil be available here.
  
  --------------------------------------------------------------------
  
  The top level definition for dfhcommarea.
  
  --------------------------------------------------------------------

  --