Design BIRT Reports on Talkdesk Data

The CData JDBC Driver for Talkdesk integrates connectivity to Talkdesk APIs into your data-driven Java applications. You can use the CData JDBC Driver for Talkdesk with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
2. Click File -> New -> Report. The Report Design perspective is opened.
3. In the Data Explorer, right-click Data Sources and click New Data Source.
4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
6. In the Database URL box, enter the JDBC URL containing the connection string.

   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

   1. Log in to your Talkdesk account and select OAuth Clients from the navigation menu.
   2. Click Create OAuth Client and give the client a descriptive name.
   3. Set Grant Type to Client Credentials.
   4. Click Add scopes and select the scopes for the data you want to access.
   5. 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.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 JDBC URL is below:

   
   jdbc:talkdesk:AccountName=myAccount;Region=US;OAuthClientId=myClientId;OAuthClientSecret=myClientSecret;
   

7. Right-click the Data Sets folder and select the JDBC data source for Talkdesk.
8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query:

   
   SELECT Id, Name FROM Users WHERE Active = 'true'
   

9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Talkdesk data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.