How to connect to Talkdesk Data in DBVisualizer
The CData JDBC Driver for Talkdesk implements JDBC standards to provide connectivity to Talkdesk data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Talkdesk data in DBVisualizer and use the table editor to load Talkdesk data.
Create a New Driver Definition for Talkdesk Data
Follow the steps below to use the Driver Manager to provide connectivity to Talkdesk 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 Talkdesk Driver")
- Set URL Format to jdbc:talkdesk:
- 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 JDBC Driver for Talkdesk XXXX\)
- Select the JAR file (cdata.jdbc.Talkdesk.jar) and click "Open"
- The Driver Class should populate automatically. If not, select class (cdata.jdbc.talkdesk.TalkdeskDriver).
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:talkdesk: followed by the connection properties in a semicolon-separated list of name-value pairs.
Talkdesk uses the OAuth 2.0 Client Credentials grant. There is no browser-based authorization step and no callback URL.
Set the following connection properties:
- AccountName: The name of your Talkdesk account.
- Region: The region where your Talkdesk instance is deployed. Supported values are US (default), EU, CA, AU, UK, and FedRamp.
- OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret: The Client Secret assigned to your custom OAuth application.
Creating a Custom OAuth Application
- Log in to your Talkdesk account and select OAuth Clients from the navigation menu.
- Click Create OAuth Client and give the client a descriptive name.
- Set Grant Type to Client Credentials.
- Click Add scopes and select the scopes for the data you want to access.
- Click Create and copy the Client Id and Client Secret.
When you connect, the driver automatically requests an access token from Talkdesk, caches it, and refreshes it when it expires. Make sure the scopes selected for the application match the views you plan to query, or the token request can fail.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Talkdesk JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.talkdesk.jarFill 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:talkdesk:AccountName=myAccount;Region=US;OAuthClientId=myClientId;OAuthClientSecret=myClientSecret;- NOTE: Since Talkdesk 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 Talkdesk 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.