Alert Types

An alert type defines something to watch for in the system.

The Alert Type object

Alert types are a key entity in the system. They consist of the following:

• id: An autogenerated ID to uniquely identify the alert type.
• type: The kind of alert type. This can be one of:
  • time: This will watch the change over base_tag in condition_over number of days and trigger if it's over threshold.
  • tag: This will watch the change over base_tag when extra_tag has increased in condition_over and trigger if it's over threshold.
  • tag_threshold: This will watch if the value of base_tag is at or above condition_over percentage of the value of extra_tag and trigger if true.
• name: "The human readable name given to the alert. i.e. Flame Guard Alarm"
• base_tag: "The name of the tag emitted by the PLC to watch for changes on."
• threshold: "A threshold used in different ways depending on the alert type."
• condition_over: "A second conditioner used in different ways depending on the alert type."
• extra_tag: "A secondary tag to use in different ways depending on the alert type."

As an example, here's what the definition of the Flame Guard Alarm would look like:

{
  id: "57df5898-0c40-4176-9dd4-e0c96c6c810e",
  type: "time",
  name: "Flame Guard Alarm",
  base_tag: "FlameGuardAlarm_count",
  threshold: 5,
  condition_over: 5,
  extra_tag: "i_xFlameAlarm"
}