Setting data definitions by using custom data definitions

To monitor data sources in Telco Network Cloud Manager - Performance, you must use custom data definitions. To a widget, you can add either single or multiple custom data definitions, based on the chart type that you select.

About this task

You can add multiple custom data definitions to Time Series, Bar, Bubble, Complex Gauge, Radar, and Scatter charts only. To all the remaining charts, you can add only a single custom data definition. If you modify a custom data definition, then those modifications are not displayed on the widget, unless you reattach the newly modified custom data definition to the widget.
Note:
  • For Complex Gauge chart, you must select two custom data definitions.
  • For a real-time widget, you cannot add multiple data definitions to the Line chart.

If a dashboard has multiple occurrences of the same custom data definition, then always only a single common version of that custom data definition is maintained within the dashboard. Whenever you modify such a custom data definition and reattach it to a single widget within the dashboard, all the other similar occurrences, use the recently added custom data definition version.

The following are the custom data definition version scenarios that you must consider while reattaching custom data definition:
  • If two dashboards contain multiple occurrences of the same custom data definition, then each dashboard maintains its individual version. If you modify the custom data definition and reattach it to only one dashboard, then only that dashboard uses the updated version of the custom data definition. The custom data definition version in the second dashboard remains unchanged.
  • The recently added custom data definition version always overrides the existing custom data definition versions, irrespective of the individual custom data definition versions. For example, when two versions of a custom data definition exist, and an older version of the custom data definition is attached to one custom widget, whereas a modified version of the same custom data definition exists within a dashboard. Then, if you add the custom widget to the dashboard, the custom data definition version of the added custom widget template is used because it is the recently added custom data definition.

Procedure

To set custom data definitions, complete the following steps:
  1. On the widget page, click the Set Data Definition Set Data Definition icon icon to select a data source, and its monitoring elements.
  2. In the Set Data Definition window, click Select from saved Data Definition, and then click Continue.
  3. In the Set Data Definition window, based on the chart type, click one or more data definitions that are listed under Data Definition (select one or more) pane, and click Move to selected icon to add the data definitions to Selected Data Definition pane.
    If you want to delete a selected data definition, click the Delete Delete icon that is displayed next to it.
    Note:
    • Based on the chart type, you must set chart properties for the selected attributes values. For Bar and Time Series charts, you can specify a single attribute value for X-axis and multiple attributes values for Y-axis. You can also configure dual Y-axis by setting chart properties for right Y-axis.
    • For a real-time widget, you must use a Line chart and plot a single series only.
  4. Optional: If you selected filters for the widget, then ensure that you set and add cases for the query or REST API methods.

    For more information about setting and adding cases for the query or REST API methods, see Creating a custom data definition.

  5. Click the Set Properties Set Properties icon icon.
  6. In the Set Properties window, click Chart, and complete any of the following steps to set chart properties based on the chart type that you selected:
    Table 1. Chart properties
    Chart type Task
    Bar or Time Series
    1. Click SERIES.
    2. In the SERIES TYPE tab, complete any one of the following steps:
      • To set one hardcoded legend at a time that results into a single line per series, click Define a Manual Series.
      • To set multiple lines per series, click Define a Dynamic Series.
    3. In the SERIES tab, complete the following steps:
      • In the X-axis Labels field, enter a column name that is displayed in the custom data definition preview, and that must be displayed on the chart.
      • In the Y-axis Values field, enter a column name that is displayed in the custom data definition preview, and that must be displayed on the chart.
    Baseline chart
    1. Click SERIES.
    2. In the X-Axis Label, Actual Value, High Value, Low Value, and Baseline Value fields, enter the required column names from the custom data definition preview. Enter only those column names that you want to display on the chart.
    Grid chart Click COLUMNS, and in each column pane, complete the following steps:
    1. In the Column Header Name field, enter a column heading.
    2. In the Column Content Value field, enter a column name that is displayed in the custom data definition preview, and that must be displayed on the chart.
    Badge chart
    1. Click TITLE and in the Badge Title enter a title for the badge chart.
    2. Click VALUE and in the Badge Value field, enter a column name that is displayed in the custom data definition preview, and that must be displayed on the chart.
    Pie chart Click SERIES and in the Value field, enter a column name that is displayed in the custom data definition preview, and that must be displayed on the chart.
    Gauge chart
    1. Click CHART and in the Value field, enter a column name that is displayed in the custom data definition preview, and that must be displayed on the chart.
    2. Click COLORS.
    3. In the Range field, select minimum and maximum values for each range.
    4. From the Color list, select a color for each predefined range.
    Heatmap chart
    1. Click SERIES.
    2. In the Row Values, Column Values, and Heat Value fields, enter column names that are displayed in the custom data definition preview, and that must be displayed on the chart.
    Circos chart
    1. Click SERIES.
    2. In the Source, Destination, and Value fields, enter column names that are displayed in the custom data definition preview, and that must be displayed on the chart.
    Sankey chart Click SERIES and in the Source, Destination, and Weightage fields, enter a column name that is used in the saved data definition and that must be displayed on the chart.
    Venn chart Click SERIES and in the Data Set ID, Data Set Value, Data Set Display Name, and Data Set Tooltip fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Range Column chart Click SERIES and in the X-axis Label, High Value, and Low Value fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Quadrant Motion chart
    1. For X-AXIS and Y-AXIS, in the MIN COUNT field, enter a minimum count value and in the MAX COUNT filed, enter a maximum count value.
    2. Click SERIES and in the X-axis Value, Y-axis Value, Motion Control Value, and Legend fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Bullet chart
    1. Click SERIES, and in the Bullet Name and Bullet Value fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    2. Select the Add Target checkbox, and in the Target Value field, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Scatter and Bubble charts
    1. Click SERIES.
    2. In the Data Definition field, enter the name of the Data Definition that you used to create the chart.
    3. In the Bubble Size and X-axis Values fields, enter a column name that is used in the data definition that must be displayed on the chart.
    Complex Gauge chart
    1. Click SERIES.
    2. In the Data Definition field, enter the name of the custom data definition that you used to create the chart.
    3. In the Value and Additional Value fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Sunburst chart Click SERIES and in the ID, Parent, Name and Value fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Tag Cloud chart Click SERIES and in the Word, Value/Frequency, Category and Additional Tooltip Text fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Radar chart
    1. Click SERIES.
    2. In the Series Name (that appears in Tooltip) field, enter the tooltip value that must be displayed on the chart.
    3. In the X-axis Values and Y-axis Values fields, enter a column name that is used in the Data Definition that must be displayed on the chart.
    Tree chart
    1. Click SERIES.
    2. In the ID, Parent, Type, Node label and Metric value fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Note: The parent-child relation in the Tree chart is based on the ID and Parent columns.
    Treemap chart
    1. Click SERIES.
    2. In the ID, Parent, Node label, Size, and Node value fields, enter the required column names from the custom data definition preview. Enter only those column names that you want to display on the chart.
    Note: The parent-child relation in the Treemap chart is based on the ID and Parent columns.
    Topology chart
    1. Click SERIES.
    2. In the Nodes, Value, Source, Destination, and Groups fields, enter a column name that is used in the saved data definition that must be displayed on the chart.
    Note: Groups and Nodes columns are used to establish parent and child node relations within the chart.
    Map chart
    1. Click SERIES.
    2. In the MAP pane, in the following fields, enter the required column names from the custom data definition preview. Enter only those column names that are required to plot a map.
      • Latitude
      • Longitude
      • Display name
      • ID
      • Parent
      • Map
    Note: Nested maps are generated based on the ID, Parent, and Map fields.
    Note:
    • Ensure that you enter appropriate column names from the custom data definition preview.
    • Repeat the steps to map all the data definitions that you selected.
    • The steps that are mentioned in the table are minimal steps that must be completed for any chart to be displayed. For more information about setting chart properties, see the following topics:
    • Widgets or dashboards that are created by using the JDBC custom data definitions always display the timestamp data in the Epoch format only. However, while setting chart properties, you can change the display format from Epoch to any other format in Bar, Time Series, and Grid charts only.
  7. Close the Set Properties window.