Create REST-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 Cloud, you gain immediate cloud-to-cloud access to REST data to create visualizations, reports, and more. This article provides step-by-step instructions on connecting to REST within Connect Cloud and creating visualizations using REST data in Klipfolio.

CData Connect Cloud offers a direct cloud-to-cloud interface for REST, enabling you to construct reports from real-time REST data 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 Cloud efficiently directs all supported SQL operations (such as filters, JOINs, etc.) directly to REST, harnessing server-side processing to swiftly retrieve the requested REST data data.

Configure REST Connectivity for Klipfolio

Connectivity to REST from Klipfolio is made possible through CData Connect Cloud. To work with REST data from Klipfolio, we start by creating and configuring a REST connection.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "REST" from the Add Connection panel
3. Enter the necessary authentication properties to connect to REST.

   See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/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 Format to "XML" or "JSON" and 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 REST 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 REST 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.

   
4. Click Create & Test
5. Navigate to the Permissions tab in the Add REST Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
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, you are ready to connect to REST data Klipfolio.

Connect to REST from Klipfolio

The steps below outline connecting to CData Connect Cloud from Klipfolio to create a new REST data source.

1. Open Klipfolio
2. Click in Data Sources to add a new data source
3. Search for and select MSSQL as the Service
4. Click "Create a custom MSSQL data source"
5. Configure the data source by setting the MSSQL connection properties:
   • Host: tds.cdata.com
   • Port: 14333
   • Database: your database (e.g., REST1)
   • Driver: MS SQL
   • Username: a Connect Cloud 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"
   
6. Click "Get data" to preview the REST data 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.

1. Confirm that the model includes all columns you wish to work with
2. Name your model
3. (optional) Set the Description
4. Set "Header in row" to 1
5. Click the toggle to "Exclude data before row" and set the value to 2
6. 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.

1. Click "Create metrics"
2. Select a Data source
3. Select a Metric value and default aggregation
4. Select Segmentation(s)
5. Select a Date & time
6. Select a Data shape
7. Configure the Display settings
8. Click Save
9. Navigate to your Metric and further configure the visualization

SQL Access to REST Data from Cloud Applications

Now you have a Metric built from live REST data. 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 REST data.

To get SQL data access to 100+ SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect Cloud.