Customizing object and alarm states of predefined business objects

TGO > Programmers documentation > Styling > Using Cascading Style Sheets > Customizing object and alarm states of predefined business objects

Describes how to customize the object and alarm states of all the predefined business objects.

Overview of customizing the states of predefined business objects

Lists the properties that you can use to customize the state parameters in the graphic representation of a business object.

Secondary states and information window properties

Lists the properties for customizing the secondary states and information window and explains how to use them.

Alarm configuration properties

Lists the properties for customizing the alarm configuration and explains how to use them.

Alarm balloon configuration properties

Lists the properties for customizing the alarm balloon configuration and explains how to use them.

Alarm count configuration properties

Lists the properties for customizing the alarm count configuration and explains how to use them.

SNMP system info configuration properties

Lists the properties for customizing the system info configuration and explains how to use them.

Changing the icon color of predefined business objects

Shows you how to change the color of business objects that belong to a predefined business class (tree component, network component, and equipment component).

Overview of customizing the states of predefined business objects

Customizing state parameters in the graphic representation of a business object is based on the following properties:

Secondary states and information window properties

Alarm configuration properties

Alarm balloon configuration properties

Alarm count configuration properties

SNMP system info configuration properties

Secondary states and information window properties

Properties for customizing secondary states and information window

CSS properties for secondary states and information window
Property Name	Type	Default Value	Description
baseStyleEnabled	boolean	true for all objects except groups	Defines whether the object base is modified according to the object state set in the instance.
secondaryStateVisible	boolean	true	Defines whether the secondary state icons are displayed or not
secondaryStatePosition	IlvDirection	Top	Defines the position of the secondary state icons relative to the base. Possible values are: Top Bottom.
infoIconThreshold	int	2	Defines the maximum number of secondary state icons that can be displayed. When the number of secondary state icons is bigger than this threshold, the icons are replaced by an information icon and the state information is available through the Information window.
infoWindowColor	Color	10% gray	Defines the color used to draw the background of the Information window.
infoWindowBorderColor	Color	black	Defines the color used to draw the border of the Information window.
infoWindowShadowColor	Color	60% gray	Defines the color used to draw the shadow of the information window.
infoWindowVisible	boolean	true	Determines whether the Information window is visible or not.
infoWindowPresent	boolean	false	Determines whether the Information window is always available. When this value is set to false, the Information window is only available when the number of secondary state icons exceeds the limit defined by the property infoWindowThreshold. When this value is set to true, the Information window can be accessed by clicking the secondary state icons.
infoWindowTextFont	Font	Helvetica 10	Defines the font of the text displayed in the Information Window.
infoWindowTextAntialiasing	boolean	true	Determines whether the text displayed in the Information window uses anti-aliasing or not.
infoWindowTextBackground	Color	null	Defines the background color of the text displayed in the Information window.
infoWindowTextForeground	Color	black	Defines the foreground color of the text displayed in the Information window.
listPrimaryState	boolean	true for OSI and SNMP false for other state systems	Determines whether the primary state information is listed in the Information window or not.
listPrimaryAlarmState	boolean	false	Lists the primary alarm state information in the Information window.
listSecondaryAlarmState	boolean	false	Lists the secondary alarm state information in the Information window.
listAlarmStateAbbreviated	boolean	false	Determines whether the alarm state information listed in the Information window displays alarm severities using their abbreviation or their description.

How to customize the secondary states

The following CSS extract modifies the network element graphic representation by specifying that the Information window will always be available when the object has secondary states. To open the Information window, simply click any of the secondary state icons or the Information icon, if it is present.

object."ilog.tgo.model.IltNetworkElement" {

infoWindowPresent: true;

listPrimaryAlarmState: true;

listSecondaryAlarmState: true;

listState: true;

}

This extract also specifies that the primary state information and the alarm state information are displayed in the Information window.

Alarm configuration properties

Properties for customizing the alarm configuration

CSS properties for the alarm configuration
Property Name	Type	Default Value	Description
primaryAlarmState	IltAlarmStateEnum	Raw	Determines whether the raw alarms or the impact alarms are displayed as the primary alarm state. Possible values are: Raw Impact
alarmBorderVisible	boolean	true	Indicates whether the alarm border is visible or not around the object base.
alarmBorderColor	Color	transparent ( null )	Defines the color used to represent the alarm border around the base.
alarmBorderWidth	int	2	Defines the width of the alarm border.
alarmColorVisible	boolean	true	Determines whether the alarm color is visible or not in the object value.
alarmColor	Color	transparent ( null )	Determines the color representing alarms in the object base. This property is only taken into account when property alarmColorVisible is set to true.
alarmBrightColor	Color	transparent ( null )	Determines the bright color representing alarms in the object base. This property is only taken into account when property alarmColorVisible is set to true.
alarmDarkColor	Color	transparent ( null )	Determines the dark color representing alarms in the object base. This property is only taken into account when property alarmColorVisible is set to true.
alarmAsMark	boolean	false	Defines whether the new alarm information is displayed using the alarm balloon or an alarm marker. The alarm marker is another type of balloon with a triangular format. It is displayed in the color of the new alarm highest severity, without the alarm count information.
alarmLossOfConnectivityOverride	boolean	true	Denotes whether the loss of connectivity alarm state overrides the highest alarm representation in the object base. If the object has the loss of connectivity state set and this property is set to true, the object base is displayed using the loss of connectivity colors. If this property is set to false, the object base is displayed as usual, and the loss of connectivity is represented using a secondary state icon.
alarmLossOfConnectivityPosition	IltGraphicElementName	AlarmCount	Defines the position of the loss of connectivity indicator when the loss of connectivity override property is set to true. Possible values are: AlarmCount : the indicator is the string specified by the Alarm.LossOfConnectivity.Abbreviation setting and is displayed as an alarm count. SecondaryStateModifiers : the indicator is the loss of connectivity icon. It is displayed as a secondary state and takes the loss of connectivity color.

How to customize the alarm representation for predefined business objects

The following CSS extract modifies the graphic representation of network element objects, so that raw alarms are considered as primary alarms. As such, they are represented in the object base, the alarm count and the alarm balloon using the default JViews TGO look and feel. In addition, the example modifies the object so that, when the Loss Of Connectivity alarm state is set, it is graphically represented as a secondary state icon and the object base color and object border color are not affected.

object."ilog.tgo.model.IltNetworkElement" {

primaryAlarmState: Raw;

alarmLossOfConnectivityOverride: false;

}

How to customize the alarm representation for predefined business objects to use blinking colors

The following CSS extract shows how you can modify the object representation of JViews TGO predefined business objects to use blinking colors instead of alarm balloon decorations to highlight the presence of new alarms.

This extract illustrates the following configuration:

The alarm balloon decoration is hidden

New alarms are represented in the object base by blinking colors

Outstanding alarms are represented in the object base using the default color configuration

The loss of connectivity status is represented in the object base using the default color configuration

To achieve this configuration, the following CSS properties are used:

alarmBalloonVisible

alarmColorVisible

alarmColor

alarmBrightColor

alarmDarkColor

object."ilog.tgo.model.IltObject" {

alarmBalloonVisible: false;

alarmColorVisible: false;

alarmColor: '';

alarmBrightColor: '';

alarmDarkColor: '';

}

object."ilog.tgo.model.IltObject"[alarmHighestSeverity] {

alarmColorVisible: true;

alarmColor: '@|severityColor(@|highestSeverity())';

alarmBrightColor: '@|severityBrightColor(@|highestSeverity())';

alarmDarkColor: '@|severityDarkColor(@|highestSeverity())';

}

object."ilog.tgo.model.IltObject"[newAlarmHighestSeverity] {

alarmColorVisible: true;

alarmColor: '@|blinkingcolor(@|severityColor(@|highestNewSeverity()),

"#50FFFFFF")';

alarmBrightColor:

'@|blinkingcolor(@|severityBrightColor(@|highestNewSeverity()), "#50FFFFFF")';

alarmDarkColor: '@|blinkingcolor(@|severityDarkColor(@|highestNewSeverity()),

"#50FFFFFF")';

}

object."ilog.tgo.model.IltObject"["objectState.Alarm.LossOfConnectivity"=true]

{

alarmColorVisible: true;

alarmColor: '@|settings("Alarm.LossOfConnectivity.Color")';

alarmBrightColor: '@|settings("Alarm.LossOfConnectivity.BrightColor")';

alarmDarkColor: '@|settings("Alarm.LossOfConnectivity.DarkColor"';

}

NOTE Blinking colors are not supported in table and tree components.

You can also customize the default alarm configuration. For more information, refer to Customizing alarm severities.

Alarm balloon configuration properties

Properties for customizing the alarm balloon configuration

The following properties apply to the alarm balloon displayed on the base of predefined business objects.

CSS properties for alarm balloon representations
Property Name	Type	Default Value	Description
alarmBalloonVisible	boolean	true	Denotes whether the alarm balloon is visible or not.
alarmBalloonColor	Color	28% grey	Denotes the color of the alarm balloon. This property is mapped and its value is set according to the color of the highest alarm severity present in the object.
alarmBalloonShadowColor	Color	black	Denotes the color of the alarm balloon shadow.
alarmBalloonTextFont	Font	Helvetica 12 bold	Denotes the font used to display the text in the alarm balloon.
alarmBalloonTextAntialiasing	boolean	true	Denotes whether the text inside the alarm balloon is displayed with anti-aliasing or not.
alarmBalloonTextForeground	Color	black	Denotes the foreground color used to display the text in the alarm balloon.
alarmBalloonTextBackground	Color	transparent ( null )	Denotes the background color used to display the text in the alarm balloon.
alarmBalloonCountAbbreviated	boolean	false	Denotes whether the alarm count displayed in the alarm balloon is abbreviated or not in its collapsed representation. An abbreviated alarm count displays only the number of alarms and the alarm severity abbreviation for the highest alarm present in the object.
alarmBalloonCountLabel	String	The alarm count to be displayed in the object alarm balloon. It is composed of the number of new alarms of the highest severity, the short description of the highest new alarm severity and a '+' sign in case the object has other alarms of lower severity. For example: 10C+	Defines the label to be used for the alarm count in the alarm balloon.
alarmBalloonCountIcon	Image	The image registered for the highest new alarm severity currently present in the object	Defines the image to be used with the label to compose the alarm count in the alarm balloon.
alarmBalloonPosition	IlvDirection	Top	Denotes the position of the alarm balloon around the object base. Possible values are: Top Bottom Left, Right
alarmBalloonCollapsed	boolean	true	Denotes whether the alarm count displayed in the alarm balloon is abbreviated or not. When this property is set to false, the balloon displays the complete list of alarms according to their severities.
alarmCountIconVisible	boolean	true	Determines whether the alarm count icon will be used to create the alarm count in the object base and in the alarm balloon.
alarmCountIconPosition	int	IlvConstants.TRAILING	Defines whether the alarm count icon will be placed before or after the alarm severity description. Possible values are: IlvConstants.LEADING or IlvConstants.TRAILING.

How to customize the alarm balloon representation

The following CSS extract illustrates how you can customize the alarm balloon representation in your predefined business objects.

object."ilog.tgo.model.IltNetworkElement" {

alarmBalloonPosition: Bottom;

alarmBalloonTextForeground: white;

}

Alarm count configuration properties

Properties for customizing the alarm count configuration

The following properties apply to the alarm count displayed on the base of predefined business objects.

CSS properties for alarm count
Property Name	Type	Default Value	Description
alarmCountVisible	boolean	true	Denotes whether the alarm count in the object base is visible or not.
alarmCountFont	Font	Helvetica 12 bold	Denotes the font used in alarm counts displayed in the object base.
alarmCountForeground	Color	black	Denotes the foreground color of the alarm count text displayed in the object base.
alarmCountBackground	Color	transparent ( null )	Denotes the background color of the alarm count text displayed in the object base.
alarmCountAbbreviated	boolean	false	Denotes whether the alarm count in the object base is abbreviated or not.
alarmCountAntialiasing	boolean	true	Denotes whether the alarm count in the object base is displayed using anti-aliasing or not.
alarmCountMultiline	boolean	false, except for network elements of type NEComponent and NEComponent_Logical	Denotes whether the alarm count in the object base displays on two lines or not. When this property is set to true, the number of alarms displays on the first line and the alarm severity abbreviation displays on the second line.
alarmCountLabel	String	The alarm count to be displayed in the object base. It is composed of the number of outstanding alarms of the highest severity, the short description of the highest outstanding alarm severity and a '+' sign in case the object has other alarms of lower severity. For example: 10C+	Defines the label to be used for the alarm count in the object base.
alarmCountIcon	Image	The image registered for the highest outstanding alarm severity currently present in the object	Defines the image to be used with the label to compose the alarm count in the object base.
alarmCountIconPosition	int	IlvConstants.TRAILING	Defines whether the alarm count icon will be placed before or after the alarm severity description. Possible values are: IlvConstants.LEADING or IlvConstants.TRAILING.
alarmCountIconVisible	boolean	true	Determines whether the alarm count icon will be used to create the alarm count in the object base and in the alarm balloon.

How to customize the alarm count representation

The following CSS extract illustrates how you can customize the graphic representation of the alarm count displayed on the object base.

object."ilog.tgo.model.IltNetworkElement" {

alarmCountAntialiasing: true;

alarmCountForeground: yellow;

}

SNMP system info configuration properties

Properties for customizing the system info configuration

The following properties apply when a business object has an SNMP object state:

CSS properties applying to SNMP system group
Property Name	Type	Default Value	Description
snmpSystemContact	String	Contact ( ilog.tgo.SNMP_System_Contact ) The value in parenthesis represents the name of the resource that stores the value of the property in the JViews TGO Resource bundle. When dealing with different locales, the value can be changed according to the locale by defining the value of this property in the appropriate resource file.	Defines the property that denotes the description of the SNMP system contact attribute.
snmpSystemDescription	String	Description ( ilog.tgo.SNMP_System_Description ) The value in parenthesis represents the name of the resource that stores the value of the property in the JViews TGO Resource bundle. When dealing with different locales, the value can be changed according to the locale by defining the value of this property in the appropriate resource file.	Defines the property that denotes the description of the SNMP system description attribute.
snmpSystemLocation	String	Location ( ilog.tgo.SNMP_System_Location ) The value in parenthesis represents the name of the resource that stores the value of the property in the JViews TGO Resource bundle. When dealing with different locales, the value can be changed according to the locale by defining the value of this property in the appropriate resource file.	Defines the property that denotes the description of the SNMP system location attribute.

Changing the icon color of predefined business objects

In these components, the predefined business class is an extension of IltNetworkElement. The color is customized with the property foreground.

The following extract of XML represents the definition of a business class that extends the predefined business class IltNetworkElement.

How to extend a predefined business class

<class>

<name>myNetworkElement</name>

<superClass>ilog.tgo.model.IltNetworkElement</superClass>

<name>siteName</name> <javaClass>java.lang.String</javaClass>

</attribute>

<name>customerName</name> <javaClass>java.lang.String</javaClass>

</attribute>

</class>

How to use literal values for customizing colors

object.myNetworkElement {

foreground: '#FF0000';

}

In this example, the foreground color of the icon representing business objects of the class myNetworkElement is set to red.

How to customize the icon color based on specific attribute values

object.myNetworkElement[type=NE] {

foreground:'#FFFFFF';

}

object.myNetworkElement[type=MD] {

foreground:'#C0C0C0';

}

object.myNetworkElement[type=Server] {

foreground:'#FFCC00';

}

object.myNetworkElement[type=BSC] {

foreground:'#FFB200';

}

object.myNetworkElement[type=Desktop] {

foreground:'#FF0000';

}

In this example, the foreground color of the icon representing business objects of the class myNetworkElement is set to depend on the value of the attribute type defined in the class IltNetworkElement. So myNetworkElement with the type NE will have a white foreground.