Connect to ServiceDesk Plus Data in RazorSQL

The CData JDBC Driver for ServiceDesk Plus enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to ServiceDesk Plus using wizards in RazorSQL.

Create a JDBC Data Source for ServiceDesk Plus Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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;
     

     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.

     

     A typical JDBC URL is the following:

     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;

Query ServiceDesk Plus Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.