Containers used in the registration interface

The registration interface provides mandatory and optional containers that your program can use to register a specific resource type with CICS®.

DFHRL-ACTION container

DFHRL-ACTION is a container of DATATYPE(CHAR). It contains a character string to specify whether the callback program is to be registered or deregistered with CICS.

This container can contain one of the following values:

REGISTER
Register the callback program with CICS to handle the specified resource type.
DEREGISTER
Deregister the callback program with CICS. Any new bundles that are deployed into the CICS region containing the resource type managed by this program will fail unless you register another program.

The container is defined in the DFHRLUCx copybooks, where x represents the programming language. These copybooks are in the CICSTSnn.CICS.SDFHSAMP library, where CICSTSnn is your CICS release. For example, the library is CICSTS63.CICS.SDFHSAMP for CICS TS 6.3.

This container is used only with channel DFHRLVC-V1 for the bundle registration interface.

DFHRL-ERROR container

DFHRL-ERROR is a container of DATATYPE(BIT). It is an output container that contains an error code if CICS cannot register the callback program.

This container has the following structure:

Field Type Description
rl_error_major_version bin(31) The major version number of the error container. This value is 1.
rl_error_minor_version bin(31) The minor version number of the error container. This value is 0.
rl_error_code bin(8) The following error codes are possible:
1
The callback program is already registered.
2
The callback program is already deregistered.
3
The function is not valid.
4
A container is missing on the channel.
5
Container type is not valid. A container has DATATYPE(CHAR) rather than DATATYPE(BIT) or vice versa.
6
A container has content that is not valid.
7
The channel name is not valid.
8
No channel was passed to CICS.
9
There was an internal error
rl_error_container char(16) The name of the container that is in error. This field is populated when the error code is 4, 5, or 6.

The container is defined in the DFHRLUCx copybooks, where x represents the programming language. These copybooks are in the CICSTSnn.CICS.SDFHSAMP library, where CICSTSnn is your CICS release. For example, the library is CICSTS63.CICS.SDFHSAMP for CICS TS 6.3.

This container is used only with channel DFHRLVC-V1 for the bundle registration interface.

DFHRL-PROGRAM container

The container is defined in the DFHRLUCx copybooks, where x represents the programming language. These copybooks are in the CICSTSnn.CICS.SDFHSAMP library, where CICSTSnn is your CICS release. For example, the library is CICSTS63.CICS.SDFHSAMP for CICS TS 6.3.

This container is used only with channel DFHRLVC-V1 for the bundle registration interface.

DFHRL-TYPE container

DFHRL-TYPE is a container of DATATYPE(CHAR). It contains a URI that describes the type of resource that the callback program can manage in a bundle.

The container is defined in the DFHRLUCx copybooks, where x represents the programming language. These copybooks are in the CICSTSnn.CICS.SDFHSAMP library, where CICSTSnn is your CICS release. For example, the library is CICSTS63.CICS.SDFHSAMP for CICS TS 6.3.

This container is used only with channel DFHRLVI-V1 for the bundle callback interface or channel DFHRLVC-V1 for the bundle registration interface.