Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Integrate Clio Data in the Pentaho Report Designer
Publish reports based on Clio data in the Pentaho BI tool.
The CData JDBC driver for Clio data enables access to live data from dashboards and reports. This article shows how to connect to Clio data as a JDBC data source and publish reports based on Clio data in Pentaho.
Connect and Create a Report
- Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
- Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Clio connection. In the resulting dialog, configure the connection properties as shown below.
Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.
Start by setting the Profile connection property to the location of the Clio Profile on disk (e.g. C:\profiles\Clio.apip). Next, set the ProfileSettings connection property to the connection string for Clio (see below).
Clio API Profile Settings
Clio uses OAuth-based authentication.
First, register an OAuth application with Clio. You can do so by logging to your Developer Account and clicking the Add button. Enter details and select the scope of your application here - these details will be shown to Clio users when they're asked to authorize your application. Your Oauth application will be assigned a client id (key) and a client secret (secret). Additionally you will need to set the Region in ProfileSettings connection property.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to OAuth.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
- OAuthClientId: Set this to the client_id that is specified in you app settings.
- OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
- CallbackURL: Set this to the Redirect URI that is specified in your app settings.
- Region: Set this in ProfileSettings to your Clio geographic region. Defaults to app.clio.com.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Clio JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.api.jar
Fill in the connection properties and copy the connection string to the clipboard.
When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
Below is a typical JDBC URL:
jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
- Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
- User Name: The username to authenticate with.
- Password: The password to authenticate with.
Add Clio Data to a Report
You are now ready to create a report with Clio data.
-
Add the Clio source to your report: Click Data -> Add Data Source -> JDBC and select the data source.
Configure the query. This article uses the one below:
SELECT Id, Total FROM Bills WHERE State = 'awaiting_payment'
- Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Bills table.
- Finally, run the report to see the chart.