KPI
The Key Performance Indicators (KPI) widget shows the key performance indicators for the selected resources. It obtains an aggregated score, chart, and the trend line for the selected Tenant(s), Devices, Link, Tunnels, and Indicators in a selected timeframe.
Data
The Data tab enables you to select the resources to graph.
Perform the following steps to set the widget settings for Data tab.
- Click the Datasource drop-down and select the SevOne NMS cluster or appliance.
- Choose one of the following radio buttons (DEVICE GROUP or INDICATORS or OBJECT GROUP)
-
DEVICE GROUP
- Click the Tenant drop-down to select a tenant to report on.
- Click Run to generate a KPI report based on the configuration.Note: Run button is only available when one or more fields are changed in the Data tab.
- In the report generated,
- Click the Sites drop-down and select one or more sites.
- Click the Link drop-down to select a link type.
- Click the Indicators drop-down to select one or more indicators.
Example
Note: After generating a report
Replace Untitled Report name with an appropriate report name. For example, KPI Report.
Replace Untitled Section name with an appropriate name. For example, KPI.
-
INDICATOR
- Click the Tenant/Device Group drop-down to select a tenant or a device group.
- Click the Devices drop-down to select one or more devices.
- Click the Link drop-down to select a link type.
- Click the Tunnels drop-down to select one or more tunnels.
- Click the Indicators drop-down to select one or more indicators.
- Click Run to generate a KPI report based on the configuration.Note: Run button is only available when one or more fields are changed in the Data tab.
Example
-
OBJECT GROUP
- Click the Object Group drop-down to select an object group.
- Click Run to generate a KPI report based on the configuration.Note: Run button is only available when one or more fields are changed in the Data tab.
- In the report generated,
- Click the Link drop-down to select a link type.
- Click the Indicators drop-down to select one or more indicators.
Example
-
DEVICE GROUP
Analyze
The Analyze tab enables you to define the time zone and timespan.
Perform the following steps to set the widget settings for Analyze tab.
- Click the Time zone drop-down and select a time zone.
- Click the Timespan drop-down and select one or more of the following options:
- Past <n> hours, days, weeks, months, quarter, year - to display data from hours, days, weeks, months, quarter, or year ago until now.
- Today - to display data from 12:00am today until now.
- Yesterday - to display data from 12:00am yesterday until 12:00am today.
- Last week, month, quarter, year - to display data from 12:00am on the first day of the last completed week, month, quarter, or year to 11:59pm on the last day of the last completed week, month, quarter, or year.
- This week, month, quarter, year - to display data from 12:00am on the first day of the week, month, quarter, or year until now.
- Customize the timespan with From and To date / time.
Settings
The Settings tab enables you to configure settings for KPI ranges.
- Click the Indicator drop-down and select one of the following options:
- Jitter
- Latency
- Loss Percentage
- Utilization
-
From Settings tab, the Min/Max ranges can be set. In the screenshot above, KPI assumes the Indicator Types where:
- Good means < 22ms
- Fair means >= 22ms and <= 40ms
- Poor means > 40ms
Linking
The Linking tab enables you to select a data element and link it to a related report or report template. Perform the following steps to add, delete, and edit links.
Perform the following steps to set the widget settings for Linking tab.
- Include report links allows you to include the report links that you configure. Enable to include the report link that you configure. If you want to prevent the report link from being included, disable it. Continue with the steps below to configure report link(s).
- Switches for individual report links are selected by default. If you wish to exclude a specific report link, disable the switch for it.
- Use the Clicking on drop-down to select a data item that you want to link with the report or report template. When you select a data item for a report link, that data item is no longer listed as an option for other report links as it has already been used. You can apply multiple reports/report templates to the selected data item.
- Click the Links to report drop-down and select one or more reports or report templates to display when you click on the data item that you specified in the previous step.
- To remove a report link, click .
- If the report link has been deleted, you may click to add.
Charts
The Charts tab enables you to define how you want to display the report data.
Visualizations
The charts provide 4 visualizations.
ScoreCard
The ScoreCard visualization displays the score for the selected indicator across the selected tunnels under Resources tab. The score is inversely proportional to the indicator values across the selected tunnels. KPI is shown for Jitter, Latency, Loss Percent, and Utilization which affects the tunnel’s data flow. The scorecard range is 1 - 10.
Perform the following steps to set the widget settings for the ScoreCard visualization.
- Select the ScoreCard visualization by clicking .
- TITLE
- Enable Show title to enter the title name in the text field provided and display it in report. Else, disable it.
- Enable Show subtitle to enter the sub-title name in the text field provided and display it in the report. Else, disable it.
- AGGREGATION TYPE
- Use the drop-down to select one of the following aggregation types.
- Average
- Minimum
- Maximum
- Use the drop-down to select one of the following aggregation types.
Threshold
The Threshold visualization categorizes the tunnels based on the range you set in the Settings tab. The Min/Max ranges are the user-defined boundary to categorize the tunnels into three categories.
- Good Tunnel means < 22ms
- Fair Tunnel means >= 22ms and <= 40ms
- Poor Tunnel means > 40ms
Perform the following steps to set the widget settings for the Threshold visualization.
- Select the Threshold visualization by clicking .
- TITLE
- Enable Show title to enter the title name in the text field provided and display it in report. Else, disable it.
- Enable Show subtitle to enter the sub-title name in the text field provided and display it in the report. Else, disable it.
- BAR
- Select the radio button to choose whether you want to display the data in Column or Bar mode.
- Under Spacing, extend the bar to the right to increase the spacing or shorten the bar to decrease the spacing.
- LEGEND
- Enable Show legend to obtain the descriptions of the bar chart.
- AXIS
- Enable Include goal lines to add one or more goal lines to the graph. Then perform the
following actions:
- In the Name field, enter a name for the goal line.
- In the Value field, enter a target value for the goal line.
- In the Width field, enter a number to indicate how wide the goal line should be.
- Click to display the color palette. Select a color to apply to the specified range.
- To add another goal line, click and repeat the actions above.
- To remove a goal line, click next to that goal line.
- Enable Include goal lines to add one or more goal lines to the graph. Then perform the
following actions:
- AGGREGATION TYPE
- Use the drop-down to select one of the following aggregation types.
- Average
- Minimum
- Maximum
Column mode
Bar mode
- Use the drop-down to select one of the following aggregation types.
Trend
The Trend visualization displays the aggregated indicator value for the tunnels for each day for the selected timespan. Perform the following steps to set the widget settings for the Trend visualization.
- Select the Trend visualization by clicking .
- TITLE
- Enable Show title to enter the title name in the text field provided and display it in report. Else, disable it.
- Enable Show subtitle to enter the sub-title name in the text field provided and display it in the report. Else, disable it.
- BAR
- Select the radio button to choose whether you want to display the data in Column or Bar mode.
- Under Spacing, extend the bar to the right to increase the spacing or shorten the bar to decrease the spacing.
- LEGEND
- Enable Show legend to obtain the descriptions of the bar chart.
- AXIS
- Enable Include goal lines to add one or more goal lines to the graph. Then perform the
following actions:
- In the Name field, enter a name for the goal line.
- In the Value field, enter a target value for the goal line.
- In the Width field, enter a number to indicate how wide the goal line should be.
- Click to display the color palette. Select a color to apply to the specified range.
- To add another goal line, click and repeat the actions above.
- To remove a goal line, click next to that goal line.
- Enable Include goal lines to add one or more goal lines to the graph. Then perform the
following actions:
- AGGREGATION TYPE
- Use the drop-down to select one of the following aggregation types.
-
Average
-
Minimum
-
Maximum
-
Column mode
Bar mode
- Use the drop-down to select one of the following aggregation types.
Table
The Table visualization displays the data as a table. Perform the following steps to set the widget settings for the Table visualization.
- Select the Table visualization by clicking .
- TITLE
- Enable Show title to enter the title name in the text field provided and display it in report. Else, disable it.
- Enable Show subtitle to enter the sub-title name in the text field provided and display it in the report. Else, disable it.
- COLUMN SELECTION
- Select the check boxes to display the selected fields as data columns in the table. The names in the second column are the names for the columns that appear in the report. You may modify the names in the second column to your choice.
- TABLE
- Enable Allow toggle columns to allow columns that display in the report to be toggled. Once enabled, a drop-down appears in the report to select columns as per your requirements.
- Enable Allow column reordering to allow the columns that display in the report to be reordered.
- Enable Abbreviate numbers to abbreviate large numbers. Once enabled, enter the data
precision in the Precision field. For example, enter 4.
- The values displayed in the report generated will now display data with the data precision
entered. Examples of large decimal number abbreviation are:
- 20.12345 will display as 20.1234 when Precision = 4
- 20.12345 will display as 20.12 when Precision = 2
- 20.14912 will display as 20.15 when Precision = 2 NOTE: Number is rounded.
- The values displayed in the report generated will now display data with the data precision
entered. Examples of large decimal number abbreviation are:
- Enable Wrap cell contents to wrap long text in a data row so that all text displays. Leave clear to display as much text as fits into the cell with ellipses to indicate there is more text.
- Under Cells font size, perform one of the following actions to configure the font size of
the cell:
- Extend the bar to the right to increase the font size or shorten the bar to decrease the font size.
- Enter a number for the font size in the field next to the bar.
- AGGREGATION TYPE
- Enable the Custom Aggregation to use the custom aggregation type. Use the drop-down to select a type.
- Average
- Minimum
- Maximum
- Enable the Custom Aggregation to use the custom aggregation type. Use the drop-down to select a type.
- PAGINATION
- Enter a value to choose the Page Size.
- Click the Reset button to reset the default page size. The default page size is 20.
- INTERFACE SPEED UNIT
- Use the drop-down to select unit for the interface speed. It can be Mbps, Bits, or Gbps.
Example