Customizing Structure Browser preferences

The administrator can change configuration settings for the Structure Browser. Edit the configuration files to change the appearance of the Structure Browser.

The configuration files are located in the $NMGUI_HOME/profile/etc/tnm/ directory. The structurebrowser.properties file controls settings that are related to the Structure Browser window. The status.properties file controls all status indicator settings for both the Topoviz views and the Structure Browser window. The ncp_structurebrowser_menu.xml file controls what tools are available from the Structure Browser.
Note: The configuration files are monitored for changes every 60 seconds, so changes are automatically detected by the Structure Browser.
  1. From the command line, navigate to the $NMGUI_HOME/profile/etc/tnm/directory.
  2. Back up and edit the $NMGUI_HOME/profile/etc/tnm/structurebrowser.properties file.
    Structure Browser property Description
    structurebrowser.default.viewMode Specifies the default mode for the Structure Browser when it is opened as a widget. The default mode determines how data is displayed when the Structure Browser is opened as a widget. The two options are tree or table. The default mode can be overriden by a user's widget preferences.
    Note: The Structure Browser table is only available when the Structure Browser is opened as a widget. The table cannot be launched as a stand-alone window.
    structurebrowser.showManagedStatus Specifies whether to show the managed status of a device from the tree or the interface or connectivity tables. If the value is set to false, then managedStatus is hidden.
    structurebrowser.table.connectivity.style.columnName Aligns text in a particular column in the Structure Browser Connectivity Table to the left, right, or center. For example:
    structurebrowser.table.connectivity.style.severity=text-align: left
    structurebrowser.table.connectivity.width.localColumnName Specifies the width of individual columns for the local interface in the Connectivity view of the Structure Browser in table mode in units of em or px.
    structurebrowser.table.connectivity.width.connectivity Specifies the width of the Connectivity column in units of em or px.
    structurebrowser.table.connectivity.width.columnName Specifies the width of individual columns for the remote interface in the Connectivity section of the Structure Browser in table mode in units of em or px.
    structurebrowser.table.default.view

    V4.2 Fix Pack 6: Specifies the view in which the Structure Browser portlet opens when a single device is displayed. The following values are allowed:

    • devicetable: opens the device view. This is the default value.
    • interfacestable: opens the interfaces view.
    • connectivitytable: opens the connectivity view.

    This property has no effect when the portlet displays a connection between devices, because only one view is available in this case.

    structurebrowser.table.device.style.columnName
    V4.2 Fix Pack 8: Aligns text in a particular column in the Structure Browser Device Table to the left, right, or center. For example:
    structurebrowser.table.device.style.severity=text-align: left
    structurebrowser.table.device.width.columnName

    V4.2 Fix Pack 8: Specifies the width of individual columns in the Devices view of the Structure Browser in table mode. The width is measured in units of em or px.

    structurebrowser.table.interfaces.style.columnName Aligns text in a particular column in the Structure Browser Interfaces Table to the left, right, or center. For example:
    structurebrowser.table.interface.style.severity=text-align: left
    structurebrowser.table.interfaces.width.columnName Specifies the width of individual columns in the Interfaces view of the Structure Browser in table mode. The width is measured in units of em or px.
    structurebrowser.tree.device.icon.x

    Specifies the managed status icon to display in the tree and the table, where x is the entity type, as defined in the ncim.entityTypes database table.

    For example, to change the icon displayed for a PSU, save your new icon as a .PNG file of size 18x18 pixels with a file name of psu2_18.png into the $INSTALL/tipv2/profiles/TIPProfile/installedApps/TIPCell/isc.ear/ncp_structureview.war/styles/images/devices directory, then edit the following line and change the value psu to psu2. Note that the file names of all Structure Browser icon files must end in _18.png:

    # PSU
    structurebrowser.tree.device.icon.6=psu
    structurebrowser.tree.device.node.display

    V4.2 Fix Pack 9: Set this property to ifAlias, as in the following example, in order to append the interface alias to the interface name in the Device Structure Tree.

    structurebrowser.tree.device.node.display=ifAlias
    structurebrowser.tree.device.node.ifType

    V4.2 Fix Pack 9: Set this property to the value of the interface type for which you want to append the interface alias to the interface name. For this property to take effect, you must also configure the structurebrowser.tree.device.node.display property.

    If you do not specify a value, the interface alias is appended to the interface name for every type.

    The following example shows the property configured for multiple interface types:

    structurebrowser.tree.device.node.ifType=6,53
    structurebrowser.tree.device.node.separator

    V4.2 Fix Pack 9: Specifies the separator to be used between the interface name and interface alias, if you have configured the structurebrowser.tree.device.node.display property to append the alias.

    Allowed values are any one of the following: $ @ % * & + = - _

    The following example uses the $ character as a separator:

    #structurebrowser.tree.device.node.separator=$
    Restriction: The features available depend on the version of the product installed. If the latest version is installed and the lines to set the default view mode and the column widths are not present in the configuration file, copy the lines into the $NMGUI_HOME/profile/etc/tnm/structurebrowser.properties file from the $NMGUI_HOME/profile/etc/tnm/default/structurebrowser.properties file.
  3. Save and close the file.
  4. Back up and edit the $NMGUI_HOME/profile/etc/tnm/status.properties file.
    Status property Description
    status.enabled Specifies whether the status field is visible from the interface and connectivity tables.
    status.none.enabled Specifies whether an icon is displayed when the status is Clear.
    status.tree.updateperiod Specifies how often the table and the tree are updated or refreshed. This property also controls status updates.
    status.tree.image.x Specifies the status icons for the table and the tree.
  5. Save and close the file.