Connect ServiceDesk Plus to IBM WebSphere Using the CData JDBC Driver

IBM WebSphere is a powerful application server that runs many enterprise level Java applications and services. When paired with the CData API Driver for JDBC, IBM WebSphere applications can connect to ServiceDesk Plus and work with data using standard SQL queries instead of complex APIs. This simplifies integration, reduces development effort, and provides secure, real-time access to critical business data.

Prerequisites

1. Access to a ServiceDesk Plus account (with API permissions)
2. IBM WebSphere Application Server (configured and running)
3. CData API Driver for JDBC
4. Java Servlet WAR application ready for deployment

Note: This article uses Salesforce as a demonstration data source, but the same steps can be followed to connect to any of the 250+ JDBC Drivers available in our portfolio.

Getting Started

Step 1: Download and install the CData API Driver for JDBC

Download and install the CData API Driver for JDBC, which provides a .jar file: cdata.jdbc.api.jar

Step 2: Install and configure IBM Websphere

1. Create an account in IBM WebSphere using the official IBM site.
2. Install and configure the IBM Websphere Application server in the local system using the documentation: IBM Websphere Application Server
3. Once the application server is installed, start the WebSphere Server using the Admin Console in your browser: https://your-server:9043/ibm/console

Step 3: Set up the JDBC provider and data source for ServiceDesk Plus

1. Go to Resources, expand the JDBC section, and then select JDBC providers to create a new provider

2. Select the appropriate scope from the drop down menu

3. Click New to add a JDBC provider
• Choose User defined as the database type
• Enter cdata.jdbc.api.APIConnectionPoolDataSource as the implementation class name
• Type a name for the provider, for example User defined JDBC Provider
• Enter the full path of the JDBC driver JAR file in the classpath field
• Click Next, then Finish, and save the changes to the master configuration.

4. Once the JDBC provider is created, add a JDBC data source.
• Enter the basic details such as Data Source Name and JNDI name
• Select the existing JDBC provider created earlier (e.g., CData ServiceDesk Plus Provider)
• Provide the Implementation class name: cdata.jdbc.api.APIConnectionPoolDataSource
• Add the Data Store Helper Class Name: com.ibm.websphere.rsadapter.GenericDataStoreHelper
• Configure security by setting authentication aliases if required
• Review the Summary page to verify all details and click Finish to complete the data source creation

5. Select the newly created data source from the list and open Custom properties
6. Add the JDBC connection string under the URL property and press OK. For example:

   jdbc:api:RTK=5246...;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 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.

   

   Note: If the URL property is not available, create it and then add the JDBC connection string.

   Tip: Always test the connection string with the driver before entering it in the URL property.
7. Now open the data source and choose Test Connection

Step 4: Build the web application

1. Build the web application using preferred Java framework (Servlet, JSP, or Spring). The resulting .war file will typically follow a structure like this:

		ServiceDesk PlusServletApp.war
		|--webcontent
		|  |--index.jsp                 -- JSP page (entry point)
		|  |
		|  |--WEB-INF/                  --Hidden from direct browser access
		|     |--web.xml                 -- Deployment descriptor
		|     |
		|     |--classes/                  --Compiled .class files
		|       |--com/example/ServiceDesk Plus/
		|          |--ServiceDesk PlusServlet.class
		|
		|--lib/                      --Dependency JARs
		|--cdata.jdbc.servicedeskplus.jar
	

2. Define the data access logic using JDBC or JPA, referencing the data source through a JNDI name
3. This article explains how to set up a JDBC connection and deploy a Java Servlet application
4. Package the project as a WAR (Web Application Archive) or EAR (Enterprise Archive) file for deployment
• In a terminal compile the java file using the command:

  			cd webcontent
  			jar cvf ..\ServiceDesk PlusServletApp.war *
  		

Step 5: Deploy the ServiceDesk Plus application in WebSphere

1. In the WebSphere admin console, go to Applications and select Install New Application
2. Browse and upload the WAR file, then continue with the installation wizard.

Step 6: Retrieve ServiceDesk Plus data through WebSphere

1. Access the application using its context root: http://hostname:port/context-root/page
Note: Ensure the deployed application is started before opening it in the browser.

We can now view the retrieved data from the source. The data is accessible directly through IBM WebSphere. This setup demonstrates how a servlet can be deployed in WebSphere to retrieve ServiceDesk Plus data using the JDBC driver, creating a strong foundation for building advanced ServiceDesk Plus powered enterprise applications.

Get Started with Connecting ServiceDesk Plus to IBM WebSphere

Start connecting ServiceDesk Plus to IBM WebSphere with the CData JDBC Connector today. Download the free 30-day trial and explore how easy it is to enable secure, real-time data access for your applications. As always, our world-class Support Team is available to help with any questions you may have.