Create JSON-Connected Visualizations in Klipfolio
Klipfolio is an online dashboard platform designed to create real-time business dashboards, whether for your team or clients. When combined with CData Connect AI, you gain immediate cloud-to-cloud access to JSON services to create visualizations, reports, and more. This article provides step-by-step instructions on connecting to JSON within Connect AI and creating visualizations using JSON services in Klipfolio.
CData Connect AI offers a direct cloud-to-cloud interface for JSON, enabling you to construct reports from real-time JSON services data within Klipfolio—without the need for data replication to a database natively supported by Klipfolio. While building visualizations, Klipfolio generates SQL queries to fetch data. With optimized data processing capabilities out of the box, CData Connect AI efficiently directs all supported SQL operations (such as filters, JOINs, etc.) directly to JSON, harnessing server-side processing to swiftly retrieve the requested JSON services data.
Configure JSON Connectivity for Klipfolio
Connectivity to JSON from Klipfolio is made possible through CData Connect AI. To work with JSON services from Klipfolio, we start by creating and configuring a JSON connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "JSON" from the Add Connection panel
-
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.
- Click Save & Test
-
Navigate to the Permissions tab in the Add JSON Connection page and update the User-based 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.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- 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 Klipfolio.
Connect to JSON from Klipfolio
The steps below outline connecting to CData Connect AI from Klipfolio to create a new JSON data source.
- Open Klipfolio
- Click in Data Sources to add a new data source
- Search for and select MSSQL as the Service
- Click "Create a custom MSSQL data source"
- Configure the data source by setting the MSSQL connection properties:
- Host: tds.cdata.com
- Port: 14333
- Database: your database (e.g., JSON1)
- Driver: MS SQL
- Username: a Connect AI user (e.g. [email protected])
- Password: the above user's PAT
- SQL Query: any query to retrieve data (e.g. SELECT * FROM people )
- Select the checkbox to "Include column headers"
- Select the checkbox to "Use SSL/TLS"
- Click "Get data" to preview the JSON services before building a data model.
Build a Data Model
After retrieving the data, click the checkbox to "Model your data" and click "Continue." In the new window, configure your data model.
- Confirm that the model includes all columns you wish to work with
- Name your model
- (optional) Set the Description
- Set "Header in row" to 1
- Click the toggle to "Exclude data before row" and set the value to 2
- Click "Save and Exit"
Create a Metric
With the data modeled, we are ready to create a Metric (or visualization) of the data to be used in the Klipfolio platform for dashboards, reporting, and more.
- Click "Create metrics"
- Select a Data source
- Select a Metric value and default aggregation
- Select Segmentation(s)
- Select a Date & time
- Select a Data shape
- Configure the Display settings
- Click Save
- Navigate to your Metric and further configure the visualization
SQL Access to JSON Services from Cloud Applications
Now you have a Metric built from live JSON services. You can add it to a new dashboard, share, and more. Easily create more data sources and new visualizations, produce reports, and more — all without replicating JSON services.
To get SQL data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI.