Format specifications

COUNT

Data begins with a 1-byte subfield count (for example, SMF 35 TLGNBRAC)

NOCOUNT

Subfield count is omitted (for example, SMF30ACT)

IntType

One of the integer types from the Integer types table

precision

Number of digits to the right of the decimal point

Enter a number from 1 to 9.

bitTableName

Label of a previously defined BITs statement

By convention, bit definition tables have names that begin with B_. The name is not case-sensitive.

intType

Any of the integer types from the Integer types table except UCharUChar and UNiblUNibl

additionalErgo

Additional ERGOnomic value (in addition to zero) that is suppressed if OPTIONS FORMAT(ERGO) is specified

For more information, see the FORMat(format) parameter of the OPTIONS statement.

Specify a numeric operand no larger than the specified integer type.

This operand is required if you specify the mask or MSB operand, but you can enter an additionalErgo value of 0. 

mask

If you omit the operand, all bits of the integer are used in the formatting.

MSB

Bits to be processed, starting with the most significant bit

If you omit the operand, bits are processed from least to most significant.

intType

Any of the integer types from the Integer types table

mask

Bit or bits to be tested

If you code a mask that specifies more than one bit, then ALL | ANY determines whether all of the bits must be on, or any of the bits can be on, for the FBool to format the true value (typically Yes).

ALL|ANY

Whether all of the bits in the mask, or any of the bits in the mask, must be on in order for FBool to format the true value (typically Yes)

This operand has no meaning if mask specifies only a single bit.

If you omit the operand, it defaults to ALL.

length

Length of the value

This operand is optional.

SUB

Substitute a period for any non-printable characters in the data

For FCharX, SUB is accepted but is meaningless; if the data contains non-printable characters the field is formatted in hexadecimal.) SUB slightly increases FChar overhead.

TB

Preserve trailing blanks in the data

If you omit the operand, then remove trailing blanks in the data.

XP

Check the field’s value for transparency

Do not specify XP unless the field possibly contains equal signs, backslashes, quotation marks, or embedded (non-trailing) blanks because XP increases the overhead to process the field.

If XP is specified, then certain characters are escaped appropriately if SIEMtype is CEF or SPLUNK. XP is optional; if you omit the operand, do not check the value for transparency.

UChar|UHalf|UShort

Format of the length prefix

adjust

Amount to be added to (or, by implication, subtracted from) the encoded length to compute the actual length of the character string itself

For example, it is common for length fields of this sort to include their own length in their value; in that case you would code an adjust value of -1 or -2.

You must code adjust (possibly as 0) if you also specify a maximum length; if you omit the operand, the default value is 0.

length

Specifies the maximum length of the character string

If you omit the operand, the maximum length defaults to the length returned by the Get specification.

TB

Specifies that you should preserve trailing blanks in the data

If you omit the operand, then any trailing blanks in the data are removed.

XP

Specifies that you should check the field’s value for transparency

Do not specify XP unless the field is likely to contain equal signs, backslashes, quotation marks, or embedded (non-trailing) blanks because XP increases the overhead to process the field.

If XP is specified, then certain characters are escaped appropriately if SIEMtype is CEF or SPLUNK. XP is optional; if you omit the operand, the value is not checked for transparency.

mapLabel

Label of a previously-defined MAP statement

The name is not case-sensitive. By convention, map labels begin with M_.

intType

Any of the integer types from the Integer types table except UCharUChar and UNiblUNibl.

mask

length

Maximum length of the value

If you omit the operand, the lesser of 999 or the length returned by the Get specification is used.

maxLength

Maximum length of the entire group of fields in the formatted syslog message

If you omit the operand, the aggregate length of the group is limited only by MAXMSGLEN.

delimType

Format the type of delimiter between fields of the list

Specify None or Inner. If you specify Inner then the delimiters are as specified by third and fourth sub-operands of the OPTIONS DELIM parameter, or as modified by OPTIONS SIEMtype.

fieldName fieldName …

List of the names of two or more previously-defined Fields

The FFlistfields might include FFlist fields; in other words, you might nest FFlists.

floatType

One of the float types from the Float types table

SUPPXFF

(Optional) If SUPPXFF is coded, then any value of X'FFF…' (binary minus one) is suppressed (not formatted) in accordance with the usage by Db2 of the SQLCA field SQLERRD(4).

(SPE2201)CANON

(Optional) Forces the FFloat number to display the decimal floating point number with precision 6

The output is not displayed as a scientific notation.

length

Maximum length of the value, in the range 1–999

IntType

One of the integer types from the Integer types table

ALL

Forces the integer to format even if the value of the field is zero and OPTIONS FORMAT(ERGO) is in effect

ALL is appropriate for integer fields that are particularly significant when their value is zero.

CANON

Forces the integer to canonical format even if OPTIONS INTFORMAT(SCALED) is in effect

For a description of canonical and scaled integer formats, see INTFormat. CANON is appropriate for integer fields that are codes or similar values rather than quantities.

SCALE

(SPE2104)

Forces the integer to scale format even if OPTIONS INTFORMAT(CANON) is in effect.

For a description of canonical and scaled integer formats, see INTFormat. CANON is appropriate for integer fields that are codes or similar values rather than quantities.

IPFormat

Specifies the format. Specify either v6 or v6asv4.

length

8 byte fixed length of the field

This is the number of bytes that will be converted.

numberOfDigits

Number of digits in the range 1–17

(SPE2201)CANON

(Optional) Forces the integer to canonical format

For a description of canonical and scaled integer formats, see INTFormat. CANON is appropriate for integer fields that are codes or similar values rather than quantities.

timeType

One of the time types from the Time types table

length

Fixed length of the field

This is the number of bytes that will be converted.

length

4-byte fixed length of the field

This is the number of bytes that will be converted.