Containers used in the callback interface

The callback interface provides mandatory and optional containers as input to the registered program to create or manage a resource of a specific type.

CICS® initializes the containers when the bundle is deployed and links to the registered program using a channel called DFHRLVI-V1.

DFHRL-CONTROL container

DFHRL-CONTROL is a container of DATATYPE(CHAR). It contains the tokens for the bundle and the request to create, enable, disable, or discard a resource.

Table 1. Tokens contained in DFHRL-CONTROL
Field Type Description
rl_bundle_token char(8) An 8-byte token that represents the bundle
rl_resource_token char(8) An 8-byte token that represents the resource
rl_client_token char(8) An 8-byte token that represents the view of the resource that is held by the callback program.
rl_state bin(8) The state of the BUNDLE resource. This field can have one of the following values:
1
Enabling
2
Enabled
3
Disabling
4
Disabled
5
Discarding
6
Failed
7
Deleting
8
Discarded
rl_function bin(8) The action that is being performed by the system programmer. This field can have one of the following values:
0
Create bundle
1
Set bundle
2
Inquire bundle
3
Discard bundle
4
Inquire by name
5
Set modify

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.

DFHRL-DATA container

DFHRL-DATA is a container of DATATYPE(BIT) that contains the metadata for the user resource. The metadata is taken from the information provided by the manifest in the 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.

DFHRL-NAME container

DFHRL-NAME is a container of DATATYPE(CHAR). It contains a character string that represents the name of the resource in the deployed 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.

DFHRL-ROOT container

DFHRL-ROOT is a container of DATATYPE(CHAR). It contains the fully qualified path in the file system of the bundle directory.

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.

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.