Terminology for User Record Definitions

When working with record definition files the following terms are used.

RECORDS

Data is obtained by running one or more 'Collector' applications. The data gathered by each Collector is populated into a range of Records with each record containing a series of fields. Once the record fields start being populated by a Collector, the data is then ready to be used by Displays, Analysts, Thresholds, Atlases and Databases.

FIELDS

Each record contains a series of fields that are used to sort collected data into logical groupings.

KEY FIELD

Every Record has a unique 'Key' value which is used to identify each instance of the record. This value is made up of one or more 'Key' fields. The number of fields that are included is controlled by the ID_LENGTH value of the record. The length of each included 'Key' field makes up this total value with the length being determined by its TYPE value. For example:

TYPE

Required Field Length

BINARY_16

2 bytes

BINARY_32

4 bytes

BINARY_64 (with options)

8 bytes

BINARY_64 (with timestamp option)

12 bytes

STRING 10

10 bytes

The Key fields start from the field containing the START_ARRAY token and includes each following field until their accumulated length matches the ID_LENGTH value of the record. For example, a record with an ID_LENGTH of 4 can have two Key fields, each one with a TYPE value of BINARY_16 (i.e. 2 bytes each).

ARRAY

An ARRAY is a sequence of records. Record fields are either 'static' fields or 'array' fields. Static fields contain the same value for all instances of the record at a given time while Array fields are much more common and have different values for each instance of the record.

When writing a User Collector, the fields defined in the record must match the required data that is output by the application. For example, if an Extractor has been written to read the following output from a command, the record will need to include these 7 fields.

Output from command:

Tape Drive

Drive Status

Tape Name

Tape Status

Label Type

Open Mode

Process Name

$TAPE1

INUSE

TT0046

ASSIGNED

ANSI

LP

\SKY.$BURT

$TAPE2

INUSE

TT0047

ASSIGNED

ANSI

LP

\SKY.$SID

The title lines of the output are not required and will be skipped over in the Extractor script.

Provide feedback on this article