CICS flattened event (CFE) data formats

When you specify an event binding using an EP adapter with the CICS flattened event format, the data items in your event are emitted as a single event record. The event processing support in CICS processes the data in an event specification according to a set of rules.

You can use the Event binding editor to export a COBOL copybook that describes the event structure if you want to understand the data formats used in your event.

Exporting an event specification from the Event binding editor uses the same rules to create the exported copybook, so you would not normally need to understand these rules. However, understanding the rules can help you to identify the source of data formatting errors that can affect event processing. The format of an individual data item is based on the type, length, and precision you specify when defining an emitted business information item in an event specification, and the type, length and precision you specify when defining the corresponding information source in the capture specification.

  • When the emitted business information is formatted as text the information is left-aligned and blank padded.
  • When the emitted business information is formatted as numeric the information is right-aligned and leading zeros are added as required.
  • When the emitted business information is formatted as scientific a number is left-aligned and blank padded in normalized E format with the (formatPrecision) specified number of digits after the decimal point in the mantissa. The format is ±d[.d...]E±ddd... where [d...] represents one or more digits; for example, +1E+oo3, −1.25E+000, +9.999999E−316, +0E+000. If the specified format length is not enough for the data formatted as numeric or scientific data, number, the output area is filled with asterisks (*); text data is truncated..
Floating point data that is formatted as text or numeric has the following characteristics:
  • Any nonzero precision must be less than or equal to the format length − 3 to allow for a sign, at least one leading digit, and a decimal point.
  • Data with a format length of Automatic contains all significant whole (integer) digits.
  • Data with a format precision of Automatic contains all significant fractional digits, unless this is precluded by an explicit format length.
Floating point data that is formatted as scientific has the following characteristics:
  • CICS EP adapters enforce a maximum format precision (number of mantissa digits after the decimal point) of 6 for short and 15 for long floating point numbers.
  • Data with a format precision of Automatic and a format length of Automatic contains all significant fractional digits.

    Padded as necessary to the maximum size for the data captured, short floating point results in a 14-byte character string (+n.nnnnnnE+nnn) and long floating point results in a 23-byte string (+n.nnnnnnnnnnnnnnnE+nnn).

  • Data with a format precision of Automatic and an explicit format length could have the precision reduced or the data padded on the right with blanks. In this case, the precision must be ≤ format length −8.
  • Data with a format length of Automatic and an explicit format precision that is greater than 0 has a fixed length based on the format precision plus 8.

Filter and capture precision are meaningless for floating point data types and are ignored at event binding installation if they are set.

When the number is +∞, ∞, or NaN (not a number), the output area is formatted as INF, −INF, and NaN.

Note: When a mantissa is shortened to fit the specified formatPrecision, there is no rounding. However, rounding might occur in the conversion from hexadecimal floating point (HFP) or binary floating point (BFP) to decimal.

Information source field with capture type character

Emitted Business Information Information Source COBOL Copybook Comments
Type Length Length Length Format  
text r n r X(r)
  • If r<n, the field is truncated.
  • If r>n, the field is blank padded.
numeric r n r X(r)
  • If r<n the field is set to all asterisks.
  • If r>n the field is blank padded.
text or numeric 0 n n X(n) When exporting an event specification, n is taken from the first capture specification.

When CICS is processing a capture specification with a field of this type, n is taken from the current capture specification.

text or numeric 0 0     You cannot export an event specification with a field of this type with a length of zero.

When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted.

Information source field with capture type hexadecimal

Emitted Business Information Information Source COBOL Copybook Comments
Type Length Length Length Format  
text r n r "0x"||X(r-2)
  • If r<(n*2)+2, the field is truncated.
  • If r>(n*2)+2 the field is blank padded.
numeric r n r "0x"||X(r-2)
  • If r<(n*2)+2 the field is set to all asterisks.
  • If r>(n*2)+2 the field is zero padded.
text or numeric 0 n 2+(n*2) "0x"||X(n*2) When exporting an event specification, n is taken from the first capture specification.

When CICS is processing a capture specification with a field of this type, n is taken from the current capture specification.

text or numeric 0 0     You cannot export an event specification with a field of this type with a length of 0.

When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted.

Information source field with capture type halfword

The table applies to information source fields with Capture Type Unsigned Halfword and Signed Halfword.

Emitted Business Information Information Source COBOL Copybook Comments
Type Format length Format precision Length Length Format
numeric r 0 2 r +9(r-1)
  • If r-1<digits, the field is set to all asterisks.
  • If r-1>digits, the field is zero padded.
numeric r s 2 r +9(r-s-2).9(s)
  • If r-s-2<digits are required, the field is set to all asterisks.
  • If r-s-2>digits are required, the field is zero padded.
numeric Automatic 0 2 6 +9(5)  
numeric Automatic s 2 7+s +9(5).9(s)  

Information source field with capture type fullword

The table applies to information source fields with capture type unsigned and signed fullword.

Emitted Business Information Information Source COBOL Copybook Comments
Type Format length Format precision Length Length Format
numeric r 0 4 r +9(r-1)
  • If r-1<digits are required, the field is set to all asterisks.
  • If r-1>digits, the field is zero padded.
numeric r s 4 r +9(r-s-2).9(s)
  • If r-s-2<digits are required, the field is set to all asterisks.
  • If r-s-2>digits, the field is zero padded.
numeric Automatic 0 4 11 +9(10)  
numeric Automatic s 4 12-p+s +9(10-p).9(s)  

Information source field with capture type packed decimal

Emitted Business Information Information Source COBOL Copybook Comments
Type Format length Format precision Length Precision Length Format
numeric r 0 n p r +9(r-1)
  • If r-1<digits required, the field is set to all asterisks.
  • If r-1>digits, the field is zero padded.
numeric r s n p r +9(r-s-2).9(s)
  • If r-s-2<digits required, the field is set to all asterisks.
  • If r-s-2>digits, the field is zero padded.
numeric r Automatic n p r +9(r−p−2).9(p)
  • If r-p-2<digits required, the field is set to all asterisks.
  • If r-p-2>digits, the field is zero padded.
numeric Automatic 0 n p n*2-p +9(n*2-1-p)
  • If p>=n*2-1, the field is formatted as +9(1).
  • When CICS is processing a capture specification with a field of this type, n is taken from the current capture specification.
  • When exporting an event specification, n is taken from the first capture specification.
numeric Automatic s n p 1+n*2-p+s +9(n*2-1-p).9(s)
  • If p>=n*2-1, the field is formatted as +9(1).9(s).
  • When CICS is processing a capture specification with a field of this type n is taken from the current capture specification.
  • When exporting an event specification, n is taken from the first capture specification.
numeric Automatic Automatic n p 1+n *2+p +9(n *2−1−p).9(p)
  • If p>=n*2-1, the field is formatted as +9(1).9(p).
  • When CICS is processing a capture specification with a field of this type n is taken from the current capture specification.
  • When exporting an event specification, n is taken from the first capture specification.
numeric Automatic 0 0 p    
  • When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted, with precision 0.
  • You cannot export an event specification with a field of this type with a length of zero.
numeric Automatic s 0 p    
  • When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted, with precision s.
  • You cannot export an event specification with a field of this type with a length of zero.
numeric Automatic Automatic 0 p    
  • When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted, with precision p.
  • You cannot export an event specification with a field of this type with a length of zero.

Information source field with capture type zoned decimal

The CICS EP adapters include support for zoned decimal data whose sign position or representation has been specified using the COBOL SIGN clause (SEPARATE, LEADING, LEADING SEPARATE, TRAILING, and TRAILING SEPARATE).

Emitted Business Information Information Source COBOL Copybook Comments
Type Format length Format precision Length Precision Length Format
numeric r 0 n p r +9(r-1)
  • If r-1<digits required, the field is set to all asterisks.
  • If r-1>digits required, the field is zero padded.
numeric r s n p r +9(r-s-2).9(s)
  • If r−s−2<digits required, the field is set to all asterisks.
  • If r−s−2>digits required, the field is zero padded.
numeric r Automatic n p r +9(r−p−2).9(p)
  • If r−p−2<digits required, the field is set to all asterisks.
  • If r−p−2>digits required, the field is zero padded.
numeric Automatic 0 n p 1+n−p +S9(n−p)
  • If p>=n, the field is formatted as +9(1).
  • When CICS is processing a capture specification with a field of this type, n is taken from the current capture specification.
  • When exporting an event specification, n is taken from the first capture specification.
numeric Automatic s n p 1+n−p+s +9(n−p).9(s)
  • If p>=n, the field is formatted as +9(1).9(s).
  • When CICS is processing a capture specification with a field of this type, n is taken from the current capture specification.
  • When exporting an event specification, n is taken from the first capture specification.
numeric Automatic Automatic n p 1+n +p +9(n −p).9(p)
  • If p>=n, the field is formatted as +9(1).9(p).
  • When CICS is processing a capture specification with a field of this type, n is taken from the current capture specification.
  • When exporting an event specification, n is taken from the first capture specification.
numeric Automatic 0 0 p    
  • When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted, with precision 0.
  • You cannot export an event specification with a field of this type with a length of zero.
numeric Automatic s 0 p    
  • When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted, with precision s.
  • You cannot export an event specification with a field of this type with a length of zero.
numeric Automatic Automatic 0 p    
  • When CICS is processing a capture specification with a field of this type, all of the data that is available is emitted, with precision p.
  • You cannot export an event specification with a field of this type with a length of zero.

Information source field with capture type short float

Emitted Business Information Information Source COBOL Copybook Comments
Type Format length Format precision Length Length Format
scientific r 0 4 r X(r)
  • If r<7, the field is set to all asterisks.
  • Data format is +9E+999 and is padded on the right with blanks to length r.
scientific r s 4 r X(r)
  • If r<7, the field is set to all asterisks.
  • If r<s+8, the precision is reduced as necessary.
  • Data format is +9.9(s)E+999 and is padded on the right with blanks to length r.
scientific r Automatic 4 r X(r)
  • If r<7, the field is set to all asterisks.
  • If r<14, the precision is reduced as necessary.
  • Data format is +9.9(6)E+999 and is padded on the right with blanks to length r.
scientific Automatic 0 4 7 X(7)

Data format is +9.9E+999.

scientific Automatic s 4 s+8 X(s+8)

Data format is +9.9(s)E+999.

scientific Automatic Automatic 4 14 X(14)

Data format is +9.9(6)E+999.

numeric r 0 4 r +9(r−1)
  • If r−1<digits required, the field is set to all asterisks.
  • If r−1>digits required, the field is zero padded.
numeric s r 4 r +9(r−s−2).9(s)
  • If r−s−2<digits required, the field is set to all asterisks.
  • If r−s−2>digits required, the field is zero padded.
numeric r Automatic 4 r X(r)

When CICS is processing a capture specification with a field of this type, the number is formatted with as much precision as possible within the format length r.

If the number of whole number digits that is required exceeds r, the field is set to all asterisks.

numeric Automatic 0 4    

When CICS is processing a capture specification with a field of this type, the number is formatted with as much precision as possible within the format length r.

You cannot export an event specification with a field of this type.

numeric Automatic s 4    
  • When CICS is processing a capture specification with a field of this type, the number is formatted with:
    • A sign
    • As many whole digits as required
    • s digits after the decimal point.
  • You cannot export an event specification with a field of this type.
numeric Automatic Automatic 4    
  • When CICS is processing a capture specification with a field of this type, the number is formatted with:
    • A sign
    • As many whole digits as required
    • As many digits after the decimal point as required.
  • You cannot export an event specification with a field of this type.

Information source field with capture type long float

Emitted Business Information Information Source COBOL Copybook Comments
Type Format length Format precision Length Length Format
scientific r 0 8 r X(r)
  • If r<7, the field is set to all asterisks.
  • Data format is +9E+999 and is padded on the right with blanks to length r.
scientific r s 8 r X(r)
  • If r<7, the field is set to all asterisks.
  • Data format is +9.9(s)E+999 and is padded on the right with blanks to length r.
  • If r<s+8, the precision is reduced as necessary.
scientific r Automatic 8 r X(r)
  • If r<7, the field is set to all asterisks.
  • If r<23, the precision is reduced as necessary.
  • Data format is +9.9(15)E+999 and is padded on the right with blanks to length r.
scientific Automatic 0 8 7 X(7)

Data format is +9.9E+999.

scientific Automatic s 8 s+8 X(s+8)

Data format is +9.9(s)E+999.

scientific Automatic Automatic 8 23 X(23)

Data format is +9.9(15)E+999.

numeric r 0 8 r +9(r−1)
  • If r−1<digits required, the field is set to all asterisks.
  • If r−1>digits required, the field is zero padded.
numeric s r 8 r +9(r−s−2).9(s)
  • If r−s−2<digits required, the field is set to all asterisks.
  • If r−s−2>digits required, the field is zero padded.
numeric r Automatic 8 r X(r)

When CICS is processing a capture specification with a field of this type, the number is formatted with as much precision as possible within the format length r.

If the number of whole number digits that is required exceeds r, the field is set to all asterisks.

numeric Automatic 0 8    

When CICS is processing a capture specification with a field of this type, the number is formatted with as much precision as possible within the format length r.

You cannot export an event specification with a field of this type.

numeric Automatic s 8    
  • When CICS is processing a capture specification with a field of this type, the number is formatted with:
    • A sign
    • As many whole digits as required
    • s digits after the decimal point.
  • You cannot export an event specification with a field of this type.
numeric Automatic Automatic 8    
  • When CICS is processing a capture specification with a field of this type, the number is formatted with:
    • A sign
    • As many whole digits as required
    • As many digits after the decimal point as required.
  • You cannot export an event specification with a field of this type.


dfhep_event_processing_cfe_export_formats.html | Timestamp icon Last updated: Monday, 5 June 2017