Query ServiceDesk Plus Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live ServiceDesk Plus data. This article shows how to establish a connection to ServiceDesk Plus data in DataGrip.

Create a New Driver Definition for ServiceDesk Plus

The steps below describe how to create a new Data Source in DataGrip for ServiceDesk Plus.

1. In DataGrip, click File -> New > Project and name the project 👁 Creating a new DataGrip project.
   
2. In the Database Explorer, click the plus icon () and select Driver. 👁 Adding a new Driver.
   
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData ServiceDesk Plus Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
4. Click "Apply" then "OK" to save the Connection 👁 A configured Driver (Salesforce is shown).
   

Configure a Connection to ServiceDesk Plus

1. Once the connection is saved, click the plus (), then "Data Source" then "CData ServiceDesk Plus Driver" to create a new ServiceDesk Plus Data Source.
2. In the new window, configure the connection to ServiceDesk Plus with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the ServiceDesk Plus 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.

   Using OAuth Authentication

   ServiceDeskPlus uses Zoho OAuth 2.0 for secure authentication. To set up OAuth access:

   1. Register your application in the Zoho Developer Console at https://api-console.zoho.com
   2. Configure your redirect URI to match your application setup
   3. Note your Client ID and Client Secret from the application settings

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • OAuthClientId: Set this to your Zoho application Client ID.
   • OAuthClientSecret: Set this to your Zoho application Client Secret.
   • Scope: Set this to the required ServiceDeskPlus permissions (default includes read access to requests, problems, assets, and projects).
   • Domain: Set this to your ServiceDeskPlus domain
   • Portal: Set this to your ServiceDeskPlus portal

   Example Connection String

   Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
   

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   
3. Set URL to the connection string, e.g.,

   jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

4. Click "Apply" and "OK" to save the connection string 👁 A configured Data Source (Salesforce is shown).
   

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against ServiceDesk Plus

To browse through the ServiceDesk Plus entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT , FROM AnnouncementComments WHERE AnnouncementId = '12345'

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live ServiceDesk Plus data in DataGrip. Reach out to our Support Team if you have any questions.