EMS FastStart Manual

Building Your Application for Event Generation

EMS FastStart Manual–133701

6-8

Egen-record Fields Definition

The Egen-record structure is the principal interface between an application and EGEN.

Based on the values of these fields, EGEN will generate an event. Table 6-3 shows each

of the fields and their descriptions. Note that all the user defined fields in the ACF will

also be added to the egen-record. These fields are not described here because they are

specific to each application.

Table 6-3. Egen-record Fields and Descriptions (page 1 of 2)

Field Name Field Data Type and Description

acf-version ZSPI-DDL-INT.

This field contains the version of the ACF; the only version

currently supported is B00. This is the internal version number of

the ACF and should not be altered. This field is initialized each

time you call the Initialize^egen^record procedure and is used

internally by the EGEN procedure. You should not alter the value

of this field.

ssid-owner ZSPI-DDL-CHAR8

This field contains the owner of the event buffer and must be an

eight-character string or less to identify your company or

organization.

ssid-subsystem-number ZSPI-DDL-INT

This field contains the SSID subsystem number and is identified by

a 16-bit signed integer value that identifies the subsystem within

the set of subsystems provided by the subsystem owner.

ssid-version ZSPI-DDL-UINT

This field contains the software release version of the subsystem

and is a 16-bit unsigned integer value. In the format of the field the

left byte contains the letter part of the version as an ASCII

uppercase alpha character, and the right byte contains the numeric

part of the version as an unsigned integer value.

egen-error ZSPI-DDL-INT

This field contains more detailed information about errors detected

by an EGEN procedure.

event-type ZSPI-DDL-ENUM

This field contains the type of event to be generated by EGEN. One

of four types can be generated: Informative-event, Critical-event,

Action-attention-event and Action-completion-event.

event-number ZSPI-DDL-INT

This field contains the event number of the event to be generated

by EGEN.

action-id ZSPI-DDL-UINT

This field contains the action identifier of an action-attention-event

or an action-completion-event.