Configuring the display of extra information associated with a device

Information such as alert status and maintenance state of a device is displayed in a colored border around the device. You can configure the colors, icons, and positioning of the elements used to display this information.

You control the display of extra information associated with a device using the settings in the following files:
  • $NMGUI_HOME/profile/etc/tnm/topoviz.properties
  • $NMGUI_HOME/profile/etc/tnm/status.properties

The settings that you can configure using these files include the following:

Managed status of device
Icons that displays unmanaged and partially unmanaged status, position, and size of the icons.
Manually added device indication
Icon to indicate that this is a manually added device, position, and size of the icon.
Alert status of device
Whether to display an alert status icon, and if displayed, position of the alert status icon.
Frame around the device
Roundness of the corners of the frame around the device, height and width of the frame.
Device label text
Typeface, font size and font style of the device label text.

Example

The following figure shows a representation of a device display, showing a manually added device in unmanaged mode.

Figure 1.  Representation of a device display, showing a manually added device in unmanaged mode
Representation of a device display, showing a manually added device in managed mode
Configure the settings for the unmanaged status and manually added device icons as follows:
 1  Unmanaged status icon, position, and size
The settings are specified in the topoviz.properties file. To locate these settings, search for the relevant section that begins with the comment # Overlay definitions..
# Overlay definitions.
topoviz.overlay.image.UNMANAGED=unmanaged.svg
topoviz.overlay.position.UNMANAGED=C
topoviz.overlay.size.UNMANAGED=25
topoviz.overlay.image.PARTIALMANAGED=partial_managed.svg
topoviz.overlay.position.PARTIALMANAGED=C
topoviz.overlay.size.PARTIALMANAGED=25
Table 1. Description of settings for the unmanaged status icons
Line Description
2 Specifies the icon to use to indicate unmanaged status.
3 Specifies the position of the unmanaged status icon. The letter C means centered.
4 Specifies the size of the unmanaged status icon. The number is a relative value.
5 Specifies the icon to use to indicate partially unmanaged status.
6 Specifies the position of the partially unmanaged status icon. The letter C indicated centered.
7 Specifies the size of the partially unmanaged status icon. The number is a relative value.
V4.2 FixPack 15:The setting status.view.managedStatus.enabled is specified in the status.properties file. If this property is set to true(the default), icons are displayed in topology views to indicate the unmanaged or partially managed status of devices or device components. If this property is set to false, managed status is not displayed.
 2  Manually added device icon, position, and size
The settings are specified in the topoviz.properties file. To locate these settings, search for the relevant section that begins with the comment # Overlay definitions..
# Overlay definitions - Manual device
topoviz.overlay.image.MANUAL=manualoverlay.svg
topoviz.overlay.position.MANUAL=E
topoviz.overlay.size.MANUAL=10
topoviz.overlay.xoffset.MANUAL=-2
Table 2. Description of settings for the manually added device status icon
Line Description
2 Specifies the icon to use to indicate a manually added device.
3 Specifies the position of the manually added device icon. The letter E means east of center.
4 Specifies the size of the manually added device icon. The number is a relative value.
5 Specifies x-axis offset of the icon. The East of center positioning in line 2 would place the icon so that it is touching the frame surrounding the device. The -2 offset value moves the icon slightly to the left, so that it is positioned just inside the frame.

Example

The following figure shows a representation of a device display, showing an associated critical alert.

Figure 2.  Representation of a device display, showing an associated critical alert
Representation of a device display, showing an associated critical alert
Configure the settings for the alert status icon, the device frame, and device label text as follows:
 1  Alert status icon
The settings that control whether and where to display alert status icons in topology maps are as follows. Some settings are in the topoviz.properties file and others are in the status.properties file.
Whether to display alert status icons in the topology maps
The setting in the status.properties file that instructs the system to display alert status is status.enabled=true.
Position
The setting in the topoviz.properties file that specifies the position of the alert status icon.is topoviz.status.position=NE. This instructs the system to place the alert status icon in the north east (top right) corner of the frame containing the device.
 2  Device frame
The settings are specified in the topoviz.properties file. To locate these settings, search for the sections that begins with the comment # Node dimensions and # Corner arc.
# Node dimensions
topoviz.node.height=60
topoviz.node.width=100

# Node resizability
# Options:	LOCKED	(Fixed height and width)
#			TIGHT_HEIGHT (Fixed height, variable width)
topoviz.node.resizeability=TIGHT_HEIGHT

# Corner arc
topoviz.node.arc=10
Table 3. Description of settings for the device frame
Line Description
2 Specifies the height of the frame.
3 Specifies the width of the frame.
Note: There is no wrapping of text for the device label, so if you want to show all of the device label text you must either increase this width value or decrease the text font size using the topoviz.node.fontsize setting.
8

Specifies how the topoviz.node.height and topoviz.node.width settings are handled. The default is TIGHT_HEIGHT.

Using LOCKED means the values set in the topoviz.node.height and topoviz.node.width parameters are used for the device frame. Using TIGHT_HEIGHT maintains the topoviz.node.height setting, but does not maintain the topoviz.node.width setting, which means the device frame is automatically widened as necessary to accommodate the device label while keeping the width to the minimum.

11 Specifies the roundness of the corners of the frame. The higher the value, the more rounded the corners.
 3  Device label
The settings are specified in the topoviz.properties file. To locate these settings, search for the relevant section that begins with the comment # Font settings.
# Font settings
topoviz.node.font=Arial,Helvetica
topoviz.node.fontsize=10
topoviz.node.fontstyle=0
  • Check with your system administrator that the font Arial,Helvetica is installed on the server.
  • For fontstyle values, you can use the following values.
    0
    Plain font style.
    1
    Bold font style.
    2
    Italic font style.
Table 4. Description of settings for the device label text
Line Description
2 Specifies the typeface to use for the device label text.
3 Specifies the font size to use for the device label text.
4 Specifies the font style to use for the device label text.