Alarms

Release Notes > JTGO 4.0 Release Notes > Compatibility Issues > Alarms

Alarms

JTGO 4.0 has introduced a new category of alarms, called impact alarms. They are different from raw alarms. Raw alarms have a severity of type IltAlarm.Severity, whereas impact alarms have a severity of type IltAlarm.ImpactSeverity. When it is not specified, the term `alarm' refers to both raw and impact alarms. The behavior of the method IltAlarm.State has changed and new methods have also been introduced. Note that these changes should not impact existing applications that do not use the new impact alarm severities.

The following changed and new methods have been introduced:

methods getAlarmCount(), and getNewAlarmCount(), getAcknowledgedAlarmCount() include both raw and impact alarms.
New methods getRawAlarmCount(), getNewRawAlarmCount(), and getAcknowledgedRawAlarmCount() include only raw alarms.
New methods getImpactAlarmCount(), getNewImpactAlarmCount(), and getAcknowledgedImpactAlarmCount() include only impact alarms.
New methods acknowledgeAllAlarms(), removeAllAlarms(), removeAllAcknowledgedAlarms(), removeAllNewAlarms()affect both raw and impact alarms.
New methods acknowledgeAllRawAlarms(), removeAllRawAlarms(), removeAllAcknowledgedRawAlarms(), and removeAllNewRawAlarms() affect only raw alarms.
New methods acknowledgeAllImpactAlarms(), removeAllImpactAlarms(), removeAllAcknowledgedImpactAlarms(), and removeAllNewImpactAlarms() affect only impact alarms.
The signature of the methods IltAlarm.State.getHighestAcknowledgedAlarmSeverity(), IltAlarm.State.getHighestAlarmSeverity(), IltAlarm.State.getHighestNewAlarmSeverity() has changed. The return value is now an IltAlarmSeverity, a super-class of IltAlarm.Severity and IltAlarm.ImpactSeverity. Existing applications that do not plan to use impact alarms can safely cast the return value to IltAlarm.Severity.
Following the introduction of the severity Cleared, the applications that need to use this new severity should reconsider the use of the following methods IltAlarm.State.getHighestAcknowledgedAlarmSeverity(), IltAlarm.State.getHighestAlarmSeverity(), IltAlarm.State.getHighestNewAlarmSeverity().

In particular tests such as:

IltAlarm.State alarmState = ...;

if (alarmState.getHighestAlarmSeverity() == null) {

// No more alarms

// ...

should be changed to:

IltAlarm.State alarmState = ...;

IltAlarmSeverity highestSeverity = alarmState.getHighestAlarmSeverity();

if ((highestSeverity == null)||(highestSeverity.getSeverity() == 0)) {

// No more alarms

// ...

The new CSS property primaryAlarmState, with possible values 'raw' or 'impact', controls whether raw alarms or impact alarms display their balloon on a given object. The alarms for the secondary alarm state are displayed as secondary icons.
The new CSS properties listPrimaryAlarmState and listSecondaryAlarmState are available to list the alarm information in the information window along with the other states present in the object. listSecondaryAlarmState default value is set to true, so that the secondary alarms can be seen by the user even though they do not affect the graphic representation of the object. listPrimaryAlarmState default value is set to false, as the information is already displayed in the graphic representation through the alarm color, alarm count and alarm balloon decorations.

Alarm Severities in XML and CSS

The representation of alarm severities in a data source XML stream has changed. The following format is now deprecated:

  <new severity="Critical">2</new>

  <ack severity="Major">1</ack>

Instead use:

  <new severity="Raw.Critical">2</new>

  <ack severity="Raw.Major">1</ack>

Similarly, the representation of alarm severities in style sheets has changed. The following format is now deprecated:

  object."ilog.tgo.model.IltObject"["objectState.Alarm.Critical.New"] {

Instead use:

  object."ilog.tgo.model.IltObject"["objectState.Alarm.Raw.Critical.New"] {

The format for impact alarm severities is similar and uses the "Impact." prefix.

The format for trap types is unchanged, that is, it has no prefix.

PREVIOUS NEXT