Generic Event Fields

A generic event field is arbitrary text information (limited in size to the size of corresponding column in JOBS table) associated with an event and identified by the field name. The value of a generic event field can be set explicitly using NMS API or assigned automatically by the system using attributes of the outage device or customer-defined call fields. Example configuration steps illustrated by configuring field 'generic1' which will allow to store strings up to 64 characters long.

Configure Generic Fields

All generic event fields to be used have to be listed in the GENERIC_EVENT_FIELDS database table. Field names are not case sensitive so you cannot have two that differ only by case.

Structure of the GENERIC_EVENT_FIELDS database table:

Column Name	Description
FIELD_NAME	Generic field name. Used to identify field. Has to be unique.
FIELD_ORDER	Generic field ordinal number. Defines the order in which fields are registered with the Work Agenda.
ATT_COLUMN	Name of the column in the attribute column. If not an empty string, then generic field will be auto‑populated with the information from the column in the attribute table for the outage device.
CALL_FIELD	Name of the customer-defined call field. If not an empty string then generic field will be auto‑populated with the value of the specified customer-defined call field from the first call for the event.
MERGE_POLICY	Merge policy defines how generic event fields are handled when events group together. Merge policy does not apply to auto‑populated generic event fields. If necessary, the resulting value will be truncated to fit in the database column. Valid Values: • none: Do not merge values of generic event fields. This is the default behavior. • concat: Concatenate generic event field values. • concat_comma: Concatenate generic event field values separating them by a comma. • concat_space: Concatenate generic event field values separating them by a single space.
DATA_TYPE	Data type of the generic event field. This affects how the field is displayed and sorted in Work Agenda, but values are stored in the database as strings. Valid Values: • str: string (this is the default) • int: integer • date: date represented as number of seconds since midnight 1/1/1970 UTC/GMT

Example:
Add field 'generic1' to the GENERIC_EVENT_FIELDS table.

INSERT INTO generic_event_fields (field_name, field_order, att_column)

VALUES ('generic1', 10, NULL);

Modify JOBS Table

A column of type VARCHAR2 matching name of the generic field configured in GENERIC_EVENT_FIELDS table should be added to the JOBS and UNTIED_OUTAGES tables if information in the generic field should be persistent. For example, fields populated from attribute tables might not need to be stored in the JOBS table. Size of the column in JOBS table will be used to check and truncate (if needed) values before updating database. The size of the corresponding UNTIED_OUTAGES column must match this size.

Example:
Add column 'generic1' to the JOBS table.

/* Add to the JOBS and UNTIED_OUTAGES table definitions

generic1 VARCHAR2(64) */

ALTER TABLE jobs ADD generic1 VARCHAR2(64);

ALTER TABLE untied_outages ADD generic1 VARCHAR2(64);

Add Columns to Work Agenda

Add column to WORKAGENDA_TBL_WA_ALARMS.inc with key matching the name of the column and matching properties for column label and width in WorkAgenda_en_US.properties (See also “Work Agenda Configuration”.)

Example:
Add column 'generic1' to WORKAGENDA_TBL_WA_ALARMS.inc.

Add column 'generic1' to WorkAgenda_en_US.properties.

TBL_WA_ALARMS.generic1.text = Generic Field 1

TBL_WA_ALARMS.generic1.width = 60