VOOZH about

URL: https://www.cdata.com/kb/tech/sharepoint-cloud-grafana.rst

⇱ Create SharePoint-Connected Dashboards in Grafana


Create SharePoint-Connected Dashboards in Grafana

πŸ‘ Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Connect to SharePoint Data via CData Connect AI in Grafana and create custom business dashboards with real-time access to SharePoint data.

Grafana is an open-source platform that allows users to analyze, monitor, and visualize telemetry from various data sources. When combined with CData Connect AI, you gain immediate access to SharePoint data for business dashboards. This article outlines the process of connecting to SharePoint using Connect AI and creating a basic dashboard from SharePoint data within Grafana.

CData Connect AI offers a pure SQL Server, cloud-to-cloud interface for SharePoint, enabling the creation of dashboards directly from live SharePoint data within Grafana, all without the need for data replication to a native database. As you build visualizations, Grafana generates SQL queries to gather data. With its inherent optimized data processing capabilities, CData Connect AI efficiently channels all supported SQL operations, including filters and JOINs, directly to SharePoint. This leverages server-side processing to swiftly deliver the requested SharePoint data.

About SharePoint Data Integration

Accessing and integrating live data from SharePoint has never been easier with CData. Customers rely on CData connectivity to:

  • Access data from a wide range of SharePoint versions, including Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 and above, and SharePoint Online.
  • Access all of SharePoint thanks to support for Hidden and Lookup columns.
  • Recursively scan folders to create a relational model of all SharePoint data.
  • Use SQL stored procedures to upload and download documents and attachments.

Most customers rely on CData solutions to integrate SharePoint data into their database or data warehouse, while others integrate their SharePoint data with preferred data tools, like Power BI, Tableau, or Excel.

For more information on how customers are solving problems with CData's SharePoint solutions, refer to our blog: Drivers in Focus: Collaboration Tools.


Getting Started


Configure SharePoint Connectivity for Grafana

Connectivity to SharePoint from Grafana is made possible through CData Connect AI. To work with SharePoint data from Grafana, we start by creating and configuring a SharePoint connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "SharePoint" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to SharePoint.

    Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

    The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

    If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

    πŸ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add SharePoint Connection page and update the User-based permissions. πŸ‘ Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. πŸ‘ Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to SharePoint data from Grafana.

Visualize Live SharePoint Data in Grafana

To establish a connection from Grafana to the CData Connect AI Virtual SQL Server API, follow these steps.

  1. If you have not already done so, download and install Grafana for your operating system from the Grafana Website. Once installed, access Grafana at http://localhost:3000/.
  2. Log in to Grafana with your username and password for Grafana. If this is your first time logging in, the username is admin and the password is admin.
  3. On the navigation menu, click Sources > Add new connection. On this page, you can search for Microsoft SQL Server and select it as your data source. πŸ‘ Adding a new Connection in Grafana
  4. Select Microsoft SQL Server and click Add new data source. πŸ‘ Adding a new Connection in Grafana
  5. Enter a name for the new data source and then enter the following connection settings:
  6. Click Save & Test. A Database Connect OK message appears when you have a successful connection established.

Create a Dashboard

Once you create the data source for SharePoint, you can start building dashboards on SharePoint data. Start in the navigation menu and click Dashboards

  1. On the Dashboards page, click + Create dashboard, then click + Add visualization.
  2. This opens the Select data source window where you can select your created connection. πŸ‘ Select your connection. (Salesforce shown)
  3. After selecting your connection, you can choose the tables and columns that you want to query for your visualization. Then press Run Query to run the generated query. πŸ‘ Select the tables and columns you want to query. (Salesforce shown)
  4. After running your query, the resulting data is populated above the query editor. Here you can select the visualization that you want to use to present your data on the dashboard panel. πŸ‘ Visualize your queried data. (Salesforce shown)
  5. When you have finished editing your panel, you can click Save dashboard to save the changes made to your Dashboard.

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!