Data Sources

About Advanced Visualization Data Sources

Advanced Visualization provides out of the box capabilities that enable you to visualize data for the following Predix Essentials features and modules:

  • Alerts
  • Analytics
  • Assets
  • Baseline entities and queries
  • Cases
  • Cost Benefit Analysis (CBA)
  • General recommendations
  • SmartSignal
  • Time Series Data
Each of these features is associated with a set of data sources in Advanced Visualization. The data sources contain a set of logically related fields that allow you to create and customize the visualizations based on the access privileges that you have for the specific feature.
Note: Although you have access to all the data sources, you must also have access to the required capabilities to create visualizations using these data sources. You can visualize the data for the assets based on the permissions granted to your Predix Essentials user account.

The following table provides high-level information about the data sources available for the supported modules or features:

Module/FeatureData Source Description
AlertsYou can visualize data using one of the following types of business views available in the Predix Essentials baseline domain:
  • View that provides access to most of the data available and accessible within Alerts.
  • Curated view that allows you to create visualizations for specific requirements.
Note:
  • You cannot modify the baseline business view. However, you can create a copy of the view that you want to modify within your tenant, and then modify the view as needed.
  • The Dimensions and Facts tables in the Alerts Business Views facilitate the creation of visualizations using the Alerts data sources.
AnalyticsYou can visualize analytic data using one of the following types of business views available in the Predix Essentials baseline domain:
  • View that provides access to most of the data available for an analytic.
  • Curated view that allows you to create visualizations for specific requirements.
Note: You cannot modify the baseline business view. However, you can create a copy of the view that you want to modify within your tenant, and then modify the view as needed.
AssetsYou can visualize assets data using one of the following types of business views available in the Predix Essentials baseline domain:
  • View that provides access to most of the data available for an asset.
  • Curated view that allows you to create visualizations for specific requirements.
Note: You cannot modify the baseline business view. However, you can create a copy of the view that you want to modify within your tenant, and then modify the view as needed.
CasesYou can visualize data using one of the following types of business views available in the Predix Essentials baseline domain:
  • View that provides access to most of the data available and accessible within Cases.
  • Curated view that allows you to create visualizations for specific requirements.
Note:
  • You cannot modify the baseline business view. However, you can create a copy of the view that you want to modify within your tenant, and then modify the view as needed.
  • The Dimensions and Facts tables in the Cases business views facilitate the creation of visualizations using the Cases data sources.
CBAYou can visualize data using one of the following types of business views available in the Predix Essentials baseline domain:
  • View that provides access to most of the data available and accessible within the Cases module to create visualizations for CBA data.
  • Curated view that allows you to create visualizations for CBA data based on specific requirements.
Note: You cannot modify the baseline business view. However, you can create a copy of the view that you want to modify within your tenant, and then modify the view as needed.
General RecommendationsYou can visualize data based on the general recommendations data available within Predix Essentials.
Predix Essentials Baseline EntitiesYou can visualize data using the baseline entity views available in Predix Essentials.
Note:
  • The baseline entity view provides access to most of the data that is available for an entity.
  • Curated views are not created for the baseline entities. However, you can create a custom curated view for an entity within your tenant.
Predix Essentials Baseline QueriesYou can visualize data using the baseline query views available in Predix Essentials.
Note:
  • The baseline query view displays the result of a query.
  • As needed, you can create a curated view for the query result within your tenant.
SmartSignalYou can visualize SmartSignal analytic models using one of the following types of business views available in the Predix Essentials baseline domain:
  • View that provides access to most of the data available for the SmartSignal analytics.
  • Curated view that allows you to create visualizations for specific requirements.
Note:
  • You cannot modify the baseline business view. However, you can create a copy of the view that you want to modify within your tenant, and then modify the view as needed.
  • We recommend that you use the following reporting objects as data sources when creating visualizations for SmartSignal events and jobs:
    • events_reporting_object
    • jobs_reporting_object
    In addition to the features provided by SmartSignal baseline and custom business views, the reporting objects allow you to filter SmartSignal data for a specific period.
Time Series DataYou can visualize time series data that is collected for a set of asset tags associated with your tenant. The data source is created based on a reporting object and curated for creating customized visualizations.

Create a Data Source using a Predix Essentials Query

Before You Begin

  • Make sure that the baseline query or the custom query that you want to use to create a data source exists in the Catalog.

About This Task

This topic describes how to create a data source using a baseline query or a custom query, and configure the data source to enable the Advanced Visualization users to create charts or dashboards using the data source.

Procedure

  1. Access the Advanced Visualization page.
  2. Select , and then select Prepare and Manage Data.
    The SERVER page appears.
  3. Select Get Data.
    The Get Data window appears.
  4. In the SERVER FILES section, select REST, and then select Select.
    The Configure Connections window appears.
  5. Select APM_QUERY, and then select Select.
    The Create a Synonym for REST window appears.
  6. In the Create Synonym options section, specify the following parameters:
    Note: We recommend that you use the Query Helper to validate the query parameters and copy the field values to the corresponding fields in the Create Synonym options section. For more information on how to use the Query Helper to validate the query parameters, refer to the Retrieve Query Details of a Predix Essentials Query using Query Helper topic.
    1. In the Select REST Operation box, select Post.
    2. In the Service URL Extension box, enter: v2/catalog/query/path/execute
      Note: If you use a Predix Essentials version older than V4.5.0.0.0, enter: v1/catalog/query/path/execute
    3. In the Provide document sample box, enter the request body parameters for the Insert (POST) request.
      • The following example provides a template for the request body:
        {
"QueryPath":"query path",
"Page":0,
"PageSize":100,
"InputSingleParams":
{
    "parameter1":"value",
    "parameter2":"value2"
} 
,
"InputMultiParams":
{
    "parameter1":["value1","value2"],
    "parameter2":["value1","value2"]
}
}
      • The following example provides a sample request body for a query:
        {
  "QueryPath": "Public\\Meridium\\Modules\\Generation Management\\Queries\\NERC Queries\\NERC Event Report 07",
  "InputSingleParams": {
    "unitKey": "-1",
    "endDate": "2021-03-04T04:15:20.795",
    "startDate": "2021-03-04T04:15:20.795"
  },
  "InputMultiParams": null
}
  7. In the Synonym Field Name Processing Options section, select the following check boxes:
    • Validate
    • Make Unique
  8. In the Miscellaneous settings section, specify the following details:
    1. In the Application box, navigate to the application directory that will contain the data source that you want to create.
    2. In the Synonym Name box, enter a name for the data source that you want to create.
  9. Select Add.
    The data source is created in the Application Directory.
  10. Access the Application Directory that contains the data source that you created, right-click the data source, and then select Open.
    A page appears, displaying the Table/Column panel that contains a hierarchy of the query parameters.
  11. Configure the following query parameters:
    Important: We recommend that you use the Query Helper to validate the query parameters, and copy the parameter values from the XDEFAULT section of the APM Query Helper window to the XDEFAULT box of the Properties window for the corresponding parameters. For more information on the Query Helper, refer to the Retrieve Query Details of a Predix Essentials Query using Query Helper topic.
    Query ParameterActions to be Performed
    QUERYPATH
    1. Right-click the parameter, and then select Properties.

      The Properties window appears.

    2. In the Miscellaneous section, in the XDEFAULT box, enter the query path that you used to create the synonym, and then select Apply.
      Important:
      • You must use a backslash to separate the server names, folder names, and file names in the query path (for example, Public\Meridium\Queries\TEST_CATALOG_READ_MT).
    INPUTSINGLEPARAMS
    1. Expand the object to view the parameters.
    2. Right-click a parameter, and then select Properties.

      The Properties window appears.

    3. In the Miscellaneous section, in the XDEFAULT box, enter the parameter value, and then select Apply.
    INPUTMULTIPARAMS
  12. In the SERVER page, select the Save button to save the parameters.
    The data source is configured.

What To Do Next

Retrieve Query Details of a Predix Essentials Query using Query Helper

About This Task

When creating a data source using a baseline or custom query, you must have the following query details:
  • Sample request body for the Insert (POST) operation
  • Service URL extension
  • Valid query path
  • Valid query parameters and parameter values
Using Query Helper, you can retrieve the parameters of a query and validate the parameter details to ensure that correct data is available for creating the data source.

This task describes how to retrieve and validate the parameter details of a query to create a data source.

Procedure

  1. Access the Advanced Visualization page.
  2. Select Query Helper.
    The APM Query Helper window appears.
  3. In the Enter Query Catalog Path box, enter the query for which you want to fetch the parameter details, and then select Get Details.
    The following boxes are populated:
    • Service URL Extension
    • Sample Request Body
    • Query Path
    • <Parameter Name>
    Note: To copy the data contained in each box, select .
    The following table describes the fields available in the APM Query Helper window:
    FieldDescriptionBehaviour
    Service URL ExtensionDisplays the following service URL extension by default:

    v2/catalog/query/path/execute

    Note: If you use a Predix Essentials version older than V4.5.0.0.0, the following service URL extension is displayed: v1/catalog/query/path/execute.
    		You cannot modify data in this field.
    Sample Request BodyDisplays the parameter details returned by the query.

    The following example provides a sample request body returned by a query:

    {
  "QueryPath": "Public\\Meridium\\Modules\\Generation Management\\Queries\\NERC Queries\\NERC Event Report 07",
  "InputSingleParams": {
    "unitKey": "-1",
    "endDate": "2021-03-04T04:15:20.795",
    "startDate": "2021-03-04T04:15:20.795"
  },
  "InputMultiParams": null
}
    Note: For Predix Essentials versions older than V4.5.0.0.0, both the parameter and parameter value appear as parameter values for Id and Value parameters, respectively. The following example provides a sample request body returned by a query:
    {
"QueryPath": "Baseline\\Meridium\\Modules\\AHI\\Queries\\Health Overview - Tiles",
"InputSingleParams": [
{
"Id": "unitKey",
"Value": "-1"
}
]
}
    • If the request body contains valid parameters and the parameter values, you cannot modify data in the field.
    • If the request body does not contain valid parameter or parameter values, a message appears, asking you to update the parameter values. You must update the parameter values in the XDefault Values section to make the request body valid.
    Query PathDisplays the catalog path for the query.You cannot modify data in this field.
    <Parameter Name>
    Note: The field is displayed only if the query contains at least one parameter.
    		Displays the parameter name and the parameter value contained in the sample request body.
    Note: If a parameter contains multiple values, only the first value is displayed in the <Parameter Name> box.
    		If there is no valid parameter value for a given parameter, you can add the parameter value to make the request body valid.
    Note: When configuring data source with a Predix Essentials version older than V4.5.0.0.0, you must manually update the default values for the parameters Id and Value in the corresponding XDEFAULT box of the Properties window.