Alarm Object Class

Business Objects and Data Sources > Alarms > Alarm Object Class

Alarm Object Class

Alarms are predefined business objects of the class ilog.tgo.model.IltAlarm, that you can directly insert in an ILOG JViews TGO data source and represent graphically in a table or tree component connected to the data source.

Alarms are used to represent individual alarm conditions occurring in managed objects.

The IltAlarm class defines the following attributes:

Table 11.1 Attributes of IltAlarm

Attribute Name	Value Class	Description
`ackSystemId`	`String`	Identifier of the system used by the author of the last modification of the acknowledged state.
`ackTime`	`java.util.Date`	Date of the last modification of the acknowledged state.
`ackUserId`	`String`	Identifier of the author of the last modification of the acknowledged state.
`additionalText`	`String`	Additional information about the alarm.
`alarmAckState`	`Boolean`	The acknowledged state of the alarm.
`alarmChangedTime`	`java.util.Date`	Date of the last modification of alarm attribute values.
`alarmClearedTime`	`java.util.Date`	Date when the perceived severity of the alarm was changed to Cleared.
`alarmRaisedTime`	`java.util.Date`	Date when the alarm was raised.
`alarmType`	`IltAlarm.AlarmType`	The type of alarm.
`attributesChanges`	`Object`	The list of changed attributes.
`backedUpStatus`	`Boolean`	The backup status. Indicates whether the managed object has a backup object.
`backUpObject`	`String`	Distinguished name of the backup object.
`clearSystemId`	`String`	Identifier of the system used by the author of the last request to clear the alarm.
`clearUserId`	`String`	Identifier of the author of the last request to clear the alarm.
`comments`	`Object`	List of comments.
`correlatedNotifications`	`Object`	The correlated notifications. This attribute identifies a set of notifications to which this notification is considered to be correlated.
`graphicRepresentation`		Fake attribute used to make it possible to display the alarm object in one column of a table. This attribute cannot be set a value directly.
`managedObjectClass`	`String`	Managed object class of the managed object instance in which the alarm occurred.
`managedObjectInstance`	`String`	The managed object instance in which the alarm occurred. See Setting the Alarm Counters.
`monitoredAttributes`	`Object`	The attributes that are monitored.
`notificationId`	`String`	Identifier of the notification that carries the alarm information.
`perceivedSeverity`	`IltAlarmSeverity`	The perceived severity of the alarm. It indicates the relative level of urgency for operator attention. Values are defined in `IltAlarm.Severity` for raw alarms, and in `IltAlarm.ImpactSeverity` for impact alarms. The perceived severity is used to determine the color of the alarm icon in table and tree components.
`probableCause`	`IltAlarm.ProbableCause`	The probable cause of the alarm.
`proposedRepairActions`	`String`	The proposed repair actions.
`specificProblem`	`String`	The specific problem. Provides more information on the alarm than `probableCause`.
`systemDN`	`String`	The distinguished name of the system that detected the network event and generated the notificationl
`thresholdInfo`	`Object`	The information about the threshold.
`trendIndication`	`IltAlarm.TrendIndication`	The trend indication. This attribute indicates whether the observed condition is getting better, worse, or is unchanged.

Note

The attributes with the Java class Object may be populated with objects of any type.

You can retrieve the class IltAlarm using its GetIlpClass method. You can handle its instances as simple IlpObject instances and set and get its attributes with the generic methods getAttributeValue and setAttributeValue.

The class IltAlarm also provides convenience methods, such as getPerceivedSeverity and setPerceivedSeverity, that you can use directly to access each individual predefined attribute of the class.

The perceived severity of raw alarms is of type IltAlarm.Severity, whereas the perceived severity of impact alarms is of type IltAlarm.ImpactSeverity. JViews TGO provides the following predefined severities that are statically allocated and stored in static data members of IltAlarm:

For raw alarms, the available severity values are the following:

For impact alarms, the available severity values are the following:

You can define other severities to extend the default alarm model. For details, refer to Customizing Alarm Severities in the Styling documentation.

PREVIOUS NEXT