Store alarms on a database

Enables or disables storing Alarm data on a database. This option is equivalent to the Logging property of an Alarm Server object

Database Server

Defines which Database server stores Alarm data. This option is equivalent to the DataSource property of an Alarm Server object

Table name

Defines the name of an Alarm table. This option is equivalent to the TableName property of an Alarm Server object

Discard data from the main table

Enables or disables discarding data from the main table. Data is considered old according to the Discard data older than option. This option is equivalent to the EnableDiscard property of an Alarm Server object

Discard data older than

Determines a time interval, in minutes, hours, days, or months, during which data is kept on the main table. If data is older than the interval on this option, it is discarded. This option is equivalent to the DiscardInterval property of an Alarm Server object and the option to select a time unit for this interval is equivalent to the DiscardTimeUnit property of an Alarm Server object

Perform discard every

Performs an Alarm verification, according to the period specified in this option, in minutes, hours, days, or months. This option is equivalent to the VerificationInterval property of an Alarm Server object and the option to select a time unit for this interval is equivalent to the VerificationUnit property of an Alarm Server object

Move discarded data to the backup table

Enables or disables storing discarded data on a secondary or backup table. This option is equivalent to the EnableBackupTable property of an Alarm Server object

Discard from backup data older than

Determines a maximum time interval, in minutes, hours, days, or months, for data on the backup table until it is discarded, regardless of the time data remains on the main table. For example, to keep data for 24 months on the main table and six more months on the backup table, this option's value must be 30 months. This interval must be longer than the one configured in the Discard data older than option of the main table. This option is equivalent to the BackupDiscardInterval property of an Alarm Server object and the option to select a time unit for this interval is equivalent to the BackupDiscardTimeUnit property of an Alarm Server object

Fields

Determines which Alarm's Event Fields are added to the Alarm table, and in which order those columns are displayed

Create table

Generates an Alarm table on the specified Database

Exclude suppressed alarms from alarm counters

Enables or disables excluding suppressed Alarms from Alarm counters. This option is equivalent to the ExcludeSuppressedAlarmsOnCounters property of an Alarm Server object

Acked

Informs whether an Alarm was acknowledged or not. Possible values for this Field are 0: Not acknowledged or 1: Acknowledged

AckRequired

Determines an automatic acknowledgment for this Alarm. Possible values for this Field are 0: Automatic acknowledgment or 1: Manual acknowledgment

AckTime

Stores Elipse E3's date and time at the moment an Alarm is acknowledged, or zero (12/30/1899) while it is not acknowledged. For Alarms that do not require acknowledgment, this Field assumes Elipse E3's timestamp at the moment this Alarm becomes active

AckTimeDbl

Corresponds to the AckTime Field as a number in Double format. This Field is used to easily store date and time data types on Oracle or SQL Server databases

AckTimeMS

Corresponds to the AckTime Field as a value in milliseconds. This Field is used to easily store date and time data types on Oracle databases

ActiveSource

Active Measurement Source of an object. For Elipse E3, this value is always equal to -1 (minus one). For Elipse Power or Elipse Water, please check E3Alarm's CustomFilter property for possible values of this Field

ActorID

Name of the operator who acknowledged this Alarm. Possible values for this Field are the following:

•The user logged on Elipse E3 Viewer when acknowledgment happened on E3Alarm or "No user" if there is no user logged in

•"System", when acknowledgment is automatic, that is, for Alarms that do not require acknowledgment

•A name passed via script, such as when using Alarm Server's AckArea, AckAllAlarms, or LogTrackingEvent, or Alarm Source's Ack methods

This Field's default size is 50 characters

AlarmArea

For Alarm Events, this is the name of the Area this Alarm Source belongs to. For other Events, such as when using Alarm Server's LogTrackingEvent method, it can be a user-defined text. This Field's default size is 100 characters

AlarmSourceName

Stores Alarm Source's name. This Field's default size is 100 characters

AlarmState

Indicates the current status of this Alarm. Possible values for this Field are 1: Alarm left alarm condition and was acknowledged, 2: Alarm needs acknowledgment, 3: Alarm active and acknowledged, 4: Alarm inactive and needs acknowledgment, 5: Alarm shelved by the operator, 6: Alarm suppressed by design, 8: Alarm active but does not need acknowledgment, 9: Event, or 10: Alarm added using Alarm Server's LogTrackingEvent method

AllowShelving

Indicates whether this Event can be shelved or not

ChangeMask

Not used and its value is always equal to 0 (zero)

ConditionActive

Indicates whether this Alarm Source is in alarm. Possible values for this Field are 0: Inactive condition or 1: Active condition

ConditionName

Name of this condition, if it is an Alarm Event. Possible values for this Field are DeadBand: Dead-Band-type Alarm Source, Digital: Digital-type Alarm Source, Level: Analog-type Alarm Source, or RateOfChange: Rate-Of-Change-type Alarm Source. For Events that are not Alarms, such as when using Alarm Server's LogTrackingEvent method, this value is always an empty String. This Field's default size is 100 characters

Cookie

Value associated to this Alarm Source, used internally by an Alarm Server

CurrentValue

Determines Alarm Source's value, converted to Double, at the time of the Event. For other Events, such as when using Alarm Server's LogTrackingEvent method, this value is always zero (0)

Deleted

Determines whether this Alarm was removed. An Alarm can only be removed if its Unbound Field is set to True

E3TimeStamp

Date and time of the computer at the time of this Event

Enabled

Determines whether Alarm check is enabled or not. Possible values for this Field are 0: Alarm Source's check disabled or 1: Alarm Source's check enabled

EventCategory

Category of this Event. For Alarms, possible values for this Field are DeadBand: Dead-Band-type Alarm Source, Digital: Digital-type Alarm Source, Level: Analog-type Alarm Source, or RateOfChange: Rate-Of-Change-type Alarm Source. For other Events, such as when using Alarm Server's LogTrackingEvent method, it may assume user-defined values. This Field's default size is 100 characters

EventCLSID

Unique identifier for an Alarm's lifetime. When a new Alarm occurs on a Source, a new identifier is then generated. Thus, this Alarm keeps the same identifier on the database while it is still on the list of active and unacknowledged Alarms

EventTime

Date and time of a Tag value linked to the Alarm Source at the time of this Event

EventTimeDbl

Corresponds to the EventTime Field as a value in Double format. This Field is used to easily store date and time data types on Oracle or SQL Server databases

EventTimeMS

Corresponds to the EventTime Field as a value in milliseconds. This Field is used to easily store date and time data types on Oracle databases

EventTimeUTC

Corresponds to the EventTime Field relative to Greenwich time. This Field is kept in Elipse E3 for compatibility reasons

EventType

Type of an Event. For Alarm Events, it is always equal to "Condition". For other Events, it can be a user-defined text, such as when using Alarm Server's LogTrackingEvent method ("Tracking", "Simple"). This Field's default size is 100 characters

FormattedValue

Shows an Alarm Source's formatted value that is stored for the Event. This Field's default size is 100 characters. NOTE: This is a read-only Field

FullAlarmSourceName

Stores an Alarm Source's full path, including Areas, Alarm Configuration, and possible Folders where it might be inserted. For example, "Folder1.AlarmConfig1.Area1.AlarmSource1". This Field's default size is 100 characters

InTime

Stores value's date and time, at the moment it enters an alarm condition

InTimeDbl

Corresponds to the InTime Field as a number in Double format. This Field is used to easily store date and time data types on Oracle or SQL Server databases

InTimeMS

Corresponds to the InTime Field as a value in milliseconds. This Field is used to easily store date and time data types on Oracle databases

Message

Text configured on an Alarm Source or specified by another Event, such as when using Alarm Server's LogTrackingEvent method. This Field's default size is 200 characters

OutTime

Stores value's date and time at the moment it leaves an alarm condition or zero (12/30/1899) if this Alarm has not left its active condition yet

OutTimeDbl

Corresponds to the OutTime Field as a number in Double format. This Field is used to easily store date and time data types on Oracle or SQL Server databases

OutTimeMS

Corresponds to the OutTime Field as a value in milliseconds. This Field is used to easily store date and time data types on Oracle databases

Quality

Quality of an Alarm Source's value at the moment of an Event. Possible values for this Field are 0 - 63: Bad quality, 64 - 127: Uncertain quality, 128 - 191: Undefined value, or 192 - 255: Good quality. If this Event is not an Alarm, such as when using Alarm Server's LogTrackingEvent method, this Field is equal to an empty String. This Field's default size is 50 characters

SequentialNumber

Stores a sequential index of the order in which an Alarm Event was generated. This index ranges between 0 (zero) and 2147483647. Whenever a Domain is stopped, this index is zeroed, therefore this Field must not be used as a general sorter of Alarms, but rather as a tie-breaking criteria if there are two records with the same timestamp

Severity

Severity value configured on an Alarm Source. Possible values for this Field are -2: Critical, 0: High, 1: Medium, or 2: Low. This Field can also assume another user-defined value if it is an Event, such as when using Alarm Server's LogTrackingEvent method. This Field's default size is 20 characters

ShelveActorID

Name of the operator who shelved this Event. Please check the ActorID Field for more information about the content of this Field

ShelveCount

Number of times this Event was shelved

Shelved

Indicates whether this Event was shelved or not

ShelvedExpirationTime

Indicates the programmed date and time for this Event to leave its shelving condition

ShelvedOutTime

Stores the date and time of the moment this Event is unshelved

ShelvedTime

Stores the date and time of the moment this Event is shelved

ShelveDuration

Time, in minutes, this Event remained shelved

ShelveMaxCount

Maximum number of times this Event can be shelved

ShelveMaxDuration

Maximum time, in minutes, this Event can remain shelved

ShelveReason

Reason why this Event was shelved. This Field's limit size is 150 characters

Source

For Alarm Events, it informs an expression used to evaluate alarm conditions. This Field's default size is 100 characters

SubConditionName

Name of a Sub-condition, if it is an Alarm Event. Possible values for this Field are DB: Dead Band Alarm, DIG: Digital Alarm, RC: Rate Of Change Alarm, LOLO: Analog Alarm in LoLo range, LO: Analog Alarm in Lo range, HI: Analog Alarm in Hi range, or HIHI: Analog Alarm in HiHi range. If this Event is not an Alarm, such as when using Alarm Server's LogTrackingEvent method, this Field is always an empty String. This Field's default size is 100 characters. For Discrete-type Alarm Sources, this Field assumes the name of a user-defined Sub-condition on the Discrete tab of this Alarm's properties

Suppressed

Indicates whether this Alarm was suppressed by shelving or by design

SuppressedTime

Date and time when this Alarm was suppressed by shelving or by design

Unbound

Indicates whether this Alarm is not linked to an Alarm Source

User Fields

These are user-defined Fields. These Fields are configured on Alarm Server's User fields tab