Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to connect to Clio Data in DBVisualizer
Integrate Clio data with visual data analysis tools and data connection wizards in DBVisualizer
The CData API Driver for JDBC implements JDBC standards to provide connectivity to Clio data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Clio data in DBVisualizer and use the table editor to load Clio data.
Create a New Driver Definition for Clio Data
Follow the steps below to use the Driver Manager to provide connectivity to Clio data from DBVisualizer tools.
- In DBVisualizer, click Tools -> Driver Manager.
- Click the plus sign "" to create a new driver.
- Select "Custom" as the template.
- On the Driver Settings tab:
- Set Name to a user-friendly name (e.g. "CData Clio Driver")
- Set URL Format to jdbc:api:
- In Driver artifacts and jar files (jars are loaded in order from top):
- Click the plus sign "" -> "Add Files"
- Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
- Select the JAR file (cdata.jdbc.API.jar) and click "Open"
- The Driver Class should populate automatically. If not, select class (cdata.jdbc.api.APIDriver).
Define the Connection to the JDBC Data Source
Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.
- In the "Databases" tab, click the plus sign "" and select the driver you just created.
In the "Connection" section, set the following options:
- Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
- Driver Type: Select the driver you just created.
Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:api: followed by the connection properties in a semicolon-separated list of name-value pairs.
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.
A typical connection string is below:
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;
- NOTE: Since Clio does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
- On the Connection tab, click Connect.
To browse through tables exposed by the Clio JDBC Driver, right-click a table and click "Open in New Tab."
To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.
See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.