Customizing SNMP secondary states

How to customize an SNMP secondary state decoration (using the API)

SNMP 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.

IltSettings.SetValue("SNMP.Interface.InOctets.Type", IltDecorationType.Chart);

The property to be set is based on the SNMP state name followed by “ .Type ”, for example, SNMP.ICMP.InMsgs.Type or SNMP.TCP.OutSegs.Type .

How to customize an SNMP secondary state decoration (using CSS)

You can customize an SNMP secondary state decoration using global CSS settings.

You must specify the full state name, for example " SNMP.Interface.InOctets ", when matching the " name " attribute. The CSS property to be customized is type .

setting."ilog.tgo.model.IltState"[name="SNMP.Interface.InOctets"] {
   type: Counter;
}

For more information on global CSS settings, see

How to modify the gauge graphical representation of an SNMP secondary state (using the API)

When an SNMP secondary state is graphically represented by a gauge decoration, the configuration of this decoration has to be previously defined. All SNMP secondary states have a predefined gauge representation. For information on how each secondary state is graphically represented, refer to

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

IltSettings.SetValue("SNMP.ICMP.OutErrors.Type", IltDecorationType.Gauge);

You can modify this decoration in the following way.

IltColorModifier modifier1 = new IltColorModifier.Shade(0.5f);
IltColorModifier modifier2 = new
    IltColorModifier.MultiColor(IltColorModifier.MultiColor.USE_LAST_VALUE);
IltColorModifier modifier = modifier1.compose(modifier2);

IltGaugeMapping mapping = (IltGaugeMapping)
    IltSettings.GetValue("SNMP.ICMP.OutErrors.Gauge");
mapping.setColorModifier(modifier);

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

IltGaugeMapping mapping = new IltGaugeMapping(minImg, maxImg);
IltSettings.SetValue("SNMP.ICMP.OutErrors.Gauge", mapping);

How to modify the gauge graphical representation of an SNMP secondary state (using CSS)

You can customize the gauge graphical representation using global CSS settings. You must specify the full state name, for example " SNMP.Interface.InOctets ", 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).

setting."ilog.tgo.model.IltState"[name="SNMP.ICMP.OutErrors"] {
  gauge: @+gaugeSnmp;
}
Subobject#gaugeSnmp {
  class: 'ilog.tgo.graphic.IltGaugeMapping';
  minImage: '@|image("icon1.png")';
  maxImage:'@|image("icon2.png")';
  direction: Bottom;
  colorModifier: @+myColorModifier;
}
Subobject#myColorModifier {
  class: "MyColorModifier";
}

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

For information on how to customize the gauge decorations, refer to ilog.tgo.graphic.IltGaugeMapping .

How to modify the chart graphical representation of an SNMP secondary state (using the API)

When an SNMP secondary state is graphically represented by a chart decoration, the configuration of this decoration has to be previously defined. All SNMP secondary states have a predefined chart representation. Refer to The SNMP 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:

IltSettings.SetValue("SNMP.ICMP.OutErrors.Type", IltDecorationType.Chart);

You can modify this decoration in the following way:

IltColorModifier modifier1 = new IltColorModifier.Shade(0.5f);
IltColorModifier modifier2 =
  new IltColorModifier.MultiColor(IltColorModifier.MultiColor.USE_LAST_VALUE);
IltColorModifier modifier = modifier1.compose(modifier2);

IltChartMapping mapping = (IltChartMapping)
  IltSettings.GetValue("SNMP.ICMP.OutErrors.Chart");
mapping.setColorModifier(modifier);

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

IltChartMapping mapping = new IltChartMapping(minImg, maxImg);
IltSettings.SetValue("SNMP.ICMP.OutErrors.Chart", mapping);

How to modify the chart graphical representation of an SNMP 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 " SNMP.ICMP.OutErrors ", 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.

setting."ilog.tgo.model.IltState"[name="SNMP.ICMP.OutErrors"] {
  chart: @+chartSnmp;
}
Subobject#chartSnmp {
  class: 'ilog.tgo.graphic.IltChartMapping';
  minImage: '@|image("icon1.png")';
  maxImage:'@|image("icon2.png")';
  xAxisDirection: Right;
  yAxisDirection: Bottom;
  colorModifier: @+myColorModifier;
}
Subobject#myColorModifier {
  class: "MyColorModifier";
}

How to modify the counter graphical representation of an SNMP secondary state (using the API)

When an SNMP secondary state is graphically represented by a counter decoration, the configuration of this decoration has to be previously defined. All SNMP secondary states have a predefined counter representation. Refer to The SNMP 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:

IltSettings.SetValue("SNMP.ICMP.OutErrors.Type", IltDecorationType.Counter);

You can modify this decoration in the following way:

IltCounterMapping cm = new IltCounterMapping(new DecimalFormat("#Mbs"),
                                             IltrFont.CounterText,
                                             true, Color.black, 
                                             Color.white, Color.black,
                                             3, 1, IlvDirection.Right, false);
IltSettings.SetValue("SNMP.ICMP.OutErrors.Counter", cm);

How to modify the counter graphical representation of an SNMP 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 " SNMP.ICMP.OutErrors ", 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.

setting."ilog.tgo.model.IltState"[name="SNMP.ICMP.OutErrors"] {
  counter: @+counterSnmp;
}
Subobject#counterSnmp {
  class: 'ilog.tgo.graphic.IltCounterMapping';
  format: @+myNumberFormat;
  font: "Helvetica-Bold-12";
  antialiasing: false;
  foregroundColor: red;
  backgroundColor: blue;
  borderColor: red;
  xPadding: 100;
  yPadding: 100;
}
Subobject#myNumberFormat{
  class: 'MyNumberFormat';
}