Visualize Live JSON Services in the Power BI Service

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to live JSON services and create custom reports in the Power BI Service through the On-Premises Gateway.

Power BI transforms your company's data into rich visuals for you to collect and organize so you can focus on what matters to you. When paired with CData Connect AI, you get instant access to JSON services for visualizations, dashboards, and more. This article shows how to build and publish a dataset from JSON services in Power BI and then create reports on JSON services in the Power BI service.

CData Connect AI provides a pure SQL interface for JSON, allowing you to easily build reports from live JSON services in Power BI — with no need to replicate the data. As you build visualizations, Power BI generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc) directly to JSON, leveraging server-side processing to quickly return JSON services.

NOTE: You can also import JSON services into Power BI through Connect AI (instead of using the on-premise gateway). Read how in the related Knowledge Base article.

Configure JSON Connectivity for Power BI

Connectivity to JSON from Power BI is made possible through CData Connect AI. To work with JSON services from Power BI, we start by creating and configuring a JSON connection.

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

    See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

    After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

    The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

    • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
    • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
    • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

    See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

    Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add JSON 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 JSON services from Power BI.

Connecting to Connect AI from Power BI

To connect to and visualize live JSON services in the Power BI service, install the on-premise data gateway, add a data source to the gateway from the Power BI service, and publish a dataset from Power BI Desktop to the service.

Install the On-Premises Data Gateway

The Microsoft on-premise data gateway provides secure data transfer between connected data sources and various cloud-based Microsoft tools and platforms. You can read more about the gateway in the Microsoft documentation.

You can download and install the gateway from the Power BI service:

  1. Log in to PowerBI.com.
  2. Click the Download menu and click Data Gateway. Download the Data Gateway
  3. Follow the instructions for installation, making note of the name of the gateway.

Add JSON as a Data Source to the Power BI Service

Once you have installed the data gateway, you add Connect AI as a data source to the Power BI service:

  1. Log in to PowerBI.com.
  2. Click the Settings menu and click "Manage gateways." Settings ->
  3. Click "ADD DATA SOURCE" and configure the connection to Connect AI:

    • Set Data Source Name to something like ConnectCloudJSON.
    • Choose SQL Server as the Data Source Type.
    • Set Server to tds.cdata.com,14333.
    • Set Database to the name of your JSON connection (e.g. JSON1).
    • Set Authentication Method to Basic.
    • Set Username to a Connect AI user (e.g. [email protected])
    • Set Password to the PAT for the user above.

Publish a Dataset from Power BI Desktop

With the gateway installed and Connect AI added as a datasource to the Power BI service, you can publish a dataset from Power BI Desktop to the service.

  1. Open Power BI, click Get Data -> More, then select SQL Server database, and click Connect.
  2. Create a new connection in Power BI
  3. Set the connection properties and click OK.
    • Set Server to tds.cdata.com,14333.
    • Set Database to the name of your JSON connection (e.g. JSON1).
    • Set Data Connectivity mode to DirectQuery*.
    Connect to CData Connect AI instance * DirectQuery enables live query processing and real-time visualizations of JSON services.
  4. In the authentication wizard, select Database, set the User name and Password properties, and click Connect.
  5. Authenticate the connection
  6. Select the table(s) to visualize in the Navigator dialog.
  7. In the Query Editor, you can customize your dataset by filtering, sorting, and summarizing JSON columns. Click Edit to open the query editor. Right-click a raw to filter the rows. Right-click a column header to perform options like the following:
    • Change column data types
    • Remove a column
    • Group by columns

    Power BI detects each column's data type from the JSON metadata reported by Connect AI.

    Power BI records your modifications to the query in the Applied Steps section, adjusting the underlying data retrieval query that is executed to the remote JSON services. When you click Close and Apply, Power BI executes the data Retrieval query.

    Otherwise, click Load to pull the data into Power BI.

  8. Define any relationships between the selected entities on the Relationships tab.
  9. Click Publish (from the Home menu) and select a Workspace.

Build Reports and Dashboards on JSON Services in the Power BI Service

Now that you have published a dataset to the Power BI service, you can create new reports and dashboards based on the published data:

  1. Log in to PowerBI.com.
  2. Click Workspaces and select a workspace.
  3. Click Create and select Report.
  4. Select the published dataset for the report. Select a dataset
  5. Choose fields and visualizations to add to your report. Visualizing JSON services in the Power BI service

Live Access to JSON Services from Cloud Applications

Now you have a direct connection to live JSON services from the Power BI service. You can create more data sources and new visualizations, build reports, and more — all without replicating JSON services.

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, sign up for a free trial of CData Connect AI.

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial