Parameters for analyzer programs

Attention: This topic contains Product-sensitive Programming Interface and Associated Guidance Information.
wbra_alias_tranid
Start of change(Input and output)

A string of length 4. The transaction ID of the alias transaction that is to cover the remainder of processing for this request. If a URIMAP definition is involved, this contains the value of the TRANSACTION attribute. If you do not set this field, or if you set it to blanks, CWBA is used.

End of change
Start of changewbra_alias_termidEnd of change
Start of change(Output only)

A string of length 4. The terminal ID to be used on the START request for the alias transaction that is to cover the remainder of processing for this request.

End of change
Start of changewbra_charactersetEnd of change
Start of change(Output only)

The name of the IANA character set that the client used for the entity body of the request. This information is used for code page conversion of the entity body of the request and the response. If the request is not an HTTP request, this character set is used to translate the entire request and response. wbra_hostcodepage must also be supplied.

End of change
wbra_client_ip_address
(Input only)

The 32-bit IP address of the client.

Start of changewbra_commareaEnd of change
Start of change(Ouput only)

The flag to indicate that pre-CICS TS Version 3 compatibility processing is required for a response that uses a non-Web-aware application and a converter program. This flag means that the Web client receives a response identical with the response it would have received before CICS® TS Version 3.

End of change
wbra_content_length
(Input only)

A 32–bit binary representation of the entity body length as specified by the Content-Length HTTP header in the received data.

wbra_converter_program
Start of change(Input and output)

A string of length 8. The name of the converter program that is used to process the request. If a URIMAP definition is involved, this contains the value of the CONVERTER attribute. If this field is not set on output, no converter program is called.

End of change
wbra_dfhcnv_key
(Output only)

A string of length 8. The name of a conversion template in the DFHCNV table for code page conversion of the entity body for the request and the response. If the request is not an HTTP request, this template is used to translate the entire request and response.

CICS initializes this field to high values. If you use this field to specify a conversion template, the name you choose must be defined in the DFHCNV table, as described in Migrating entries in the code page conversion table (DFHCNV). As an alternative, you can set the wbra_hostcodepage and wbra_characterset fields to specify the pair of code pages to use for code page conversion. If you set wbra_dfhcnv_key to nulls or blanks and do not set wbra_hostcodepage and wbra_characterset, code page conversion is suppressed.

wbra_eyecatcher
(Input only)

A string of length 8. Its value is ">analyze".

wbra_function
(Input only)

A code indicating that an analyzer program is being called. The value is 1.

Start of changewbra_hostcodepageEnd of change
Start of change(Output only)

The name of a host code page (IBM® EBCDIC code page) suitable for the application program that is handling the request. This information is used for code page conversion of the entity body of the request and the response. If the request is not an HTTP request, this code page is used to translate the entire request and response. wbra_characterset must also be supplied.

End of change
Start of changewbra_hostname_lengthEnd of change
Start of change(Input only)

The length in bytes of the host name specified on the HTTP request. If no host name was specified, the value is undefined.

End of change
Start of changewbra_hostname_ptrEnd of change
Start of change(Input only)

A pointer to the host name specified on the HTTP request sent by the client. If an absolute URI was used for the request, the host name is taken from the URI. Otherwise the host name is as specified in the Host header for the request. For HTTP/1.1 requests, a host name is required, so this parameter is always passed to the analyzer. For HTTP/1.0 requests, a host name might not be supplied, in which case the value is undefined.

End of change
wbra_http_version_length
(Input only)

For an HTTP request, the length in bytes of the string identifying the HTTP version of the client's request. If the request is not an HTTP request, the value is zero.

wbra_http_version_ptr
(Input only)

For an HTTP request, a pointer to the string identifying the HTTP version of the client's request. If the request is not an HTTP request, the value is undefined.

wbra_method_length
(Input only)

For an HTTP request, the length in bytes of the string identifying the method specified in the HTTP request. If the request is not an HTTP request, the value is zero.

wbra_method_ptr
(Input only)

For an HTTP request, a pointer to the method specified in the HTTP request. If the request is not an HTTP request, the value is undefined.

Start of changewbra_querystring_lengthEnd of change
Start of change(Input only)

The length in bytes of the query string specified on the HTTP request. If no query string was sent, the value is undefined.

End of change
Start of changewbra_querystring_ptrEnd of change
Start of change(Input only)

A pointer to the query string specified on the HTTP request sent by the client. If no query string was sent, the value is undefined.

End of change
wbra_reason
(Output only)

The reason code returned by the analyzer program. See Responses and reason codes.

wbra_request_header_length
(Input only)

For an HTTP request, the length of the first HTTP header in the HTTP request. If the request is not an HTTP request, the value is zero.

wbra_request_header_ptr
(Input only)

For an HTTP request, a pointer to the first HTTP header in the HTTP request. The other HTTP headers follow this one in the request buffer. If the request is not an HTTP request, the value is undefined.

wbra_request_type
(Input only)

If this is an HTTP request, the value is WBRA_REQUEST_HTTP. If this is not an HTTP request, the value is WBRA_REQUEST_NON_HTTP.

Start of changewbra_resource_escaped_ptrEnd of change
Start of change(Input only)

For an HTTP request, a pointer to a copy of the HTTP headers for the request which have not been unescaped (that is, are still in their escaped form).

End of change
wbra_resource_length
(Input only)

For an HTTP request, the length in bytes of the path component of the URL. If the request is not an HTTP request, the value is zero.

wbra_resource_ptr
(Input only)

For an HTTP request, a pointer to the path component of the URL. If a URIMAP definition is involved, this contains the value of the PATH attribute. If the request is not an HTTP request, the value is undefined.

wbra_response
(Output only)

The response value produced by the analyzer program. See Responses and reason codes.

wbra_server_ip_address
(Input only)

The 32-bit IP address that is being used by CICS as an HTTP server.

wbra_server_program
(Input and output)

A string of length 8. The name of a CICS application program that is to process the request. If a URIMAP definition is involved, this contains the value of the PROGRAM attribute. The program name is passed to any converter program specified in wbra_converter_program. If you do not set this field, the value passed is nulls. The program name must be set here or by the converter program, or no CICS application program will be called.

wbra_unescape
(Output only)
  • To specify that data is to be passed to the CICS application program in its unescaped form, set this parameter to WBRA_UNESCAPE_REQUIRED
  • To specify that data is be passed to the application in its escaped form, set this parameter to WBRA_UNESCAPE_NOT_REQUIRED. This is the default value.

    You should also set the parameter to WBRA_UNESCAPE_NOT_REQUIRED if your analyzer has converted the data to its escaped form.

Start of changewbra_urimapEnd of change
Start of change(Input only)

The name of any matching URIMAP definition that is involved in the processing path for the request. If this field is non-blank, the CICS-supplied default analyzer DFHWBADX returns without processing the path component of the URL.

End of change
wbra_user_data_length
(Input and output)

A 15–bit integer, representing the length of the entity body in the HTTP request. If the request is non-HTTP, this value is the length of the request. The length passed to the analyzer includes any trailing carriage return and line feed (CRLF) characters that may delimit the end of the entity body. If the analyzer reduces the length of the entity body, the newly redundant bytes are replaced by null characters, X'00'. The modified value is passed on to the CICS business logic interface in field wbbl_user_data_length, and to the converter program in field decode_user_data_length.

wbra_user_data_ptr
(Input only)

For an HTTP request, a pointer to the entity body in the HTTP request. If the request is not an HTTP request, this is a pointer to the request.

wbra_user_token
(Output only)

A 64-bit token that is passed to the converter program as decode_user_token. If you do not set this field, the value passed is null. If there is no converter program for this request, the value is ignored.

wbra_userid
Start of change(Input and output)

A string of length 8. On input, this is a user ID supplied by the client (using basic authentication or client certificate authentication), or if a URIMAP definition is involved, the value of the USERID attribute (if specified). On output, it is the user ID that is used for the alias transaction, which can be the supplied user ID or a user ID chosen by the analyzer program. If this field is blank or null on output, the CICS default user ID is used.

End of change