Connect to ServiceDesk Plus Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData API Driver for JDBC, HULFT Integrate can work with live ServiceDesk Plus data. This article explains how to connect to ServiceDesk Plus and move the data into a CSV file.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live ServiceDesk Plus data. When you issue complex SQL queries to ServiceDesk Plus, the driver pushes supported SQL operations, like filters and aggregations, directly to ServiceDesk Plus and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze ServiceDesk Plus data using native data types.

Enable Access to ServiceDesk Plus

To enable access to ServiceDesk Plus data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.api.jar (and cdata.jdbc.api.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to ServiceDesk Plus Data

Once you copy the JAR files, you can create a project with access to ServiceDesk Plus data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next 👁 Creating a new project.
   
4. Name the script (e.g.: APItoCSV)

Once you create the project, add components to the script to copy ServiceDesk Plus data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for ServiceDesk Plus. Set the following properties:
   • Name: ServiceDesk Plus Connection Settings
   • Driver class name: cdata.jdbc.api.APIDriver
   • URL: 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;
     
     👁 JDBC connection settings (Salesforce is shown).
     

     Built-in Connection String Designer

     For assistance 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.)
     
2. Write your SQL statement. For example:

   SELECT , FROM AnnouncementComments

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish" 👁 Configuring the Execute Select SQL operation
   

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. AnnouncementComments.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map ServiceDesk Plus Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move ServiceDesk Plus data into a CSV file.

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