Package com.inductiveautomation.ignition.common.alarming.config

Class CommonAlarmProperties<T extends Serializable>

java.lang.Object

com.inductiveautomation.ignition.common.alarming.config.WellKnownAlarmProperties<T>

com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties<T>

All Implemented Interfaces:

AlarmProperty<T>, DescriptiveProperty<T>, Property<T>, Serializable

Direct Known Subclasses:

CommonAlarmProperties.CalculatedAlarmProperty

public class CommonAlarmProperties<T extends Serializable>
extends WellKnownAlarmProperties<T>

These are many of the properties that are used throughout the alarming system, provided/known by Ignition. Some of them are for configuration, and others are only used during runtime/execution. They all extend from AlarmProperty, so they can have a descriptive name, and a category, if appropriate. Both of those properties will be used in display, either on the configuration screen, or in code-assist situations like expression editors and other binding locations.

All property IDs should follow the standard camel-case, lower first letter convention. These will be displayed and used in bindings.

The values of this class are registered with the WellKnownAlarmPropertyDirectory.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CommonAlarmProperties.CalculatedAlarmProperty<R extends Serializable>

Field Summary

Fields

Modifier and Type	Field	Description
static final CommonAlarmProperties<String>	AckDuration	Elapsed time between ActiveTime and AckTime.
static final CommonAlarmProperties<Integer>	AckDurationMS	Elapsed time between ActiveTime and AckTime.
static final CommonAlarmProperties<AlertAckMode>	AckMode
static final CommonAlarmProperties<String>	AckNotes
static final CommonAlarmProperties<Boolean>	AckNotesReqd
static final CommonAlarmProperties<String>	AckPipeline
static final CommonAlarmProperties<Date>	AckTime
static final CommonAlarmProperties<QualifiedPath>	AckUser	The user who acknowledged the alarm, specified by an QualifiedPath that points to the user source and id.
static final CommonAlarmProperties<String>	AckUserName	This calculated helper property provides a friendlier display version of the ack user property.
static final CommonAlarmProperties<String>	ActiveDuration	Elapsed time between ActiveTime and ClearTime.
static final CommonAlarmProperties<Integer>	ActiveDurationMS	Elapsed time between ActiveTime and ClearTime, in milliseconds.
static final CommonAlarmProperties<String>	ActivePipeline
static final CommonAlarmProperties<Date>	ActiveTime
static final List<AlarmProperty<?>>	BASIC_BINDABLE_PROPS	These are the basic properties that are displayed for most binding contexts.
static final CommonAlarmProperties<Integer>	BranchDepth	Each time an alarm event is split in a pipeline, a new branch or instance is created.
static final CommonAlarmProperties<String>	ClearPipeline
static final CommonAlarmProperties<Date>	ClearTime
static final List<AlarmProperty<?>>	CONFIG_PROPS	These are the properties that are shown for configuration on all alarms.
static final CommonAlarmProperties<Double>	Deadband
static final CommonAlarmProperties<DeadbandMode>	DeadbandEvalMode
static final CommonAlarmProperties<String>	DisplayPath
static final CommonAlarmProperties<String>	DisplayPathOrSource	This path is going to be the string version of either the display path, if defined, or the source path.
static final CommonAlarmProperties<Boolean>	Enabled
static final CommonAlarmProperties<Boolean>	EventCanceled	This gets set to TRUE if the event should drop out of any pipeline that it is in - canceling any pending notification activities.
static final CommonAlarmProperties<UUID>	EventId
static final CommonAlarmProperties<AlarmStateTransition>	EventState	The most recent or most appropriate state transition of the event.
static final CommonAlarmProperties<Date>	EventTime
static final CommonAlarmProperties<Serializable>	EventValue
static final CommonAlarmProperties<String>	Filter	The string representation of an AlarmFilter.
static final CommonAlarmProperties<String>	FullItemPath	Much like ItemPath, but will include everything in the source path, such as the provider, project, etc.
static final List<AlarmProperty<?>>	INFO_PROPERTIES	These are properties that aren't config, but are used to get useful information, or calculated/derived values.
static final CommonAlarmProperties<Boolean>	IsAcked
static final CommonAlarmProperties<Boolean>	IsActive
static final CommonAlarmProperties<Boolean>	IsClear
static final CommonAlarmProperties<Boolean>	IsDisabledEvent
static final CommonAlarmProperties<Boolean>	IsEnabledEvent
static final CommonAlarmProperties<Boolean>	IsInitialEvent	Indicates that this (active) event has been caused by the initial value of a tag, either during load, or due to the tag's enabled state.
static final CommonAlarmProperties<Boolean>	IsJournaled
static final CommonAlarmProperties<Boolean>	IsReleased	This property is only used for internal communication of events that have been disconnected from their source alarms, usually due to the alarm going to disabled.
static final CommonAlarmProperties<Boolean>	IsShelved
static final CommonAlarmProperties<Boolean>	IsSystemEvent	This boolean indicates whether the event is a "system" event.
static final CommonAlarmProperties<Boolean>	IsTransitioningPipelines
static final CommonAlarmProperties<String>	ItemName	This helper property provides the name of the item holding the alarm, without its path *
static final CommonAlarmProperties<String>	ItemPath	This helper property should provide the path of the item holding the alarm.
static final CommonAlarmProperties<String>	Label
static final CommonAlarmProperties<Boolean>	LegacySendClear
static final CommonAlarmProperties<Integer>	LiveBranchCount
static final CommonAlarmProperties<Integer>	LivePipelineCount
static final CommonAlarmProperties<String>	Name
static final CommonAlarmProperties<String>	Notes
static final AlarmModeProperties<Boolean>	NotifyInitialEvent	This is a special api setting that indicates that we should ignore the concept of "initial" events and always notify, regardless of the gateway settings that may prevent initial notification.
static final List<AlarmProperty<?>>	OTHER_PROPERTIES	Any remaining properties, for translation
static final CommonAlarmProperties<String>	PipelineProject	The name of the Project that the pipelines specified by ActivePipeline, ClearPipeline, and AckPipeline reside in.
static final CommonAlarmProperties<Integer>	PipelineTransitionCount	This property is incremented each time the alarm transitions from block to block during execution.
static final CommonAlarmProperties<AlarmPriority>	Priority
static final List<AlarmProperty<?>>	RUNTIME_PROPERTIES	These are properties that do not allow configuration, as they only exist during runtime or execution.
static final CommonAlarmProperties<Date>	ShelfExpiration
static final CommonAlarmProperties<QualifiedPath>	ShelfUser
static final CommonAlarmProperties<Boolean>	ShelvingAllowed
static final CommonAlarmProperties<QualifiedPath>	Source
static final CommonAlarmProperties<AlarmState>	State	Alarm state is the full current state of an alarm in one enum, such as ActiveAcked.
static final CommonAlarmProperties<Boolean>	SystemAck
static final CommonAlarmProperties<Double>	TimeOffDelaySeconds
static final CommonAlarmProperties<Double>	TimeOnDelaySeconds
static final CommonAlarmProperties<TimestampSource>	TimestampSource

Constructor Summary

Constructors

Constructor	Description
CommonAlarmProperties()	Only for serialization.
CommonAlarmProperties(String simpleName, Class<T> dtype, T defaultVal)
CommonAlarmProperties(String simpleName, String category, Class<T> dtype, Object defaultVal, boolean bindable)	Deprecated.
CommonAlarmProperties(String simpleName, String category, Class<T> dtype, T defaultVal)
CommonAlarmProperties(String simpleName, String category, Class<T> dtype, T defaultVal, boolean bindable)

Method Summary

Modifier and Type	Method	Description
static String	formatDuration(Date activeTime, Date otherTime, FormatUtil.DurationFormatStyle format)
protected String	getBundleKeyBase()
LocalizedString	getCategory()	The category under which this property will be placed when editing.
String	getCategoryKey()
LocalizedString	getDescription()	Optional description/documentation for the property.
LocalizedString	getDisplayName()	A friendly display name for the property.
static AlarmProperty<?>[]	values()

Methods inherited from class com.inductiveautomation.ignition.common.alarming.config.WellKnownAlarmProperties

equals, getDefaultValue, getName, getType, hashCode, isAdvanced, isBindable, name, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

Name

public static final CommonAlarmProperties<String> Name

Enabled

public static final CommonAlarmProperties<Boolean> Enabled

Priority

public static final CommonAlarmProperties<AlarmPriority> Priority

Label

public static final CommonAlarmProperties<String> Label

DisplayPath

public static final CommonAlarmProperties<String> DisplayPath

PipelineProject

public static final CommonAlarmProperties<String> PipelineProject

The name of the Project that the pipelines specified by ActivePipeline, ClearPipeline, and AckPipeline reside in.

ActivePipeline

public static final CommonAlarmProperties<String> ActivePipeline

ClearPipeline

public static final CommonAlarmProperties<String> ClearPipeline

AckPipeline

public static final CommonAlarmProperties<String> AckPipeline

Deadband

public static final CommonAlarmProperties<Double> Deadband

DeadbandEvalMode

public static final CommonAlarmProperties<DeadbandMode> DeadbandEvalMode

TimeOnDelaySeconds

public static final CommonAlarmProperties<Double> TimeOnDelaySeconds

TimeOffDelaySeconds

public static final CommonAlarmProperties<Double> TimeOffDelaySeconds

TimestampSource

public static final CommonAlarmProperties<TimestampSource> TimestampSource

AckMode

public static final CommonAlarmProperties<AlertAckMode> AckMode

Notes

public static final CommonAlarmProperties<String> Notes

AckNotesReqd

public static final CommonAlarmProperties<Boolean> AckNotesReqd

ShelvingAllowed

public static final CommonAlarmProperties<Boolean> ShelvingAllowed

NotifyInitialEvent

public static final AlarmModeProperties<Boolean> NotifyInitialEvent

This is a special api setting that indicates that we should ignore the concept of "initial" events and always notify, regardless of the gateway settings that may prevent initial notification.

IsSystemEvent

public static final CommonAlarmProperties<Boolean> IsSystemEvent

This boolean indicates whether the event is a "system" event. System events are special in that by default, they get included in all Journal queries.

IsJournaled

public static final CommonAlarmProperties<Boolean> IsJournaled

IsInitialEvent

public static final CommonAlarmProperties<Boolean> IsInitialEvent

Indicates that this (active) event has been caused by the initial value of a tag, either during load, or due to the tag's enabled state.

SystemAck

public static final CommonAlarmProperties<Boolean> SystemAck

IsEnabledEvent

public static final CommonAlarmProperties<Boolean> IsEnabledEvent

IsDisabledEvent

public static final CommonAlarmProperties<Boolean> IsDisabledEvent

IsShelved

public static final CommonAlarmProperties<Boolean> IsShelved

LiveBranchCount

public static final CommonAlarmProperties<Integer> LiveBranchCount

LivePipelineCount

public static final CommonAlarmProperties<Integer> LivePipelineCount

IsTransitioningPipelines

public static final CommonAlarmProperties<Boolean> IsTransitioningPipelines

ShelfExpiration

public static final CommonAlarmProperties<Date> ShelfExpiration

ShelfUser

public static final CommonAlarmProperties<QualifiedPath> ShelfUser

EventCanceled

public static final CommonAlarmProperties<Boolean> EventCanceled

This gets set to TRUE if the event should drop out of any pipeline that it is in - canceling any pending notification activities.

Filter

public static final CommonAlarmProperties<String> Filter

The string representation of an AlarmFilter. Not parsable, just used for history/reference.

EventId

public static final CommonAlarmProperties<UUID> EventId

Source

public static final CommonAlarmProperties<QualifiedPath> Source

State

public static final CommonAlarmProperties<AlarmState> State

Alarm state is the full current state of an alarm in one enum, such as ActiveAcked. This is in comparison to the EventState property, which is the specific change that has most recently occurred.

EventState

public static final CommonAlarmProperties<AlarmStateTransition> EventState

The most recent or most appropriate state transition of the event. Not the full state of the alarm event, which is provided by the CATEGORY_STATE property.

EventTime

public static final CommonAlarmProperties<Date> EventTime

EventValue

public static final CommonAlarmProperties<Serializable> EventValue

AckUser

public static final CommonAlarmProperties<QualifiedPath> AckUser

The user who acknowledged the alarm, specified by an QualifiedPath that points to the user source and id. *

AckUserName

@Nullable
public static final CommonAlarmProperties<String> AckUserName

This calculated helper property provides a friendlier display version of the ack user property. *

AckNotes

public static final CommonAlarmProperties<String> AckNotes

IsAcked

public static final CommonAlarmProperties<Boolean> IsAcked

IsActive

public static final CommonAlarmProperties<Boolean> IsActive

IsClear

public static final CommonAlarmProperties<Boolean> IsClear

ActiveTime

public static final CommonAlarmProperties<Date> ActiveTime

ClearTime

public static final CommonAlarmProperties<Date> ClearTime

AckTime

public static final CommonAlarmProperties<Date> AckTime

IsReleased

public static final CommonAlarmProperties<Boolean> IsReleased

This property is only used for internal communication of events that have been disconnected from their source alarms, usually due to the alarm going to disabled. It should not be used externally to look up state.

ActiveDuration

public static final CommonAlarmProperties<String> ActiveDuration

Elapsed time between ActiveTime and ClearTime.

ActiveDurationMS

public static final CommonAlarmProperties<Integer> ActiveDurationMS

Elapsed time between ActiveTime and ClearTime, in milliseconds. If not clear, calculates to the current time.

AckDuration

public static final CommonAlarmProperties<String> AckDuration

Elapsed time between ActiveTime and AckTime.

AckDurationMS

public static final CommonAlarmProperties<Integer> AckDurationMS

Elapsed time between ActiveTime and AckTime.

DisplayPathOrSource

public static final CommonAlarmProperties<String> DisplayPathOrSource

This path is going to be the string version of either the display path, if defined, or the source path. *

ItemPath

@Nullable
public static final CommonAlarmProperties<String> ItemPath

This helper property should provide the path of the item holding the alarm. It also includes the item name. It does not, however, include anything above the item path in the full source path (for that, use FullItemPath).

FullItemPath

@Nonnull
public static final CommonAlarmProperties<String> FullItemPath

Much like ItemPath, but will include everything in the source path, such as the provider, project, etc.

ItemName

@Nonnull
public static final CommonAlarmProperties<String> ItemName

This helper property provides the name of the item holding the alarm, without its path *

BranchDepth

public static final CommonAlarmProperties<Integer> BranchDepth

Each time an alarm event is split in a pipeline, a new branch or instance is created. This property can be used to see and limit how many times has has or can happen.

PipelineTransitionCount

public static final CommonAlarmProperties<Integer> PipelineTransitionCount

This property is incremented each time the alarm transitions from block to block during execution. The pipelines limit the number of times an event can be transferred, in order to prevent infinite loops.

LegacySendClear

public static final CommonAlarmProperties<Boolean> LegacySendClear

CONFIG_PROPS

public static final List<AlarmProperty<?>> CONFIG_PROPS

These are the properties that are shown for configuration on all alarms. Based on the mode, different properties are shown (those are defined in AlarmModeProperties)

BASIC_BINDABLE_PROPS

public static final List<AlarmProperty<?>> BASIC_BINDABLE_PROPS

These are the basic properties that are displayed for most binding contexts. Other properties can be referenced, but these the the common properties defined in this class that are generally referenced.

INFO_PROPERTIES

public static final List<AlarmProperty<?>> INFO_PROPERTIES

These are properties that aren't config, but are used to get useful information, or calculated/derived values.

OTHER_PROPERTIES

public static final List<AlarmProperty<?>> OTHER_PROPERTIES

Any remaining properties, for translation

RUNTIME_PROPERTIES

public static final List<AlarmProperty<?>> RUNTIME_PROPERTIES

These are properties that do not allow configuration, as they only exist during runtime or execution.

Constructor Details

CommonAlarmProperties

public CommonAlarmProperties()

Only for serialization. *

CommonAlarmProperties

public CommonAlarmProperties(String simpleName,
 Class<T> dtype,
 T defaultVal)

CommonAlarmProperties

public CommonAlarmProperties(String simpleName,
 String category,
 Class<T> dtype,
 T defaultVal)

CommonAlarmProperties

@Deprecated
public CommonAlarmProperties(String simpleName,
 String category,
 Class<T> dtype,
 Object defaultVal,
 boolean bindable)

Deprecated.

This is only to work around an apparent problem with type detection in xml serialization. *

CommonAlarmProperties

public CommonAlarmProperties(String simpleName,
 String category,
 Class<T> dtype,
 T defaultVal,
 boolean bindable)

Method Details

formatDuration

public static String formatDuration(Date activeTime,
 Date otherTime,
 FormatUtil.DurationFormatStyle format)

getCategoryKey

public String getCategoryKey()

getBundleKeyBase

protected String getBundleKeyBase()

getDisplayName

public LocalizedString getDisplayName()

Description copied from interface: DescriptiveProperty

A friendly display name for the property. If not set, will return a raw LocalizedString that contains the property name.

getCategory

public LocalizedString getCategory()

Description copied from interface: DescriptiveProperty

The category under which this property will be placed when editing.

getDescription

public LocalizedString getDescription()

Description copied from interface: DescriptiveProperty

Optional description/documentation for the property. May return null if no information is available.

values

public static AlarmProperty<?>[] values()