Connect to ServiceDesk Plus Data in RapidMiner

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Integrate ServiceDesk Plus data with standard components and data source configuration wizards in RapidMiner Studio.

This article shows how you can easily integrate the CData JDBC driver for ServiceDesk Plus into your processes in RapidMiner. This article uses the CData JDBC Driver for ServiceDesk Plus to transfer ServiceDesk Plus data to a process in RapidMiner.

Connect to ServiceDesk Plus in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to ServiceDesk Plus:

  1. Add a new database driver for ServiceDesk Plus: Click Connections -> Manage Database Drivers.
  2. In the resulting wizard, click the Add button and enter a name for the connection.
  3. Enter the prefix for the JDBC URL:
    jdbc:api:
    
  4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
  5. Enter the driver class:
    cdata.jdbc.api.APIDriver
    
  6. Create a new ServiceDesk Plus connection: Click Connections -> Manage Database Connections.
  7. Enter a name for your connection.
  8. For Database System, select the ServiceDesk Plus driver you configured previously.
  9. Enter your connection string in the Host box.

    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 connection string is below:

    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;
    
  10. Enter your username and password if necessary.

You can now use your ServiceDesk Plus connection with the various RapidMiner operators in your process. To retrieve ServiceDesk Plus data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the ServiceDesk Plus data.

Ready to get started?

Connect to live data from ServiceDesk Plus with the API Driver

Connect to ServiceDesk Plus