Describes the SAN secondary states and how to create and customize them.

The SAN (Storage Area Network) State Dictionary provides secondary state values that can be used to complement OSI, Bellcore, SNMP, or SONET standards. The secondary states included in this dictionary can be used to model and represent any state with a numeric value. For information on the dictionary and its graphical representation,

Refer to SAN states: the SAN state dictionary in the Business Objects and Data Sources documentation.

You can create your own SAN secondary state, and configure how new and existing secondary states are graphically represented in your objects.

How to create new SAN states (using the API)

SAN secondary states are created using IltSAN.NewSecState, as follows:

NewSecState takes two arguments. The first one is a name that identifies the new SAN state in the application. The name must comply with the rule SAN.SecState.<value>. For example, when a new state is created with name SAN.SecState.CPUUtilization, it is referred to in XML files in the following way:

The second argument is a description. This description is used as a tooltip to display more information about the SAN state represented in a business object. To activate the tooltip support for secondary states, see Customizing tooltips.

NewSecState returns an instance of IltSAN.SecState, that you can use in exactly the same way as the predefined SAN secondary states.

Once a new SAN secondary state has been created, you need to configure its graphic representation. See Customizing SAN Secondary States for more information.

How to create new SAN states (using CSS)

You can also create new SAN secondary states by using global CSS settings:

SAN states explains how to customize the object representation according to the SAN state information. You can also customize the decoration that is displayed when a given SAN secondary state is set in the object.

In the SAN state dictionary, the secondary states are numeric and by default they are represented by a gauge. There are also two other possible representations for these states. The IltDecorationType class defines the possible graphical representations. The possible values of this class are:

How to customize a SAN secondary state decoration (using the API)

SAN secondary states can be displayed as charts, gauges or counters. By default, the gauge decoration is used. If you want to indicate that you are going to use another type of representation, without changing the default configuration for each representation, modify the secondary state information as follows:

The property to be set is built in the following way: “<STATE NAME>.Type”. For example, SAN.SecState.Available.Type or SAN.SecState.CPUUtilization.Type.

How to customize a SAN secondary state decoration (using CSS)

You can also customize a SAN secondary state decoration by using global CSS settings. For more information, see Using global settings.

You must specify the full state name, for example " SAN.SecState.CPUUtilization ", when matching the " name " attribute. The CSS property to be customized is type.

How to modify the gauge graphical representation of a SAN secondary state (using the API)

When a SAN secondary state is graphically represented by a gauge decoration, the configuration of this decoration has to be previously defined. All SAN secondary states have a predefined gauge representation. Refer to SAN states: the SAN state dictionary in the Business Objects and Data Sources documentation for information on how each secondary state is graphically represented.

Suppose you have a secondary state that is configured with a gauge decoration as follows:

You can modify this decoration in the following way:

You can also create a new gauge mapping, and set the new value in the following way:

How to modify the gauge graphical representation of a SAN secondary state (using CSS)

You can also customize the gauge graphic representation by using global CSS settings. You must specify the full state name, for example " SAN.SecState.CPUUtilization ", when matching the " name " attribute. The CSS property to be customized is gauge.

When defining a new gauge mapping class, the following CSS properties are used: minImage, maxImage, direction, colorModifier. They match corresponding set methods of the IltGaugeMapping class (and its super class). Refer to ilog.tgo.graphic.IltGaugeMapping for information on how to customize the gauge decorations.

In the example below, the color modifier class named MyColorModifier has been created and included in the search path.

How to modify the chart graphical representation of a SAN secondary state (using the API)

When a SAN secondary state is graphically represented by a chart decoration, the configuration of this decoration has to be previously defined. All SAN secondary states have a predefined chart representation. Refer to SAN states: the SAN state dictionary in the Business Objects and Data Sources documentation for information on how each secondary state is graphically represented.

Suppose you have a secondary state that is configured with a chart decoration as follows:

You can modify this decoration in the following way:

You can also create a new chart mapping, and set the new value in the following way:

How to modify the chart graphical representation of a SAN secondary state (using CSS)

You can also customize the chart graphic representation by using global CSS settings. You must specify the full state name, for example " SAN.SecState.CPUUtilization ", when matching the " name " attribute. The CSS property to be customized is chart.

When defining a new chart mapping class, the following CSS properties are used: minImage, maxImage, xAxisDirection, yAxisDirection, colorModifier. They match corresponding set methods of the IltChartMapping class (and its super class). Refer to ilog.tgo.graphic.IltChartMapping for information on how to customize the chart decorations.

In the example below, the color modifier class named MyColorModifier has been created and included in the search path.

How to modify the counter graphical representation of a SAN secondary state (using the API)

When a SAN secondary state is graphically represented by a counter decoration, the configuration of this decoration has to be previously defined. All SAN secondary states have a predefined counter representation. Refer to SAN states: the SAN state dictionary in the Business Objects and Data Sources documentation for information on how each secondary state is graphically represented.

Suppose you have a secondary state that is configured with a counter decoration as follows:

You can modify this decoration in the following way:

How to modify the counter graphical representation of a SAN secondary state (using CSS)

You can also customize the counter graphic representation by using global CSS settings. You must specify the full state name, for example " SAN.SecState.CPUUtilization ", when matching the " name " attribute. The CSS property to be customized is counter.

When defining a new counter mapping class, the following CSS properties are used: format, font, antialiasing, foregroundColor, backgroundColor, borderColor, xPadding, yPadding. They match corresponding set methods of the IltCounterMapping class (and its super class). Refer to ilog.tgo.graphic.IltCounterMapping for information on how to customize the counter decorations.