The List Designer

The List Designer allows administrators to design lists to be displayed in the List Viewer. The List Viewer displays information in a table format. The information can displayed as text, numbers, gauges, alarms, or line graphs.
uim901
Designing_Lists
The List Designer allows administrators to design lists to be displayed in the List Viewer. The List Viewer displays information in a table format. The information can displayed as text, numbers, gauges, alarms, or line graphs.
You can create two kinds of lists: detail or group. In detail lists, each row displays information for a single host or target. In group lists, each row displays aggregated information for a group of systems.
For group lists, you can specify a Drilldown Template (another list). Typically, the drilldown list contains data for the individual hosts or targets that make up the group. When viewing the group list in the List Viewer, you can click the name of a group to display the Drilldown Template.
For detail lists, you can click the name of a system to see a Drilldown Report with data for the system that you clicked. The Drilldown Report is a Performance Report chart, created in Performance Reports Designer and specified in the Drilldown Report setting in the List Designer.
When you create a new list, by default it is a detail list. To create a group list, add groups to the list. In a detail list, you can also select devices by groups created in USM. This function allows you to create a list tailored to display information for the devices in a specific group or to create a generic list and applying group level filters at runtime.
If you do not have the List Designer permission set in the Access Control List (ACL), you will see a "Permission Denied" message when you try to run the List Designer.
 
Contents
 
 
 
The List Designer Window
Field or Button
Description
Add Column button
Displays the Add Column panes, where you can define a column for a list.
Remove Column button
Removes the selected column from the table.
View as PDF icon
 View as PDF Icon 
Opens the PDF Preferences Dialog, where you can select settings for a PDF version of the list.
Refresh icon
 Refresh Icon 
Updates the data displayed in the table.
New View icon
 New View Icon 
Clears all fields or resets them to the defaults. Edit the settings to create a new list, then click the 
Save view
 (Save View Icon) or 
Save view as
 (Save View As Icon) icon.
Open View icon
 Open View Icon 
Opens the Open View dialog, where you can select an existing list.
Save View As icon
 Save View As Icon 
Saves the list.
Save View icon
 Save View Icon 
Opens the Save View dialog, where you can name the list and can save it as either a public or private list. Public lists can be viewed by all users. Private lists can be viewed only by you.
You can also use the Save View dialog to delete lists.
Help icon
 Help Icon 
Displays the online help for the List Designer.
Table
Displays the columns that are defined for the list. Drag the column headers to change the order of the columns. Enter text in a field next to a column header to filter for that text.
Column Header field
Enter a name for the column you are defining.
Rows Source pull down menu
Select whether the data is displayed for the hosts (the systems doing the monitoring) or the targets (the endpoints of a test).
For example, for disk usage, select Hosts to see information about the systems where CA UIM is installed. For a URL test, select Targets to see information about the destination of the URL test.
Hide Repeating Entries check box
Select this box so that duplicate names of hosts or targets are not displayed.
For example, if there are multiple rows for the same host (source), the host is listed only once and that column is blank for subsequent rows for the same host. This makes it easier to see groups of entries.
Group pull down menu
Select a group from USM as the basis for a list of hosts or targets.
Apply button
Updates the table with your changes.
Drilldown Report/Template
Specifies a drilldown destination for more information on the list when opened in List Viewer. The default drilldown destination is the USM Details view for a source in the list.
The name of this field changes from Drilldown Report to Drilldown Template for lists with more than one group.
For a list that has only a single group, you can click the name of a system in the group and drill down to a Performance Report for the system. The report is displayed with metrics for the system you clicked.
For a list with multiple groups, you can click the name of a group in the List Viewer to display the specified Drilldown Template. The Drilldown Template can be any list, but typically it contains data for the individual systems that make up the group.
For example, you might have groups named Data Center 1 and Data Center 2 made up of the systems at each data center. Your top-level list displays aggregated data for each data center. However, you want to drill down and see data for each system. To do this, create a list named Data Center System Metrics with measurements for individual systems. You set the Data Center System Metrics template as the Drilldown Template. Now, when you drill down from Data Center 1 or Data Center 2 aggregated data, you see the Data Center System Metrics report with data for the systems in that group.
Enter the name of a list, or click the 
Find view
 icon (Find View Icon) to the right of this field to select the list from a menu.
The list specified as the Drilldown Template is used by default for all groups. To use a different drilldown template for a group, click the Override Template check box.
Edit button
(Displayed when a Drilldown Template is specified)
Allows you to edit the list specified as a Drilldown Template. You must save the current list to edit the Drilldown Template.
This button is not available for lists with only a single group. In this case, the Drilldown Report is a Performance Report, which cannot be edited in the List Designer.
Row Limit
Limits the number of rows displayed. This limit makes loading the report in the List Viewer faster, especially if you have many systems in the list.
For example, if you set the limit to 10, the table displays the top 10 rows for the sorting you have selected. If you sort the table by a CPU Usage column, the table displays the systems with the 10 largest CPU Usage values.
If the Row Limit is set to 0, the report displays the number of reports that fit onto one screen.
To see data for more systems, increase the Row Limit.
 
Note:
 Setting the Row Limit to a large number might make loading the list slow or cause the List Viewer to time out, depending on your environment. By default the List Viewer times out after 10 minutes.
Add group icon
 Add Group Icon 
Adds a New Group accordion for grouped hosts to create groups to display in the list. A group displays aggregated data for a set of hosts or targets, rather than data for each individual host or target.
Remove filter group icon
 Remove Filter Group Icon 
Deletes the current group.
Override Template check box
Select to specify a drilldown template for this group other than the one specified in the Drilldown Template field.
Enter the name of a list, or click the 
Find view 
icon to the right of this field to select the list from a menu.
Static check box
Select to display data for the systems defined in the Override Template report instead of for the members of the group.
For example, if you have a group made up of VMware hosts you might want to see data, not for the group members (hosts), but for the VMware instances on those hosts. To do so, use a report with the VMware instances defined as the data source as the Override Template and select the static check box.
Edit button
Allows you to edit the list specified as the Override Template. You must save the current list to edit the Override Template.
This button is not available for lists with only a single group. In this case, the Drilldown Report is a Performance Report, which cannot be edited in the List Designer.
Filter fields
  • Use these fields to display only specified hosts or targets in the list. For example, you can filter for only hosts monitoring a certain QoS measurement, or for all hosts or targets on a specified hub.
  • 'not' button - Click to display all items except the specified items.
  • Source pull down menu - Select the item that you want to filter for.
  • Operator pull down menu - Select the operator (starts with, ends with, contains, or is) you want to use for the filter
  • Text box - Enter the text that you want to filter on.
Add Filter icon
 Add Filter Icon 
Click to add another row of filter options.
Remove Filter icon
 Remove Filter Icon  
Click to remove the row of filter options. This icon is visible if you have more than one row of filter options.
Create a List
You can create a list to be displayed in the List Viewer application.
 
Follow these steps:
 
  1. Click the 
    New View
     icon.
  2. From the 
    Row Source 
    pull down menu, select 
    Hosts 
    or 
    Targets
    , then click 
    Apply
    .
    Choose 
    Hosts 
    to display data for the systems doing the monitoring or 
    Targets 
    to display data for
     
    the endpoints of a test. For example, for disk usage, select 
    Hosts 
    to see information about the systems where CA UIM is installed. For a URL test, select 
    Targets 
    to see information about the destination of the URL test.
     You can filter  columns by entering text in the input next to the column header (Host, QoS, or Target). The filter operates as a regular expression , so include a backslash (\) as an escape character to introduce a literal search string  for these special characters: \ . + * ? ^ $ [ ] ( ) | { } / ‘ #. For example: the asterisk character (*) is a quantifier in a regular expression for matching the previous token zero or more times. If the asterisk follows the backslash escape character (\*), the filter shows any row containing an asterisk in the text.
    Enter information in the remaining fields in the table definition area:
    1.  
      Column Header
      Allows you to assign a name to the source column other than Host or Target.
    2.  
      Hide Repeating Entries
      Displays host or target names only once in the source column in the List Viewer, making groups of entries easier to see.
    3.  
      Group
      Allows filtering to show QoS data for members of a group. The group list can also be viewed in USM.
       A filter must be applied to the group to display a list of hosts or targets. The filter can be set prior to selecting a group or after the group is selected.
      Only one group can be selected. Container groups include all members of descendant groups.
    4.  
      Drilldown Report/Drilldown Template
      Specifies the item to display when you click the name of a group or host in the List Viewer to drill down for more information:
      • A list to be displayed when you click on the name of a group. The 
        Drilldown Report 
        can be any list, but typically it contains data for the individual systems that make up the group. This field name changes to 
        Drilldown Template
         if the list has more than one group. The specified list is used as a template, displaying data for the members of whichever group is drilled down from.
      • A Performance Reports Designer chart to be displayed when you click on the name of a host or source. If no Performance Reports Designer chart is designated, the standalone USM is launched instead.
         If no drilldown destination is selected, the drilldown behavior is to open the USM Details view for the host.
      Click the 
      Find view
       icon next to the 
      Drilldown Report
       field to browse to a list or chart to designate as the Drilldown Report or Drilldown Template.
    5.  
      Row Limit
      This parameter sets the number of rows that are displayed in the list. For example, if you set the row limit to 10, the list displays the top 10 rows for the sorting you have selected. If you leave it set to 0, the List Viewer displays the number of rows that fit on a single page.
  3. (Optional) Add a group to the list by entering the information in the filter fields of the 
    New Group
     pane.
  4. (Optional) Add more groups by clicking the 
    Add group
     icon and then entering information in the fields in the group pane:
    1.  
      Override Template
      Allows you to drill down to a list other than the one specified for the Drilldown Template.
    2.  
      Static
      Allows you to display data for the systems defined in the Override Template report instead of for the members of the group. This is most often used when working with virtual hosts.
    3.  
      Group name
      Highlight the name of a group and enter a new name to rename it.
  5. Add a column to the list by clicking 
    Add Column
    .
    1. Select a QoS.
    2. If you are in Hosts mode (you selected 
      Hosts 
      from the 
      Row Source 
      pull down menu), select a target. The list of targets is populated once you select a QoS. If you are in Target mode, the list of targets is not displayed because data is displayed for all targets listed in the table. To restrict the targets that are listed in the table, add a group and use the filters in the 
      New Group 
      pane.
    3. If you are in Targets mode (you selected 
      Targets 
      from the 
      Row Source
       pull down menu), click the 
      Select All QoS 
      check box if you want to display all QoS reported for the target in a single column. If you select this parameter, it is recommended that you also add a column with the 
      Info 
      data format (select 
      Info 
      from the 
      Display as 
      pull-down menu) and select 
      QoS 
      from the 
      Info Type 
      pull down menu. This allows you to see the type of each QoS.
  6. In the data format (right) pane, select the data format for the column from the 
    Display as 
    pull down menu.
  7. Enter information for the column type you selected.
  8. Click 
    Apply
    .
  9. Continue adding as many columns as you want. To change the order of the columns drag the column headers. To return to the group view, click the header of the source (host or target) column.
  10. Click the 
    Save
     icon.
    1. Select the directory location where you want to save the list and enter a name for the list. To save the list in a subdirectory, enter a directory structure such as servers/disk_usage/latest_list. This entry creates the subdirectories servers and disk_usage and the list named latest_list.
    2. Select 
      public, account
      , or 
      private 
      from the drop-down list to the right of the name field.
    3. Click 
      Save
      .
Add Column Panes
The Add Column panes are displayed when you click the 
Add Column
 button. The fields vary depending on whether you selected 
Hosts 
or 
Targets 
in the 
Row Source
 pull down menu.
 
Hosts mode
:
Field or Button
Description
 
QoS
 panel
Select the QoS measurement that you want to display in the column.
 
Target 
panel
Select a target for the QoS measurement. This list is populated once you select a QoS measurement.
If for the QoS measurement you selected the host name is part of the target, you see $HOST at the top of the host list. This variable allows you to create a single column for the data. Otherwise, because the host name is part of the target, you would have to create a new column for each system. Usually, you will want to use the $HOST option if it is present.
Data Format pane
Use the fields in this pane to define the data to be displayed in the column.
The fields and buttons in this pane change depending on the data format selected from the 
Display as
 pull down menu. For information about each field or button see the description for each data format:
  • Numeric
  • Spark (mini-graph)
  • Gauge
  • Time Slice
  • Alarm
  • Status
  • Info
 
Targets Mode
:
Field or Button
Description
 
Select All QoS
 check box
Check to display all QoS reported for the target in a single column.
If you select this box, it is recommended that you also add a column with the 
Info 
data format (select 
Info 
from the 
Display as 
pull down menu) and select 
QoS 
from the 
Info Type 
pull down menu. This setting allows you to see information about each QoS. You can also use the filter fields in the 
New Group
 pane to restrict which QoS or targets are displayed.
 
 
QoS
 panel
Select the QoS measurement that you want to display in the column.
Data Format pane
Use the fields in this pane to define the data to be displayed in the column.
The fields and buttons in this pane change depending on the data format selected from the 
Display as 
pull down menu. For information about each field or button see the description for each data format:
  • Numeric
  • Spark (mini-graph)
  • Gauge
  • Time Slice
  • Alarm
  • Status
  • Info
Alarm Data Format Pane
Field or Button
Description
Display as pull down menu
Select the data format for the column.
Apply button
Updates the table display with the changes you made.
Status/Summary pull down menu
Whether to display alarm Status or Summary.
  •  
    Status
     - Displays the highest severity of alarms. For example, if a system has three major alarms and one critical, critical is displayed as the status.
  •  
    Summary 
    - Displays a colored bar indicating the distribution of alarms. For example, if a system has three major alarms and one critical, the bar is 75 percent orange and 25 percent red.
Column Header field
Enter a name for the column.
Source Override field
Enter the name of a source (host or target) to see only alarms for that source.
Subsystem field
Enter the name of a subsystem to see only alarms for that subsystem.
Probe field
Enter the name of a probe to see only alarms for that probe.
User Tag field
Enter a User Tag to see only alarms with that User Tag.
 The Alarms pane displays only QoS-based alarms. Other, non-QoS alarms (such as an alarm indicating an expired license) are not displayed in List Designer but are included in the Alarms view in USM.
 
Gauge Data Format Pane
Field or Button
Description
Display as pull down menu
Select the data format for the column.
Apply button
Updates the table display with the changes you made.
Column Header field
Enter a name for the column.
Aggregation pull down menu
Choose the method that you want to use to aggregate the data.
Time Period combo box and pull down menu
Select the number and units for the interval you want to see data for.
Show Value, Show Units
Whether to display numeric values on the gauge. If Show Value is selected, you can select whether to display the units.
Max
Enter the maximum value to display.
Find Max Value icon
 Find.gif 
Finds the maximum value to date for the selected QoS measurement. Click the icon, then click Apply.
Thresholds fields
Enter threshold values for the color display in the gauge:
  • All values up to Warn are green.
  • All values between Warn and Critical are yellow.
  • All values between Critical and Max are red.
Numeric Data Format Pane
Field or Button
Description
Display as pull down menu
Select the data format for the column.
Apply button
Updates the table display with the changes you made.
Column Header field
Enter a name for the column.
Aggregation pull down menu
Choose the method that you want to use to aggregate the data.
Time Period combo box and pull down menu
Select the number and units for the interval you want to see data for.
Show Units check box
Click to display the unit of the measurement, such as percent or second, in the column.
Info Data Format Pane
The Info data format displays information about the system that is associated with the source, origin, or QoS.
  •  
    Source column 
     
This information can be useful if you are viewing QoS measurements by target. For example, if the target you are monitoring is disk space on the C drive, the Source column tells you which system the C drive is on.
  •  
    Origin column
     
Displays the origin for the source (host or target) for the row. Origins are a way of grouping data. For example, origins can represent data centers or MSP customers.
  •  
    QoS column
     
The category of the data. This information can be a useful column to display in target-based lists. Target names can be ambiguous and the QoS helps clarify this.
Field or Button
Description
Display as pull down menu
Select the data format for the column.
Apply button
Updates the table display with the changes you made.
Column Header field
Enter a name for the column.
Info Type
Type of data to display: Source, Origin, or QoS.
Hide Repeating Entries
Hides the name of repeating hosts or targets.
For example, if there are multiple rows for the same host (source), the host is listed only once and that column is blank for subsequent rows for the same host. This makes it easier to see groups of entries.
You can associate an Info column with drilldown behavior different from the Target or Host column drilldown behavior. The Info column drilldown menu is active when the Info Type is Source.
Options under this menu are:
  • Default - The drilldown behavior specified in the Host or Target column of the list. 
  • None - No drilldown behavior.
  • USM - The USM Details view for the selected source.
  • Report - A defined and saved report.
Contents in the Info column appear as links for all options except for the None option.
 
Follow these steps:
 
  1. Click in the header for the Info column or double-click in the Info column to select it.
  2. At the left, select Source as the Info Type.
  3. In the drilldown menu, select Report.
  4. Click on the 
    Find view
     icon to the right of the selection box.
    A window appears that shows preloaded and saved reports, such as any Performance Reports that you have created.
  5. Select a report.
  6. Click the 
    Apply
     button to save the setting or the 
    Save
     icon to save the list.
In List Viewer, open the list and click on any item in the Info column to bring up the drilldown report.
Spark Data Format Pane
Field or Button
Description
Display as pull down menu
Select the data format for the column.
Apply button
Updates the table display with the changes you made.
Column Header field
Enter a name for the column.
Graph Style color box and pull down menu
Click the color box to open a palette where you can select a color for the graph items. Choose the type of graph, Line or Column.
Time Period combo box and pull down menu
Select the number and units for the interval you want to see data for.
Automatic Scale
Select to have the scale of the spark chart set automatically according to the minimum and maximum values for this column.
Unselect this option to set the minimum and maximum values for the spark charts in this column. This option can be useful for seeing more differentiation in the specified range of values.
For example, if the data for one system in the column has an outlier value it might tend to flatten the spark chart for the other columns. Excluding the outlier value from the minimum and maximum range zooms in on the spark charts and displays more differentiation within that range of values.
Graph Color
Select to open a color chart where you can set the color for the spark charts in this column.
Use Thresholds
Select to display colors in the spark charts that indicate thresholds.
In the From and To fields, enter a range of values. Or, leave the From field blank to include all values up to the value in the To field. In the Color pull down menu, select a color for the range of values.
To add more rows, click the 
Add row
 icon to the right of the Color menu. To delete a row, click the Remove row icon (Remove Row Icon ). Click the Move up or Move down arrows to change the order of the rows.
Time Slice Data Format Pane
The time slice data format is a bar graph where each bar represents aggregated data for an interval, or slice of time. You can define how long each time slice is. For example, if you want to see hourly data for a 24-hour period, set the Time Period to 24 Hours and the Slice Period to 1 Hour. You will see a bar graph with 24 bars, or time slices, where each slice represents data for 1 hour. You can set thresholds so that the color of each slice indicates the aggregated value of the data. You can also set a threshold so that if a specified number of null values is included in the data, the color of the slice indicates that.
Field or Button
Description
Display as pull down menu
Select the data format for the column.
Apply button
Updates the table display with the changes you made.
Column Header field
Enter a name for the column.
Time Period spinner box and pull down menu
Select the number and units for the interval you want to see data for.
Slice Period spinner box and pull down menu
Select the number and units for the length of each time slice (interval).
Slice Aggregation pull down menu
Choose the method that you want to use to aggregate the data for each time slice.
Detect Null Values check box
Select if you want time slices with null values to be a different color.
Some types of monitors return null values if no data is obtained. For example, when application response time is monitored, a null value is returned if the probe cannot contact the target web site. To see a visual indication that null values were returned, use this check box together with the Null Color selector and the Null Count Threshold.
 In List Viewer, you can double-click on a time slice to see a Performance Report chart of the data for that slice. Null values are represented in line graphs by a dotted line.
Null Color selector
(Displayed only if Detect Null Values check box is checked)
Select the color for slices with null values. If the Null Count Threshold is reached, this color is displayed instead of the color that is defined in the Thresholds fields.
Null Count Threshold
(Displayed only if Detect Null Values check box is checked)
Enter the number of null values that you want to trigger the change in color for a slice.
For example, if you set the Null Color selector to blue and only want to see a slice if it contains three or more null values, set the Null Count Threshold to 3. If a slice contains two null values, the slice will be the color set in the Thresholds fields. If it contains three or more null values, will be blue.
 This threshold is a count of the number of null values returned. This number is different than the Thresholds fields that reflect the aggregated value of the data.
Thresholds fields
Use these fields to assign a color for a specified range of values. These thresholds determine the color of each slice.
In the From and To fields, enter a range of values for the color. Or, leave the From field blank to include all values up to the value in the To field. In the Color pull down menu, select a color icon for the slice.
To add or delete rows, click the 
add row
 or 
remove row
 icons to the right of the Color pull down menu. You can also reorder the rows by clicking the 
Move up
 and 
Move down
 icons.
User Tags in List Designer
You can filter on two user-defined criteria, named User Tags, in portlets that have filters. You can also automatically create groups according to User Tag.
 
User Tag 1
 and 
User Tag 2
 are text fields that are defined on the robot. You can enter any text in these fields. (Use Infrastructure Manager to open the configuration window for the robot.) Once you have done so, you can filter for these values in the Unified Service Manager, Performance Reports Designer, and List Designer portlets.
For example, you could use 
User Tag 1 
for geographic location and 
User Tag 2
 for type of server. For some systems, you enter 
Europe 
for 
User Tag 1 
in the robot configuration, and for some systems you enter 
Asia
. For 
User Tag 2
, you enter either 
production server
 or 
web server
.
You can then create reports for your regional systems by filtering on 
User Tag 1 
in the Performance Reports Designer (in the 
Filters 
tab) or List Designer (in the filter fields of the 
New Group
 pane). To do so, you would set the filter to 
User Tag 1 is Europe
 or 
User Tag 1 is Asia
.
 Performance Reports Designer Window 
In the Unified Service Manager portlet, you can create separate groups for your production and web servers and can apply different monitoring templates to the groups. To create the groups, in the 
Filters 
section of the Edit Group dialog you would set the filter to 
User Tag 2 is production server 
for one group, and 
User Tag 2 is web server
 for the other group.
 Filters Section - Create Groups 
 
User Tag 1 
and 
User Tag 2
 can be used to filter for any system that has a robot running on it. You cannot use 
User Tag 1 
and 
User Tag 2
 to filter for network devices that do not have a robot.
The Open View Dialog
Field or Button
Description
Open button
Displays the selected list in the List Designer.
Cancel button
Closes the dialog without displaying a list in the List Designer.
The List Designer Save Dialog
Field or Button
Description
Directory tree
Select a directory to save the list in.
Text field
Enter a name for the list. Enter a directory structure before the list name to create subdirectories. For example, servers/disk_usage/latest_list creates the subdirectories servers and disk_usage and the list named latest_list.
Access type pull down menu
Choose the type of access for the list:
  • public - Can be viewed by all users.
  • account - Can be viewed only by users of the account that you used to log in.
     
    Note: 
    Saving to an account requires the Portal Administrator ACL.
  • private - Can be viewed only by you.
Delete button
Deletes the list that is selected in the directory tree.
Save button
Saves the list.
Cancel button
Closes the dialog without saving the list.