CONTROL BLOCK NAME = DFHEPDEC
FUNCTION
The EPDE is a definition of the DFHEP.DESCRIPTOR container that
describes the data captured for a CICS EVENT and the formatting
attributes specified for the event data.
A CICS EVENT object consists of the following containers named
DFHEP.xxxxx
ADAPTER
A container for the EPAdapter configuration.
ADAPTPARM
A container for the EPAdapter invocation parms.
CONTEXT
A container for the contextual data common to all events.
DESCRIPTOR
A container describing the list of capture data items.
DFHEP.CHAR.nnnnn
A container for each captured data item where nnnnn is a 5
decimal digit sequence number that indicates the ordering of the
captured data starting at '00001'. These containers contain the
capture data in a printable form formatted as requested when
defining the Emitted Business Information in the Event Binding
editor.
DFHEP.DATA.nnnnn
A container for each captured data item where nnnnn is a 5
decimal digit sequence number that indicates the ordering of the
captured data starting at '00001'. These containers contain the
raw unformatted capture data.
The DESCRIPTOR is created from the XML definition of an event
which is, normally, created using the CICS event binding editor
and installed into CICS via a BUNDLE.
Each CICS event object passed to an EP adapter contains a
DFHEP.DESCRIPTOR container. This container has a prefix and an
array of item definitions, one per data item captured, so that the
DFHEP.DATA.nnnnn container will hold the data corresponding to the
nth item in the EPDE_Item array.
Each item in the DESCRIPTOR array defines the type of the source
data captured and the required length and type of that data
when/if it is formatted. The source data type is given in field
EPDE_DataType and can take any of the following values:
PACKED
Packed decimal.
ZONED
Zoned decimal.
HEX
Hexadecimal.
UHWORD
Unsigned halfword.
UFWORD
Unsigned fullword.
SHWORD
Signed halfword.
SFWORD
Signed fullword.
CHAR
Character.
HEXFLOAT
Hexadecimal floating point (HFP).
BINFLOAT
Binary floating point (BFP).
DECFLOAT
Decimal floating point (DFP).
HEXZ
Null terminated hexadecimal.
CHARZ
Null terminated character. :edl
Notes:
- The sign in zoned decimal data captured from COBOL programs
may be leading or trailing, and either separate or included in
the numeric data.
- We distinguish between CHAR and CHARZ, HEX and HEXZ for
information only. The data captured does not include the
terminating null.
The captured data will be exactly as found in the source data.
Its length can be derived from the length of the data container.
Whatever data is available up to the length specified in the
capture data item spec will be captured. If the capture data is
not available then the corresponding DFHEP.DATA and DFHEP.CHAR
containers will not be created.
--------------------------------------------------------------------
Table 1.
Offset Hex |
Type |
Len |
Name (Dim) |
Description |
(0) |
STRUCTURE |
12 |
EPDE |
Event descriptor data |
(0) |
CHARACTER |
12 |
EPDE_PREFIX |
Fixed length prefix |
(0) |
CHARACTER |
4 |
EPDE_STRUCID |
Structure identifier EPDE |
(4) |
FULLWORD |
4 |
EPDE_VERSION |
Version of this structure |
(8) |
HALFWORD |
2 |
EPDE_ITEMLENGTH |
Length of a data item |
(A) |
HALFWORD |
2 |
EPDE_ITEMCOUNT |
Number of data items |
(C) |
CHARACTER |
0 |
EPDE_PREFIXEND |
Start of descriptor array |
Table 2.
Offset Hex |
Type |
Len |
Name (Dim) |
Description |
(0) |
STRUCTURE |
68 |
EPDE_ITEM |
Data descriptor item array |
(0) |
CHARACTER |
32 |
EPDE_DATANAME |
Data item name |
(20) |
CHARACTER |
8 |
EPDE_DATATYPE |
Data type code |
(28) |
FULLWORD |
4 |
EPDE_DATAPRECISION |
Data precision |
(2C) |
CHARACTER |
16 |
EPDE_FORMATTYPE |
Formatting data type |
(3C) |
FULLWORD |
4 |
EPDE_FORMATLEN |
Formatting length |
(40) |
FULLWORD |
4 |
EPDE_FORMATPRECISION |
Formatting precision |
Table 3.
Len |
Type |
Value |
Name |
Description |
Values of strucid
|
4 |
CHARACTER |
EPDE |
EPDE_STRUC_ID |
Values of version
|
2 |
DECIMAL |
1 |
EPDE_VERSION_1 |
2 |
DECIMAL |
1 |
EPDE_CURRENT_VERSION |
Values of EPDE_DataType
|
8 |
CHARACTER |
PACKED |
EPDE_PACKED |
8 |
CHARACTER |
ZONED |
EPDE_ZONED |
8 |
CHARACTER |
HEX |
EPDE_HEX |
8 |
CHARACTER |
UHWORD |
EPDE_UHWORD |
8 |
CHARACTER |
UFWORD |
EPDE_UFWORD |
8 |
CHARACTER |
SHWORD |
EPDE_SHWORD |
8 |
CHARACTER |
SFWORD |
EPDE_SFWORD |
8 |
CHARACTER |
CHAR |
EPDE_CHAR |
8 |
CHARACTER |
HEXFLOAT |
EPDE_HEXFLOAT |
8 |
CHARACTER |
BINFLOAT |
EPDE_BINFLOAT |
8 |
CHARACTER |
DECFLOAT |
EPDE_DECFLOAT |
8 |
CHARACTER |
HEXZ |
EPDE_HEXZ |
8 |
CHARACTER |
CHARZ |
EPDE_CHARZ |
Values of EPDE_FormatType
|
16 |
CHARACTER |
text |
EPDE_TEXT |
16 |
CHARACTER |
numeric |
EPDE_NUMERIC |
16 |
CHARACTER |
scientific |
EPDE_SCIENTIFIC |
Values of EPDE_FormatLen
|
4 |
DECIMAL |
0 |
EPDE_FORMATLEN_AUTO |
Values of EPDE_FormatPrecision
|
4 |
DECIMAL |
-1 |
EPDE_FORMATPREC_AUTO |