Read Complete Release Notes

Feature released in SummitAI Platform

What is Grafana?

Grafana is an open source visualization and analytics software. It allows you to create a query, visualize, and explore your data from any storage or database. It converts and displays the data into a graphical reports or dashboards. This guide helps you to get started and create dashboards using Grafana.

Benefits

You can leverage the following benefits by integrating SummitAI database with Grafana:

• Visualize the Reports and Dashboards by creating them using the information available in the SummitAI database.

Integrating SummitAI with Grafana

SummitAI provides the plugins that can be used to integrate Grafana with the database. Follow the below steps to integrate SummitAI Database with the Grafana:

1. Install Grafana. For more information, see the Official Grafana Website.
2. Download the SummitAI Data Source plugins from the below path:
   https://summitbuild.blob.core.windows.net/common/summit-grafana-json-datasource.zip
3. Copy and paste the plugins folder summit-json-datasource in the below path:
   C:\Program Files\GrafanaLabs\grafana\data\plugins
4. Restart the Grafana Services (one-time activity) as follows:
   • Open Run command, enter msc, and then click OK.
   • On Services (Local) window, select Grafana, and then click Restart.

SummitAI Data source plugins

SummitAI Data source plugins communicate with the SummitAI Database and retrieves the data in a format that Grafana understands. After adding the SummitAI Data Source Plugins, you can immediately use the data to create the Reports and Dashboards.

 For more information, contact SummitAI Support.

Creating SummitAI Data Source

To create the SummitAI Data Source in Grafana:

1. Click Configuration > Data Sources.
   
   
   
   
2. Click Add data source.
   
   
   
   
3. Search and select the SummitAI data source.
   
   
   
   
4. Click Select. Settings pop-up page gets displayed.
   

5. Specify all the required details such as Name, HTTP details, Auth details, and Custom HTTP Headers.
   
   
   
   

   Note:

   • Specify the SummitAI reporting API URL to get connected to retrieve the data. To get the Reporting API URL, contact SummitAI Support.
   • It is mandatory to specify the Custom HTTP Headers such as Header and Value. Specify the Header value as APIKey and Value as API Key which is generated while creating a User in the SummitAI application.
6. Click Save & Test.

Creating Dashboards

To create Dashboard:

1. Click +icon and then Add new panel.
   
   
   
   
   
   
2. To execute and create the dashboards, you can follow either of the following:

   1. To display the datasource parameters, select SUMMIT from the drop-down list on the New dashboard page. Refer the below screenshot that are displayed based on the SUMMIT plugins.
      

      Parameter Name	Description	Notes
      DataSource	Name of the DN table. If you want to specify the   RawSQL parameter, DataSource is not mandatory.	For Example: IM_RPT_DN_TicketMaster
      Columns	Specify the column names that are required to build the Reports.	Use comma separation to specify multiple columns. For Example: [Ticket No],[Status],[Registered Time]
      Filters	Specify the condition to filter the data.	Use comma separation to specify multiple filters inside the condition. For Example: Status IN ('New','Assigned','In-Progress','Pending')
      PageIndex	Number of the page that you are looking into.	For Example: If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the PageNumber value as 1.
      PageSize	Number of records that should be displayed per each page.	For Example: Consider you specified the PageSize value as 100. Based on the PageNumber, the API Response displays 100 records.
      SortColumn	Specify the column with which you want to sort the data.
      SortOrder	Order in which the column gets sorted.	The value is either ascending or descending.
      RawSQL	SQL query to get the data. If you want to specify the   DataSource parameter, RawSQL is not mandatory.	For Example: SELECT Status,COUNT([Ticket ID]) as cnt,[Registered Time] as time FROM IM_RPT_DN_TicketMaster WITH (NOLOCK) WHERE Status IN ('New','Assigned','In-Progress','Pending') GROUP BY Status,[Registered Time]

   2. Specify the parameter values to get the de-normalization data from the Summit DN tables. Using the DN tables you can build the reports and dashboards. SQL Query gets precedence over the API request.

      Note:

      Click the Editor icon and specify the SQL Query to get the data from the DN tables.
      
      

   3. Select Show Help to view the list of parameters as shown in the below screenshot:
      
      
      
      
3. Execute the payload or SQL Query and select the Visualization type to view the dashboards.