5.12.5.1 Tree Node UI Settings

<DEVICE-DATA>

</DEVICE-DATA>

This is the main tag for this Tree.xml file. All other tags must be specified inside this main tag.

<DEVICE-GROUP>

</DEVICE-GROUP>

This is an optional group tag whereby devices having similar characteristics can be grouped inside it. You can decide upon the type of devices, which are to be grouped inside this tag. The visual representation of the tree nodes displayed in the client tree based on this tag entries is same as that specified for the <DEVICE></DEVICE> tag.

<DEVICE>

This is a mandatory tag for specifying devices in the Tree.xml file. There are certain specific attributes which can be used for defining the properties of the specific tree node and its corresponding panel.

<LEVEL-n>

This tag is an optional one and is used to specify the various levels of the sub-nodes, which are to be displayed under a parent node in the client tree. For example, if you specify "Sample1" inside <LEVEL-1></LEVEL-1> tag and "Sample2" inside <LEVEL-2></LEVEL-2> tag for the "Fault" parent node as shown below :

<DEVICE ID="Fault">

<LEVEL-1 ID="Sample1">

<LEVEL-2 ID="Sample2"/>

</LEVEL-1>

</DEVICE>

The output in the client tree is as shown below :

'Fault'

Sample1

Sample2

This tag can take all the attributes as specified for the <DEVICE></DEVICE> tag.

ID

Mandatory

This attribute specifies the identification name for the tree node. If it is not specified, a message saying that "ID attribute not present" appears during client start-up and client does not start up.

 PREVIOUS-NODE

Optional

This attribute gives the name of the node that appears before the current node, in the client tree. For example, if 'Test' is a tree node that exists before a node namely 'SAMPLE', then this attribute displays 'TEST' as the value for this attribute. For the first node of the tree, the previous node is the "Start" node.

NODETYPE

Optional

This attribute specifies whether the node is of type DEVICE or DEVICE-GROUP.

NODEID

Optional

This attribute is same as that of the ID, where the name of the tree node is specified. In practice, this attribute is not used.

PARENT

Optional

This attribute gives the name of the parent node for the other child nodes. If the value for this attribute is "null" then the corresponding tree node is taken as the parent node.

TREE-NAME

Optional

This attribute specifies the name that is to be displayed on the tree. If the TREE-NAME attribute is not mentioned, then it displays the tree node ID.

ICON-FILE

Optional

This attribute specifies the file name of the Icon for the corresponding tree node of the client tree. If you are not specifying this attribute, then the tree node is specified with the default icon i.e. a red dot.

TREE-POPUP-MENU

Optional

This attribute specifies the menu name of the pop-up menu of the tree. This specifies the pop- up menu when you right-click the tree node.

IMAGE-NAME

Optional

This attribute is the name of the image that is to be displayed for the tree node. The image file that is specified must be present in the images directory.

PANEL-NAME

Mandatory

This attribute specifies the class name of the panel. The class must be located in <Web NMS Home>/classes directory. If this attribute is not found then the client recognizes the tree node as a dummy one.

MENU-FILE-NAME

Optional

This attribute specifies the name of the menu configuration file of the tree node. If the attribute is not specified, the corresponding panel- specific menus do not get displayed for the specific tree node.

TABLE-POPUP-MENU

Optional

This attribute specifies the menu name of the table pop-up menu for a panel. The menu is displayed on right-clicking the displayed table for a panel.

URL

Optional

This attribute is used for specifying the URL of the main panel image. For example, the RL that brings up the AdminTool page is URL=jsp/ShowImage.jsp?imageName=../images/admintoolimages.png.

MODULE-NAME

Mandatory

This attribute gives you the module name of the panel. By default, the module name is set as Default.

MODULENAME

Optional

This attribute is same s that of the MODULE-NAME attribute, where the name of the module is pecified. By default, the module name is set as Default.

DEFAULT-CLOSE-OPERATION

Optional

This attribute specifies whether the panel is to be hidden or to be disposed or removed from the client alone or from both the client and DB. The five values are DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE, DISPOSE_ON_CLOSE, DISPOSE_AND_REMOVE_TREENODE_ON_CLOSE, and DISPOSE_AND_REMOVE_TREENODE_FROM_DB_ON_CLOSE.

TABLE-COLUMNS

Optional (only for default panels)

This attribute comprises the various properties of a panel table such as labels, fieldname, and columnWidth. The definition of the values are as follows :

• label - It is the text that appears as the header for the table column representing the field.

• fieldname - It is the field of the object which you like to display.

• columnWidth - It is the width of a table column. The measure is in pixels.

For example,

TABLE-COLUMNS=""Class = severity = 55, Source = source = 135; Date = date = 155; Message = text = 275"

Here, the output result in the table shows four columns with headers Class, Source, Date, and Message. The underlying fields are severity, source, date, and text respectively while the corresponding fieldwidth(s) are 55, 135, 155, and 275 pixels respectively.

This attribute is optional only for the default panels such as Network Events, Alarms, Network Database, and Configured Collection. If this attribute is removed, then the default columns get displayed for these panels. This attribute is mandatory for all other created panels and custom views.

ICON-RENDERER-COLUMN

Optional (applicable only for Network Database Panels)

By default, the "Status" icon will be present in the "name" column of the Network Database list view. If you want the "Status" icon to be placed in some other column then you can specify the name of the column against this parameter.

For instance, if you want the "Status" icon to be displayed in the "type" column, then the entry would be like

ICON-RENDERER-COLUMN="type"

ORDERBYCOLUMN

Optional (only for default panels)

This attribute is optional and is used for configuring the sorting of a table column statically. If a particular table column is to be configured for sorting in a particular order (e.g., ascending) then the fieldname (and not the header/display name) of the table column can be specified as a value for this attribute. Every time the client is started, you can find the configured column to be sorted in the order specified.

When specifying this parameter in Tree.xml, the ISASCENDING="true" parameter must also be specified.

ORDERBYNAME

Optional (only for default panels)

This attribute specifies the name of the table column for which default sort is set. The default sort gets applied to the specified column during client startup.

This attribute is optional only for the default panels such as Network Events, Alarms, Network Database, and Configured Collection. If this attribute is removed, then the default sort is set for these panels.

INIT-ON-STARTUP

Optional

This attribute specifies whether the instantiation of each panel in the tree can be done while starting the application client or when the panel is opened for the first time after starting the client. If true, then it is instantiated while starting the application client itself. This attribute is applicable only for user-defined panels.

VIEW-CRITERIA

Optional (only for default panels)

This attribute specifies the view criteria to be checked during discovery of a particular node. For example, if the criteria are "isNode=true" and " isNetwork=true" for the Network Events panel, then all the nodes obeying this criteria are displayed in the table.

VIEW-LENGTH

Optional (only for default panels)

This attribute specifies the number of objects to be displayed in the table of a particular panel. The default values are defined in increments.conf file in <Web NMS Home>/users/"<username>" directory. By default, the view length for Network Events is 25, Alarms - 50, Network Database - 25, and Performance Views - 10.

CURR-STAT

Optional (only for default panel)

This attribute can be used for viewing the Current Statistics graph. The values taken by this attribute is true or false. If it is set to true, then the Current Statistics graph can be viewed even when the polled data is inactive. If no value or a junk value is specified for this attribute then the graph is displayed based on the status of the polled data.

REORDERING-ALLOWED

Optional

This attribute can be used for configuring the reordering of table columns of the NMS panels (such as Network Events, Alarms, Configured Collection, Network Database, Configuration). Reordering is a JTable property using which you can effectively reorder the table columns by simply dragging them. The value taken in by this parameter is true or false. Reordering of the table columns is possible if the value specified for the parameter is true but if the value specified is "false" then reordering of table columns manually is inhibited. The default value specified for this parameter is true. The value holds applicable only to the specific tree node for which it is specified. You can also make an entry of the parameter in NmsPanels.conf file.

RESIZING-ALLOWED

Optional

This attribute can be used for configuring the resizing of table columns of the NMS panels (such as Network Events, Alarms, Configured Collection, Network Database, Configuration). Resizing is a JTable property using which you can change the size of each table column manually. The value taken in by this parameter is true or false. Resizing of the table columns is possible if the value specified for the parameter is true but if the value specified is false then resizing of the table columns manually is inhibited. The value of this parameter in this Tree.xml file holds applicable only to the specific tree node for which it is specified. You can also make an entry of the parameter in NmsPanels.conf file

SERVER-SORT-DISABLED-COLUMNS

Optional

This attribute can be used for configuring the server-side sorting of table columns. Using this parameter, you can disable the desired table column from being server-side sorted. The server-side sorting of table columns implies sorting of data stored in the database in a defined (ascending or descending) manner. The value taken in by this parameter is the fieldname of the column (specified in the Tree.xml file). For example, SERVER-SORT-DISABLED-COLUMNS="ipaddress". You must ensure that you do not specify the header name (i.e., one specified through the custom view forms) as the value for this parameter. You can also make an entry of the parameter in the NmsPanels.conf file. But, if you make an entry of this parameter in both i.e.,Tree.xml and NmsPanels.conf, then the value specified in Tree.xml file takes precedence.

CLIENT-SORT-DISABLED-COLUMNS

Optional

This attribute can be used for configuring the client-side sorting of table columns. Using this parameter, you can disable client-side sorting of the table columns. The client-side sorting implies sorting the desired table columns only in the client. This means, the ascending or descending of the tabular data can be viewed only in the client GUI ( making it asynchronous with the database sorting order). The value taken in by this parameter is the fieldname of the column (specified in the Tree.xml file). For example, SERVER-SORT-DISABLED-COLUMNS="type". You must ensure that you do not specify the header name (i.e. one specified through the custom view forms) as the value for this parameter. You can also make an entry of the parameter in the NmsPanels.conf file. But, if you make an entry of this parameter in i.e.Tree.xml and NmsPanels.conf files, then the value specified in Tree.xml file takes precedence.

Client

Mandatory

This attribute specifies whether the tree node is to be displayed, in the HTML UI or in the Java UI or in both the clients. Based on the UI in which the tree node is to be displayed the corresponding name (i.e., Java UI or HTML UI) is to be specified. For displaying it in both the UIs, the value All can be specified.

PROPERTIES-FORM

Optional

This attribute specifies the class name of the property form. The class is specified from the <Web NMS Home>/classes directory.

MANAGED-OBJECT-FORM

Optional

This attribute specifies the class name of the managed object form. The class is specified from the <Web NMS Home>/classes directory.

USERNAME

Optional

This attribute specifies the user name. By default, the user name is root but if an user with user name as John is created under the <Web NMS Home>/users directory then the value of this attribute is John.