Format specifications
Format specifications determine how to format, display, and group fields. You can use Format specifications to structure field data and to define the order in which fields are displayed. For more information about using a Format specification to structure data, see Grouping-related-fields-with-FFlist-and-GFlist.
The following table describes Format specifications.
FAcct
FAcct(COUNT|NOCOUNT)
Acounting information (often called job accounting) as specified on a JCL JOB or EXEC statement and written in SMF records (for example, SMF 30).
The associated Get specification returns the address of the first byte, the count of subfields, and a length at least equal to the total length of the accounting information.
The following table describes the operands:
Operand | Description |
|---|---|
COUNT | Data begins with a 1-byte subfield count (for example, SMF 35 TLGNBRAC) |
NOCOUNT | Subfield count is omitted (for example, SMF30ACT) |
FAre
FAre()
ACF2 alter request entry
FAre has no operands.
FBINPrec
FBINPrec(intType, precision)
Binary data to print with the specified decimal precision
The following table describes the operands:
Operand | Description |
|---|---|
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. |
FBits
FBits(bitTableName intType [additionalErgo [mask [MSB]]])
Integer as a series of bit flags
A bits definition statement assigns a name to each bit, and then FBits formats the integer as, tag: {name, name}, for each 1-bit value. The bits are processed from least significant to most significant unless MSB is specified.
Make sure that BITs specifies a table as large as the number of bits in the integer. For more information, see BITs-and-REBITs-statements.
If a bit is on (and not masked off) and there is no corresponding bit definition in the BITs table, then the bit is formatted as Bit n, where n is a bit number in the range 1–63. For purposes of FBits, bits are numbered from 1, starting with the least significant bit: Bit 1 corresponds to X'01', Bit 2 to X'02', Bit 8 to X'80', Bit 9 to X'100', and so on.
The following table describes the operands:
Operand | Description |
|---|---|
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 | Mask to be logically joined with AND to the data in the record before the comparison This operand is required if you specify the MSB operand, but you can enter a mask value of X'FF', X'FFFF' (all bits on). 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. |
FBool
FBool(intType mask [ALL|ANY])
One or more bits as Boolean character values
If the bits are on, the value is Yes. If the bits are zero, the value is No or omitted.
The character value is specified by the BOOLValues parameter of the OPTIONS statement.
The following table describes the operands:
Operand | Description |
|---|---|
intType | Any of the integer types from the Integer types table |
mask [ALL|ANY] | Bit or bits to be tested If you specify 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). If you specify a mask of a single bit, ALL | ANY has no meaning. If you omit the operand, the defaults is ALL. |
FChar or FCharX
FChar([length][SUB] [TB] [XP]) or FCharX([length] [SUB] [TB] [XP])
Character field of a known length
If the field data does not consist of printable characters only, FCharX generates leading character data as displayable characters and formats the following non-printable data in hexadecimal. FCharX has higher overhead than FChar, and you should use it only when the field has to be generally formatted as characters, but the possibility of non-printable characters exists.
You can specify the length either on FChar() or FCharX() or return by using the Get specification. If both are available, then use the shorter value.
The following table describes the operands:
Operand | Description |
|---|---|
length | (Optional) Length of the value |
SUB | Substitutes 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 | Whether to preserve trailing blanks in the data If you omit the operand, trailing blanks in the data are removed. |
XP | Checks the field’s value for transparency XP increases the overhead to process the field, so do not specify this operand unless the field possibly contains equal signs, backslashes, quotation marks, or embedded (non-trailing) blanks. If you specify XP, then certain characters are escaped if SIEMtype is CEF or SPLUNK. If you omit the operand, the value is not checked for transparency. |
FCharPfx
FCharPfx(UChar|UHalf|UShort [adjust [length]] [TB] [XP])
Character field whose length is specified by an immediately preceding prefix encoded as a single byte or a halfword.
FCharPfx implements all the FChar features. The corresponding Get specification must specify the location of the prefix, which must in turn immediately precede the character string.
Operand | Description |
|---|---|
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, if a length field includes its own length in its value, enter an adjust value of -1 or -2. If you also specify a maximum length value, then you must specify an adjust value, even if it is 0. If you omit the operand, the default value is 0. |
length | Maximum length of the character string If you omit the operand, the maximum length is the length returned by the Get specification. |
TB | Whether to preserve trailing blanks in the data If you omit the operand, trailing blanks in the data are removed. |
XP | Checks the field’s value for transparency XP increases the overhead to process the field, so do not specify this operand unless the field possibly contains equal signs, backslashes, quotation marks, or embedded (non-trailing) blanks. If you specify XP, then certain characters are escaped if SIEMtype is CEF or SPLUNK. If you omit the operand, the value is not checked for transparency. |
FCString
FCString()
C format character string—a character string terminated by a null (binary zero)
FCString accepts no operands.
FCompCd
FCompCd()
Completion code field (for example, SMF30SCC)
FCompCd accepts no operands.
FDesc()
FDesc(mapLabel intType [mask])
Integer as a corresponding textual description
The descriptions for the various integer values are specified with MAP and REMAP. Integer values with no corresponding MAP text are formatted as hexadecimal.
The following table describes the operands:
Operand | Description |
|---|---|
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 | Mask to be logically joined with AND to the integer before formatting If you omit the operand, all bits of the integer are used to look up a value in the map. |
FDump
FDump([length])
Value displayed as a diagnostic character string of quoted characters, integers, or hexadecimal digits
It is used for diagnostic purposes.
The following table describes the operand:
Operand | Description |
|---|---|
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. |
FDynPfx
(SPE2207)FDynPfx(UChar|UHalf|UShort [adjust [length]] [TB] [XP])
Character field whose length is specified by an immediately preceding prefix encoded as a single byte or a halfword. If any binary data is detected in the string, the entire string is printed out in hex format. The format is prefixed with “0x” and hex follows.
FDynPfx implements all the FCharPfx features. The corresponding Get specification must specify the location of the prefix, which must in turn immediately precede the character string.
Operand | Description |
|---|---|
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, if a length field includes its own length in its value, enter an adjust value of -1 or -2. If you also specify a maximum length value, then you must specify an adjust value, even if it is 0. If you omit the operand, the default value is 0. |
length | Maximum length of the character string If you omit the operand, the maximum length is the length returned by the Get specification. |
TB | Whether to preserve trailing blanks in the data If you omit the operand, trailing blanks in the data are removed. |
XP | Checks the field’s value for transparency XP increases the overhead to process the field, so do not specify this operand unless the field possibly contains equal signs, backslashes, quotation marks, or embedded (non-trailing) blanks. If you specify XP, then certain characters are escaped if SIEMtype is CEF or SPLUNK. If you omit the operand, the value is not checked for transparency. |
FFlist
FFlist([maxLength] delimType fieldName fieldName … )
List of fields as a group, such as tag: {Tag: value - Tag: value}
You can specify FFlist in one of the following ways:
- Get specification GNull and a normal Get specification on each subsidiary field
- A normal Get specification and Get specification GFlist on each subsidiary field
The second option is typically more appropriate if the aggregate field repeats. For more information, see Grouping-related-fields-with-FFlist-and-GFlist.
The following table describes the operands:
Operand | Description |
|---|---|
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 | 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 FFlist fields can include FFlist fields, so you can nest FFlists. |
FFloat
FFloat(floatType [SUPPXFF] [CANON])
Hexadecimal (traditional System 390) floating point number of the type indicated by floatType
The following table describes the operands:
Operand | Description |
|---|---|
floatType | One of the float types from the Float types table |
SUPPXFF | (Optional) If SUPPXFF is entered, then any value of X'FFF…' (binary minus one) is suppressed (not formatted) as per the usage by Db2 of the SQLCA field SQLERRD(4). |
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. |
FHex
FHex(length)
Value displayed as a string of hexadecimal digits
It is used primarily for diagnostic purposes, or to format a field for which no better Format specification exists.
The following table describes the operand:
Operand | Description |
|---|---|
length | Maximum length of the value in the range from 1 to 999 |
FHexPfx
(SPE2207)FHexPfx(UChar|UHalf|UShort [adjust [length]]
Hex field whose length is specified by an immediately preceding prefix encoded as a single byte or a halfword.
The corresponding Get specification must specify the location of the prefix, which must in turn immediately precede the hex field.
Operand | Description |
|---|---|
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 hex bytes itself For example, if a length field includes its own length in its value, enter an adjust value of -1 or -2. If you also specify a maximum length value, then you must specify an adjust value, even if it is 0. If you omit the operand, the default value is 0. |
length | Maximum length of the hex bytes If you omit the operand, the maximum length is the length returned by the Get specification. |
FInt
FInt(intType [ALL] [CANON|SCALE])
Formatted integer
The following table describes the operands:
Operand | Description |
|---|---|
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 | 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. |
FIPAddr
FIPAddr(IPFormat)
Formatted IPv6 address
FIPAddr can format an IPv6 address in one of the following ways:
- As an IPv6 address
- As an IPv4 address if it is an IPv4-mapped address
- As 255.255.255.255
The following table describes the operand:
Operand | Description |
|---|---|
IPFormat | Specifies the format Specify either v6 or v6asv4. |
FMVZTime
FMVZTime(length)
BMC AMI Ops Monitoring zoned timestamp into UTC time format YYYY/MM/DD HH:MM:SS.th.
The following table describes the operand:
Operand | Description |
|---|---|
length | 8-byte fixed length of the field This is the number of bytes that will be converted. |
FPack
FPack(numberOfDigits [CANON])
Packed decimal value displayed as an integer
The product does not check that the field contains valid packed decimal data.
The following table describes the operands:
Operand | Description |
|---|---|
numberOfDigits | Number of digits in the range from 1 to 17 |
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. |
FTime
FTime(timeType)
Time of day or a duration in accordance with the TIME statement
New time types PDate and PTime added for this parameter. For more information, see Time types table.
The following table describes the operand:
Operand | Description |
|---|---|
timeType | One of the time types from the time types table |
FUnicode
FUnicode(length)
Unicode characters (CCSID 1200) that must be converted to EBCDIC (CCSID 1047)
The following table describes the operand:
Operand | Description |
|---|---|
length | Fixed length of the field This is the number of bytes that will be converted. |
FZdur
FZdur(length)
BMC AMI Ops Monitoringduration into the time format HH:MM:SS.th.
The following table describes the operand:
Operand | Description |
|---|---|
length | 4-byte fixed length of the field This is the number of bytes that will be converted. |
Related topic