| |
|---|
| The FAcct specification formats accounting information (often called job accounting) as specified on a JCL JOB or EXEC statement and written in SMF 30 and other SMF records. The associated Get specification should return 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 FAcct() specification takes no parameters. | Specifies whether the data begins with a one-byte subfield count (COUNT) as in SMF 35 TLGNBRAC or if the subfield count is omitted (NOCOUNT) as in SMF30ACT. |
|---|
|
| The FAre specification formats an ACF2 Alter Request Entry. FAre takes no parameters. |
FBits(bit_table_name int_type [additional_ergo [mask [MSB]]]) | The FBits specification formats an 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 certain that BITS specifies a table as large as the number of bits in the integer. 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 forth. | The label of a previously-defined BITs statement. By convention, bit definition tables have names that begin with B_. The name is not case-sensitive. This operand is required. |
|---|
| Specify any of the integer types from the preceding table except UCharUChar and UNiblUNibl. This operand is required. |
|---|
| Specifies an additional ergonomic value (in addition to zero) that is suppressed if OPTIONS FORMAT(ERGO). Specify a numeric operand no larger than the specified integer type. This operand is optional unless mask or MSB is specified, in that case it is required, but might be coded as 0. |
|---|
| Specifies a mask to be logically ANDed with the integer before formatting. Example A mask of X’0007’ would cause all but the low-order three bits of the integer to be ignored for formatting purposes. This operand is optional unless MSB is coded, in that case it is required but might be coded as X'FF', X'FFFF' (all bits on). If you omitted this, then all bits of the integer take part in the formatting. |
|---|
| Specifies that the bits are to be processed starting with the most significant bit. MSB is optional; if you omit MSB, then bits are processed in the order from least to most significant bit. |
|---|
|
FBool(int_type mask [ALL|ANY]) | The FBool specification formats one or more bits as a Boolean character value, typically Yes if the bit or bits is on and No or omitted if the bit or bits is zero. (The character value is specified by OPTions BOOLValues().) | Specify any of the integer types from the preceding table. This operand is required. |
|---|
| Specifies the 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 might be on, for the FBool to format the true value (typically Yes). |
|---|
| Specifies 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 omitted this operand, it defaults to ALL. |
|---|
|
FChar([length][SUB] [TB] [XP]) FCharX([length] [SUB] [TB] [XP]) | The FChar and FCharX specifications format a character field of a known length. In addition, if the field data does not consist entirely of printable characters, FCharX formats the data in hexadecimal, for a maximum of 99 bytes. FCharX is 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()/FCharX() or return by the Get specification. If both are available, then use the shorter value. | Specifies the length of the value. This operand is optional. |
|---|
| Specifies that you should 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. |
|---|
| Specifies that you should preserve trailing blanks in the data. If this operand is omitted, then remove trailing blanks in the data. |
|---|
| Specifies that you should check the field’s value for transparency. Do not specify XP unless the field might possibly 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 XP is omitted, do not check the value for transparency. |
|---|
|
FCharPfx(UChar|UHalf|UShort [adjust [length]] [TB] [XP]) | The FCharPfx specification formats a character field whose length is specified by an immediately-preceding prefix encoded as a single byte or a halfword. FCharPfx implements all of the features of FChar. The corresponding Get specification must specify the location of the prefix, that must in turn immediately precede the character string. | Specifies the format of the length prefix. You must code the operand. |
|---|
| Specifies an amount to be added to (or, by implication, subtracted from) the encoded length to compute the actual length of the character string itself.
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 adjust, it defaults to 0. |
|---|
| Specifies the maximum length of the character string. This operand is optional. If you omit length then the maximum length defaults to the length returned by the Get specification. |
|---|
| Specifies that you should preserve trailing blanks in the data. If you omit this operand, then any trailing blanks in the data are removed. |
|---|
| 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 XP, the value is not checked for transparency. |
|---|
|
| The FCStringSpecification formats a C format character string— a character string terminated by a null (binary zero). FCString accepts no parameters. |
| The FCompCd Specification formats a completion code field like SMF30SCC. FCompCd accepts no parameters. |
FDesc(map_label int_type [mask]) | The FDesc Specification formats an 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 label of a previously-defined MAP statement. This operand is required. The name is not case-sensitive. By convention, map labels begin with M_. |
|---|
| Specify any of the integer types from the given table except UCharUChar and UNiblUNibl. This operand is required. |
|---|
| Specifies a mask to be logically ANDed with the integer before formatting. Example A mask of 0x07 would cause all but the low-order three bits of the integer to be ignored for map lookup purposes. This operand is optional. If you omit, then all bits of the integer are used to look up a value in the map. |
|---|
|
| The FDump Specification displays a value as a diagnostic character string of quoted characters, integers, hex digits, or both. It is used for diagnostic purposes. | Specifies the maximum length of the value. This field is optional; if you omit then the lesser of 999 or the length returned by the Get specification is used. |
|---|
|
FFlist([max_length] delim_type field_name field_name … ) | The FFlist (Field List) specification formats a list of Fields as a group; such as Tag: {Tag: value - Tag: value}. FFlist might be specified with a Get Specification of GNull and a normal Get specification on each subsidiary field, or might be specified with a normal Get Specification and GFlist on each subsidiary field. The latter is typically more appropriate if the aggregate field repeats. See Grouping-related-fields-with-FFlist-and-Gflist. | Specifies the maximum length of the entire group of fields in the formatted syslog message. This field is optional; if it is omitted then the aggregate length of the group is limited only by MAXMSGLEN. |
|---|
| You 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. |
|---|
| A list of the names of two or more previously-defined Fields. The FFlistfields might include FFlist fields; in other words, you might nest FFlists. |
|---|
|
FFloat(float_type [SUPPXFF]) | The FFloat Specification formats a hexadecimal (traditional System 390) floating point number of the type indicated by float_type. | Specify one of the float types from the preceding table. This operand is required. |
|---|
| This operand is 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). |
|---|
|
| The FHex specification displays a value as a string of hex digits. It is used primarily for diagnostic purposes, or to format a field for which no better Format Specification exists. | Specifies the maximum length of the value, in the range 1–999. This field is required. |
|---|
|
FInt(int_type [ALL] [CANON]) | The FInt specification formats an integer. | Specify one of the integer types from the table. This operand is required. |
|---|
| Forces the integer to format even if the value of the field is zero and OPTIONS FORMAT(ERGO) is specified or allowed to default. ALL is appropriate for integer fields that are particularly significant when their value is zero. |
|---|
| Forces the integer to canonical format even if OPTIONS INTFORMAT(SCALED) is specified or allowed to default. See the discussion of INTFORMAT for a description of canonical versus scaled integer format. CANON is appropriate for integer fields that are codes or similar values rather than quantities. |
|---|
|
| The FIPAddr specification formats an IPv6 address. It can format it as an IPv6 address, or format it as either an IPv4 address if it is an IPv4-mapped address and as 255.255.255.255 if not. | Specifies the format. Specify either v6 or v6asv4. |
|---|
|
| The FPack Specification displays a packed decimal value as an integer. There is no validation that the field contains valid packed decimal data. | Specifies the number of digits, in the range 1–17. This field is required. Note The number of digits formatted is always an odd number; the number of digits specified is rounded up to the next higher odd number if it is not already odd. |
|---|
|
| The FTime specification formats a time of day or a duration in accordance with the TIME statement. | Specify one of the Time Types from the preceding table. This operand is required. |
|---|
|