Difference between revisions of "UM:Dashboards"

From NetXMS Wiki
Jump to navigation Jump to search
m (Grammar fixes)
(Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/adminguide/visualisation.html#dashboards")
Line 1: Line 1:
{{DISPLAYTITLE:Dashboards}}
Information moved to documentation:


= Introduction =
https://www.netxms.org/documentation/adminguide/visualisation.html#dashboards
 
Dashboards are defined by administrator and allow to combine any available visualization components with data from multiple sources in order to create high-level views to see network (or parts of it) health at a glance. For example, below is a dashboard showing traffic information from core router, as well as CPU usage from vital nodes:
 
[[File:DashboardExample.png]]
 
There are two ways to access dashboards:
* Open dashboard from Object Browser
* Switch to '''Dashboard''' perspective and select dashboard with left-click
 
[[File:DashboardPerspective.png]]
 
= Configuration =
 
Dashboards is a special type of objects created in '''Dashboards''' tree. To create a new dashboard, select ''Create dashboard'' from context menu of '''Dashboards''' object or if ant existing dashboard object. To configure dashboard content, open object's properties and go to '''Dashboard Elements''' page. Here you can define number of columns in dashboard, and manage list of elements. Press ''Add'' to add new element. You will be prompted with element type selection dialog:
 
[[File:DashboardProperties.png]]
 
When a new element is added, you can edit it by double-clicking on it's record in the elements list, or by pressing the ''Edit'' button. Each dashboard element has '''Layout''' property page which controls the element's layout inside the dashboard, and one or more element type specific pages to control element's appearance and displayed information. The following element types are available:
 
{| class="wikitable"
|-
! Type !! Description
|-
| Alarm Viewer || List of alarms for given object subtree.
|-
| Availability Chart || Pie chart showing availability percentage for given business service.
|-
| Bar Chart || Bar chart.
|-
| Bar Chart for Table DCI || Bar chart built from data collected via single table DCI.
|-
| Custom Widget || Custom widget provided by third party console plugin.
|-
| Dashboard || Another dashboard object (or multiple objects) rendered as element of this dashboard.
|-
| Dial Chart || Dial chart.
|-
| Geo Map || Geographic map centered at given location.
|-
| Label || Text label with configurable text and colors.
|-
| Line Chart || Line chart.
|-
| Network Map || Network map object rendered as dashboard element.
|-
| Pie Chart || Pie chart.
|-
| Pie Chart for Table DCI || Pie chart built from data collected via single table DCI.
|-
| Separator || Separator, can be shown as line, box, or simply empty space.
|-
| Status Chart || Bar chart which shows current status distribution for nodes under given root.
|-
| Status Indicator || Shows current status of selected object.
|-
| Tube Chart || Tube chart.
|-
| Tube Chart for Table DCI || Tube chart built from data collected via single table DCI.
|-
| Web Page || Web page at given URL rendered within dashboard.
|}
 
== Element Property Pages ==
=== Chart ===
 
'''Chart''' page is available for all chart type elements: Bar Chart, Bar Chart for Table DCI, Dial Chart, Line Chart, Pie Chart, Pie Chart for Table DCI, Tube Chart, and Tube Chart for Table DCI. It defines basic properties of a chart.
 
[[File:ChartElementConfig.png]]
 
=== Data Sources ===
 
'''Data sources''' page is available for all DCI based elements: Bar Chart, Dial Chart, Line Chart, Pie Chart, and Tube Chart. Here you can define what DCIs should be used as data sources for the chart. Up to 16 DCIs can be added to a single chart. You can configure multiple properties for each data source. To edit data source, either double click on appropriate item in the list, or press ''Edit'' button. Data source configuration dialog looks like following:
 
[[File:ChartDataSourceConfig.png]]
 
{| class="wikitable"
|-
! Property !! Description
|-
| Data collection item || DCI object to be used.
|-
| Display name || Name for this data source to be used in chart's legend. If left empty, DCI description will be used.
|-
| Color || Allows you to define specific color for this data source or let system to pick one automatically.
|-
| Area chart || This option is valid only for line charts and toggles data source display as filled area instead of line.
|-
| Show thresholds || This option is valid only for line charts and toggles display of configured thresholds.
|}
 
=== Layout ===
 
Layout page looks like following:
 
[[File:DashboardElementLayoutPage.png]]
 
Meaning of each property is following:
 
{| class="wikitable"
|-
! Property !! Description
|-
| Horizontal alignment || Horizontal alignment for this element. Possible values are FILL, CENTER, LEFT, and RIGHT.
|-
| Vertical alignment || Vertical alignment for this element. Possible values are FILL, CENTER, TOP, and BOTTOM.
|-
| Horizontal span || Specify how many grid cells this element will occupy horizontally.
|-
| Vertical span || Specify how many grid cells this element will occupy vertically.
|-
| Width hint || Hint for element's width in pixels. Default value of -1 means that layout manager will decide width for element.
|-
| Height hint || Hint for element's height in pixels. Default value of -1 means that layout manager will decide width for element.
|}
 
More detailed information about dashboard layouts can be found in [[UM:Dashboards#Understanding_Element_Layout]].
 
=== Web Page ===
 
'''Web Page''' property page is available for web page type elements. Here you can define URL to be displayed and optional title. If tytle is not empty, it will be displayed above page content.
 
= Understanding Element Layout =
 
Dashboard uses grid concept to layout it's elements. Available space is divided into rows and columns, and each element occupies one or more cells. The number of columns is configured in dashboard object properties, and number of rows is calculated automatically based on number of columns, elements, and cells occupied by each element. Elements are laid out in columns from left to right, and a new row is created when there is no space left for next element on current row.
Each element has horizontal and vertical alignment properties. Default for both is FILL. Possible alignment values are following:
 
{| class="wikitable"
|-
! Value !! Description
|-
| FILL || Make element to fill whole cell. Also causes to grab excess free space available inside dashboard. If more than one element is trying to grab the same space, then the excess space is shared evenly among the grabbing elements.
|-
| CENTER || Center element within cell.
|-
| LEFT/TOP || Align element to left/top of the cell.
|-
| RIGHT/BOTTOM || Align element to right/bottom of the cell.
|}
 
Below is an example of complex layout configuration:
 
[[File:DashboardComplexLayoutConfig.png]]
 
And the result is following:
 
[[File:DashboardComplexLayoutExample.png]]
 
= Dashboard Rotation =
 
To create configuration when console displays multiple dashboards one by one in a loop, follow these steps:
 
# Create all dashboards you want to show;
# Create additional dashboard object, with single element of type "Dashboard" inside;
# Add all dashboards you want to show to dashboard list of that element and set desired time between changing dashboards.
 
Below is sample configuration of two dashboards displayed in a loop for 40 seconds each.
 
[[File:DashboardRotationConfig.png]]
 
 
= Tutorials =
 
* http://youtu.be/ZfJQiUIDHY4

Revision as of 17:42, 24 November 2017

Information moved to documentation:

https://www.netxms.org/documentation/adminguide/visualisation.html#dashboards

Retrieved from "https://wiki.netxms.org/index.php?title=UM:Dashboards&oldid=1637"