Creating a custom data definition

You must create custom data definitions for Telco Network Cloud Manager - Performance timeseries datasource that has real-time performance data.

Before you begin

  • By default, Designer tool has built-in Connector Source for Telco Network Cloud Manager - Performance. For more information, see Testing database connection with Connector Source.
  • If you need to provide custom headers for NPI Connector, then ensure that you have that information available with you.

    Custom headers are request headers that are needed to retrieve REST API information from a web service. For example, Authorization request headers or Accept-Charset request headers. Authorization request headers contain authorization information that is needed by the web services. Accept-Charset indicates the acceptable data characters that the response must contain.

  • For more information about the URI formats or query formats for each connector type, see the following links:

About this task

Any Dashboard Designer user can create customized data definitions.

After you log in to Dashboard Designer, you can create data definitions by using any of the following options on the landing page:

A widget displays any of the following icons based on the state of the data definitions:
  • Incomplete data definition Incomplete data definition icon.
  • Complete data definition Complete data definition icon.
  • Deleted data definition Deleted data definition icon.

Procedure

  1. Click CREATE COMPONENTS > DATA DEFINITION.

    Or

  2. Click the Expand Expand icon to open the navigation pane of Dashboard Designer, and click Data Definition > Custom > Create New Data Definition.

    The New Data Definition tab opens.

  3. Click the Edit icon to enter a name for the custom data definition.
  4. By default, the Connector Type list shows NPI.
  5. By default, the Connector Source Name list shows default-npi as the Connector Source.
  6. By default, the Endpoint URL list shows https://ui:30021, which is the URL for the UI Service from where the data is fetched.
  7. From the Method list, select a method and complete any of the following steps, based on the method that you select:
    • For GET method, in the URI field, enter the uniform resource identified (URI) for the source.
    • For POST method, in the URI field, enter the URI for the source, and in the Request Body field, enter the post request.
    • Under Custom Headers, complete the following steps:
      • In the Name field, enter the request header name that is provided by the REST API service provider.
      • In the Value field, enter the request header value that is provided by the REST API service provider.
    Note: If you want to set master-listener or drill-down relation between widgets or dashboards that contain custom data definition, then ensure that the parameter name and the common metric value for the master widget are already specified in the custom data definition of the listener or drill-down widget.

    For more information, see Setting relations.

  8. Optional: If you want to filter data by using filters, then you must set and add cases to the query or the REST API methods.

    Complete the following steps to set default case and add cases:

    1. In the Default Case area, in the Attribute field, enter a filter name or attribute name, and in the Value field, enter a display name.

      You can click Add Attribute and repeat this step to add multiple attributes and display values.

    2. To add a conditional filter, click Add Case, and then set the filter conditions by entering values in the Attribute and Value fields.

      You can add and set multiple attributes and values for each case.

  9. To save the custom data definition, click Save.
  10. In the Save Data Definition window, follow these steps:
    1. In the Name field, enter a new name for the data definition. You can use alphanumeric characters and underscore in the name field.
    2. To save the data definition to an existing category, click Existing Category, select a category from the list, and click Save.
    3. To save the data definition to a new category, click New Category, and enter a name for the new category, and click Save.

    To save the data definition with another name, click the Save As option.

  11. To view and validate the response that is received from the custom data definition that you created, click the Preview icon.

    The response from the custom data definitions must be displayed in a tabular format. If the response is in an incorrect format, then it is not displayed in a tabular format.

Results

The newly created custom data definition is listed under Most Recently Created Data Definitions in the navigation pane.

What to do next

You can use custom data definitions in widgets or dashboards. For more information, see Creating custom widgets or Creating a dashboard.