Data captured for a policy event
Unlike standard CICS® events, the data that is captured for a policy event is predetermined and you cannot customize it. You will need to know what data is captured when you consume CFE format policy events that are emitted by one of the supported event processing (EP) adapters, when you write a program invoked for a CICS transaction started by the transaction start EP adapter or when you write your own custom EP adapter.
Policy events that are emitted in the CFE format by the transient data queue (TDQ) EP adapter, the temporary storage queue (TSQ) EP adapter, or the IBM® MQ EP adapter can be mapped by using CICS-supplied mapping structures. For more information, see Policy event in CFE format.
When you format and emit policy events with a custom EP adapter, or consume events in a program invoked for a
CICS transaction started by the transaction start EP adapter you need to
know which DFHEP.NAME.nnnnn container contains each item data captured for a policy event.
Table 1 shows
the name and size of the CICS containers for each item of
capture data common to all policy events.
Table 2 lists the additional CICS containers for task
rules. Table 3 through Table 9 shows the additional containers for each
type of system rule.
The names for each item of capture data are also available in the
DFHEP.DESCRIPTOR container that is passed to a custom EP adapter, or the
DFHEP.NAME.nnnnn containers that are passed to tasks started by the transaction start EP adapter.
For more information about writing a custom EP adapter to format and emit a policy event, see Custom EP adapter.
For more information about writing a program that is invoked by a CICS transaction started by the transaction start EP adapter to consume policy events, see Transaction start EP adapter.

| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00001 | 10 | Event version number | version |
| DFHEP.DATA.00002 | 7 | Task number | task_id |
| DFHEP.DATA.00003 | 4 | CICS TRANSACTION name | transaction_id |
| DFHEP.DATA.00004 | 8 | User identifier | user_id |
| DFHEP.DATA.00005 | 8 | Program name | program_name |
| DFHEP.DATA.00006 | 64 | Policy name | policy_name |
| DFHEP.DATA.00007 | 64 | Rule name | rule_name |
| DFHEP.DATA.00008 | 64 | Rule group | rule_group |
| DFHEP.DATA.00009 | 16 | Rule type, for example "storage" | rule_type |
| DFHEP.DATA.00010 | 8 | Bundle name of the CICS BUNDLE that contains the policy | bundle_name |
| DFHEP.DATA.00011 | 10 | Bundle major version | bundle_version_major |
| DFHEP.DATA.00012 | 10 | Bundle minor version | bundle_version_minor |
| DFHEP.DATA.00013 | 10 | Bundle micro version | bundle_version_micro |
| DFHEP.DATA.00014 | 64 | CICS Bundle Project name | bundle_id |
| DFHEP.DATA.00015 | 8 | User tag | policy_user_tag |
| DFHEP.DATA.00016 | 64 | Platform name | platform_name |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 64 | Application name | application_name |
| DFHEP.DATA.00018 | 10 | Application major version | application_version_major |
| DFHEP.DATA.00019 | 10 | Application minor version | application_version_minor |
| DFHEP.DATA.00020 | 10 | Application micro version | application_version_micro |
| DFHEP.DATA.00021 | 64 | Operation name | operation |
| DFHEP.DATA.00022 | 16 | Rule category, for example "task24" | rule_category |
| DFHEP.DATA.00023 | 2 | Rule operator, for example "GT" | rule_operator |
| DFHEP.DATA.00024 | 16 | Rule threshold, for example "22048" | rule_threshold |
| DFHEP.DATA.00025 | 16 | Current count, for example "2200" | current_count |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 4 | DB2 ID, for example "DJ2C" | db2id |
| DFHEP.DATA.00018 | 4 | DB2 group ID, for example "GRP1" | db2groupid |
| DFHEP.DATA.00019 | 4 | DB2 release, for example "1110" | db2release |
| DFHEP.DATA.00020 | 12 | FROM connection status, for example "NOTCONNECTED" | from_connectst |
| DFHEP.DATA.00021 | 12 | TO connection status, for example "CONNECTED" | to_connectst |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 8 | File name, for example "FILEA" | file |
| DFHEP.DATA.00018 | 44 | Dataset name, for example "CICSUSER.FILEA" | dsname |
| DFHEP.DATA.00019 | 12 | FROM file enable status, for example "ENABLED" | from_enablestatus |
| DFHEP.DATA.00020 | 12 | TO file enable status, for example "DISABLED" | to_enablestatus |
| DFHEP.DATA.00021 | 12 | File open status, for example "CLOSED" | openstatus |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 8 | File name, for example "FILEA" | file |
| DFHEP.DATA.00018 | 44 | Dataset name, for example "CICSUSER.FILEA" | dsname |
| DFHEP.DATA.00019 | 12 | FROM file open status, for example "OPEN" | from_openstatus |
| DFHEP.DATA.00020 | 12 | TO file open status, for example "CLOSED" | to_openstatus |
| DFHEP.DATA.00021 | 12 | File enable status, for example "ENABLED" | enablestatus |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 9 | Message ID, for example "DFHFC0208" | message_id |
| DFHEP.DATA.00018 | 1024 | Message text, for example "DFHFC0208 MYAPPLID LSR pool 1 ..." | message_text |
| DFHEP.DATA.00019 | 255 | Insert 1, for example "MYAPPLID" | insert1 |
| DFHEP.DATA.00020 | 255 | Insert 2, for example "1" | insert2 |
| DFHEP.DATA.000nn | 255 | Insert nn | insertnn |
| DFHEP.DATA.00048 | 255 | Insert 30 | insert30 |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 8 | Transaction class name, for example "DFHTCL01" | tranclass |
| DFHEP.DATA.00018 | 10 | FROM active tasks in tranclass, for example "50" | from_active |
| DFHEP.DATA.00019 | 10 | TO active tasks in tranclass, for example "51" | to_active |
| DFHEP.DATA.00020 | 10 | MAXACTIVE tasks for tranclass, for example "100" | max_active |
| DFHEP.DATA.00021 | 10 | Percentage of MAXACTIVE tasks, for example "50" | percent_maxactive |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 4 | Transaction ID, for example "ABND" | transaction |
| DFHEP.DATA.00018 | 4 | Transaction abend code, for example "ASRA" | abcode |


| Container name | Container size in bytes | Contents | Capture data item name |
|---|---|---|---|
| DFHEP.DATA.00017 | 10 | FROM active user tasks, for example "120" | from_tasks |
| DFHEP.DATA.00018 | 10 | TO active user tasks, for example "121" | to_tasks |
| DFHEP.DATA.00019 | 10 | MXT tasks, for example "200" | maxtasks |
| DFHEP.DATA.00020 | 10 | Percentage of MXT tasks, for example "60" | percent_maxtasks |

If your policy events are consumed by a CICS program that is running under a CICS task that is started by the transaction start EP adapter, the policy event data is passed to the program in containers with the same names as listed in Table 1 through Table 9. The capture item names are passed in corresponding DFHEP.NAME.nnnnn containers. For more information about the container-based event (CCE) format that is used to pass event data to a CICS program, see CICS container-based event (CCE) format.
The CICS bundle project schemas in the zFS directory /usr/lpp/cicsts/cicsts54/schemas/policy contains the XML schemas that describe the payload of both task and system rule policy events in all the XML formats that are supported by CICS event processing:
| XML format | Task rule schema | System rule schema![]() |
Description |
|---|---|---|---|
| CBE or CBER | task_rules_cbe_payload.xsd |
![]() db2Connection_rule_cbe.xsd ![]() |
Contain the schemas for policy events in the Common base event (CBE) or Common based event REST (CBER) formats. These schemas can be imported into IBM Business Monitor to allow it to consume policy events. |
| DSIE | task_rules_dsie.xsd |
![]() db2Connection_rule_dsie.xsd ![]() |
Contain the schemas for policy events in the Decision Server Insights Event (DSIE) format. These schemas can be imported by the Decision Server Insights component of IBM Operational Decision Manager to allow it to consume policy events. |
| WBE | task_rules_wbe.xsd |
![]() db2Connection_rule_wbe.xsd ![]() |
Contain the schemas for policy events in the WebSphere Business Events (WBE) format. These schemas can be imported by the Decision Server Events component of IBM Operational Decision Manager to allow it to consume policy events. |