Table of Contents

Configuring GQI queries for Data Aggregator

Every GQI query you want to execute must be saved in a separate file in JSON format.

To configure the query, you can either use an export or manually extract and convert the query. The manual configuration should be used with DataMiner versions prior to 10.4.0 [CU21]/10.5.0 [CU9]/10.5.12, or for advanced scenarios that require more options.

Configuration using an export

From DataMiner 10.4.0 [CU21]/10.5.0 [CU9]/10.5.12 onwards, configuring GQI queries for Data Aggregator is possible using a simple export method to download the JSON file. However, in case of an advanced scenario where manual query extraction and conversion is required, follow the steps under Manual configuration instead.

  1. In a new dashboard or new low-code app, create a query.

  2. Click the ... icon next to the query to open the context menu, and select Export.

  3. In the pop-up window, click Download JSON.

  4. Place the downloaded JSON file in the correct folder, and update the Helper.json file as needed. See GQI queries for detailed instructions.

Manual configuration for earlier DataMiner versions or advanced scenarios

  1. In a new dashboard, create a query.

  2. Visualize this query on the dashboard, for example using the Table component.

  3. Press F12 to open the developer tools and go to the Network tab.

  4. Press F5 to refresh the dashboard.

  5. In the Name column of the Network tab, select the OpenQuerySession network call.

  6. Go to the Payload subtab, and copy the value of query and connection by right-clicking these and selecting Copy value.

    Developer tools Network tab

  7. Convert the query using the ConvertQueryToProtoJson web method:

    POST https://dataminer.company.local/API/v1/Internal.asmx/ConvertQueryToProtoJson

    Note

    Replace dataminer.company.local with the hostname or IP address of your DataMiner Agent.

    with the following payload, depending on the DataMiner version:

    • From DataMiner 10.4.0 [CU6]/10.5.0 [CU4]/10.5.7 onwards:

      {
  "connection": "", // copied in previous step
  "options": { "Contract": 1 },
  "query": {} // copied in previous step
}
      • Use "Contract": 0 for queries that should be executed via CoreGateway and SLHelper.
      • Use "Contract": 1 for queries that should be executed via the GQI DxM.

      The used contract should correspond to the UseGQIDxM setting.

    • In earlier DataMiner versions:

      {
  "connection": "", // copied in previous step
  "query": {} // copied in previous step
}

  8. From the received response, copy the value of d:.

    The copied value is a JSON-wrapped JSON string.

  9. Unwrap the JSON string by replacing all instances of \" with ", and all instances of \\ with \.

  10. Paste the copied JSON code into a new file and save it as a .json file.

  11. Rename your .json file, place it in the correct folder, and modify the Helper.json. See GQI queries for detailed instructions.

Improve this page