Managing user-defined collections

You can create user-defined collections of network entities, to customize the appearance of your network topology.

You can create user-defined collections from the Network Views, Network Hop View, and Path Views GUI.

You can view, delete, and rename collections from the User-Defined Collections window. You must have the ncp_udc_admin or ncp_create_udc role to see this window in the Incident > Network Availability menu.

You can create a collection inside another collection. Collections cannot overlap within a view, that is, one device cannot belong to two separate collections.

To manage user-defined collections, complete the following steps:

To create a collection, select multiple network entities in the Network Views, Network Hop View, and Path Views GUI, right-click, and select the Create User-Defined Collection option. Enter a unique name.
To create a collection, you need the ncp_create_udc user role.
To manage collections, open the User-Defined Collections window from the Incident > Network Availability menu.
The User-Defined Collections window displays a table containing details of all the collections that you created, or, if you have the ncp_udc_admin role, all collections that any user created.
1. To view the collections that belong to a particular domain, select the domain from the domain drop-down menu.
2. To delete a collection, click on the collection and click the Delete button. You can also delete a collection by opening a view that contains a collection, right-clicking the collection and selecting the Delete User-Defined Collection option.
  To delete your own collection, you need the ncp_create_udc role. To delete a collection that was created by any user, you need the ncp_udc_admin role. If these roles are not created automatically, create them manually and assign them to the appropriate users.
3. To rename a collection, click on the collection and click the Rename button.
4. To view all devices in a collection, click the entry in the Devices column for that collection.
  The Device Information window opens, displaying details about the network entities that the collection contains.
5. To see all views that contain a collection, click the entry in the Views column for the collection.
  The Network Views Information window opens, displaying details of the views that contain the collection. You can click a view name to open that view.
6. To refresh the table, click the Refresh button.
  To change the automatic refresh period for the table, which is 60 seconds by default, update the topoviz.udc.table.refresh.period property in the $NMGUI_HOME/profile/etc/tnm/topoviz.properties file.
To configure the GUI to delete empty collections after a discovery finishes, set the topoviz.user.defined.collections.cleanup.enabled property to true in the $NMGUI_HOME/profile/etc/tnm/topoviz.properties file.