Axeda.Alarm Data Shape

Extensions Reference > Axeda Compatibility Extension (ACE) Entity Reference > ACE Data Shapes > Axeda.Alarm Data Shape

The Axeda.Alarm Data Shape defines a set of fields that are used to map an Axeda alarm to the Thing that represents the Axeda agent asset in ThingWorx. This Data Shape represents the "alarms" property. Alarms from eMessage agents are stored as a property of Base Type INFOTABLE. The infotable is logged and consists of a single row that contains the most recent alarm. The logging creates the time series of alarms. A value stream is assigned to the AxedaBaseModel Thing Template to handle alarms.

Data items that are associated with alarms in the eMessage agent configuration are stored as standard ThingWorx properties. Their associated property name and value pairs are stored in a properties infotable within the infotable of the alarms property.

Fields

The Axeda.Alarm Data Shape defines the following fields:

Field Name	Base Type	Description
name	STRING	Name of the alarm.
description	STRING	Description of the alarm.
timestamp	DATETIME	The date and time that the alarm occurred on the Remote Thing. The timestamp is stored in UTC.
type	STRING	Type or sub-condition of the alarm.
severity	INTEGER	Severity of the alarm.
activeState	STRING	Flag indicating whether or not the alarm is active. If the alarm is not active, the underlying condition has been cleared.
acknowledgeState	STRING	Flag indicating whether or not the alarm has been acknowledged.
properties	INFOTABLE	infoTable that provides the data items that are associated with the alarm. These data items are represented as properties of the thing in ThingWorx. Refer to Axeda.AlarmPropertyDataShape for information about how the properties associated with alarms are captured in ThingWorx.