Reference information for DFHWBEP, web error program

Attention: This topic contains Product-sensitive Programming Interface and Associated Guidance Information.
The names of the parameters and constants in the parameter list passed to the web error program DFHWBEP, translated into appropriate forms for the programming languages supported, are listed in the following table.
Language Parameters file
Assembler DFHWBEPD
C DFHWBEPH
COBOL DFHWBEPO
PL/I DFHWBEPL

Parameters

All DFHWBEP parameters are input only, except wbep_response_ptr and wbep_response_len, which are input and output, and wbep_suppress_abend and wbep_close_conn, which are output only.

wbep_abend_code
(Input only)

The 8-character abend code associated with this exception.

wbep_activity
(Input only)

The type of processing that was in progress when the error occurred. 0 indicates server processing and 2 indicates pipeline processing.

wbep_analyzer_reason
(Input only)

The reason code returned by the analyzer program, if invoked.

wbep_analyzer_response
(Input only)

The response code returned by the analyzer program, if invoked.

wbep_client_address
(Input only)

A 15–character field that must be set to the binary IPv4 address of the client, if wbep_client_ipv6_address is not specified. wbep_client_address does not support IPv6 addresses.

If there is a non-zero value in wbep_client_address, this value is used, and any value in wbep_client_ipv6_address is ignored. Therefore, if you are using IPv6 addressing you must clear the contents of wbep_client_address to allow the value in wbep_client_ipv6_address to be used.

wbep_client_ipv6_address
(Input only)

The colon hexadecimal IPv6 or dotted decimal IPv4 address of the client. This field can be up to 39 characters in length.

This field that must be set if you are using IPv6 addressing, or if you are using IPv4 addressing and wbep_client_address is not specified. This field supports both IPv4 and IPv6 addresses and is set to the binary IPv6 address of the client, or the IPv4 address of the client in IPv6 format. For more information on IP address format, see IP addresses.

wbep_client_address_len
(Input only)

The length of the dotted decimal IP address contained in wbep_client_address. This field contains zeros if the address is IPv6 format.

wbep_client_ipv6_address_len
(Input only)

The length of the IP address contained in wbep_client_ipv6_address or wbep_client_address.

wbep_close_conn
(Output only)

A 1-character field (Y or N) that indicates whether the connection is closed after the response is sent to the client. The default value of N indicates that the connection is not closed.

wbep_converter_program
(Input only)

The name of the converter program, if one is used, for the failing request.

wbep_converter_reason
(Input only)

The reason code returned by the converter program, if invoked.

wbep_converter_response
(Input only)

The response code returned by the converter program, if invoked.

wbep_error_code
(Input only)

The error code identifying the error detected.

wbep_eyecatcher
(Input only)

A character field containing an eyecatcher to help with diagnostics. DFHWBA sets this to >wbepca before calling the web error program.

wbep_failing_program
(Input only)

An 8-character field containing the name of the program in which the error occurred.

wbep_http_response_code
(Input only)

The default HTTP status code returned by CICS® for this error.

wbep_length
(Input only)

The length of the DFHWBEPC copybook.

wbep_message_len
(Input only)

The length of the CICS message text addressed by wbep_message_ptr.

wbep_message_number
(Input only)

A fullword number of the CICS WB domain message associated with the error.

wbep_message_ptr
(Input only)

A pointer to the CICS message text associated with this error.

wbep_response_len
(Input and output)

On input, this field is the fullword length of the default HTTP response for this error. CICS provides only a default response for HTTP requests; for non-HTTP requests, this field is zero. On output, this field contains the length of the default HTTP response, or of a modified response in the same block of storage, or of a replacement response in a new block of storage.

wbep_response_ptr
(Input and output)

On input, pointer points to a block of storage containing the default HTTP response for this error. CICS provides only a default response for HTTP requests. The default response is a complete HTTP response, including a status line, HTTP headers and message body. On output, this pointer either points to the same block of storage, containing the original or a modified version of the default response, or a pointer to a new block of storage containing a replacement response. If DFHWBEP successfully uses the EXEC CICS WEB SEND command to create a new response and sends it to the web client, CICS ignores and discards the HTTP response in the block of storage. Otherwise, the response in the block of storage is sent to the web client.

wbep_server_address
(Input only)

The 15-character IPv4 address of the server (CICS as an HTTP server) that must be set, if wbep_server_ipv6_address is not specified. wbep_server_address does not support IPv6 addresses.

If there is a non-zero value in wbep_server_address, this value is used, and any value in wbep_server_ipv6_address is ignored. Therefore, if you are using IPv6 addressing you must clear the contents of wbep_server_address to allow the value in wbep_server_ipv6_address to be used.

wbep_server_ipv6_address
(Input only)

A 16-byte field that must be set if you are using IPv6 addressing, or if you are using IPv4 addressing and wbep_server_address is not specified. This field supports both IPv4 and IPv6 addresses and is set to the binary IPv6 address of the server (CICS as an HTTP server), or the IPv4 address of the server in IPv6 format. For more information on IP address format, see IP addresses.

wbep_server_address_len
(Input only)

The length of the dotted decimal IPv4 address contained in wbep_server_address. This field contains zeros if the address is IPv6 format.

wbep_server_ipv6_address_len
(Input only)

The length of the IP address contained in wbep_server_ipv6_address or wbep_server_address.

wbep_target_program
(Input only)

The target user-written application program that is designated to handle the web client request.

wbep_tcpipservice_name
(Input only)

The name of the TCPIPSERVICE definition for the port on which the request is received.

wbep_version
(Input only)

A halfword binary number that indicates which version of the parameter list is currently being used. It is set using the constant value wbep_current_version.

wbep_suppress_abend
(Output only)

A 1-bit flag which, when set on, suppresses the abend AWBM.



dfhtlbv.html | Timestamp icon Last updated: Thursday, 27 June 2019