Viewing ServiceDesk Plus Data in RAD Studio Data Explorer

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for ServiceDesk Plus, you gain access to live ServiceDesk Plus data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve ServiceDesk Plus data. This article will walk through connecting to ServiceDesk Plus using the Data Explorer.

Configure a Connection to ServiceDesk Plus

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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;

Connecting to ServiceDesk Plus Data Using Data Explorer

You can create a simple application for displaying ServiceDesk Plus data by utilizing the CData FireDAC Components for ServiceDesk Plus and a new VCL Forms Application:

1. Open the Data Explorer in RAD Studio and expand FireDAC.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection. 👁 Adding a New Connection. (Salesforce is shown.)
   
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for ServiceDesk Plus. 👁 Setting the Connection Parameters. (Salesforce is shown.)
   
6. Back in the Data Explorer, expand the views for the connection.

7. Create a new VCL Forms application and drag a view (for example: AnnouncementComments) onto the form.

   👁 Placing the View on the Form. (Salesforce is shown.)
   
8. Select the AnnouncementCommentsView object on the form and set the Active property to true.

9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

   👁 Visually Binding the View. (Salesforce is shown.)
   

10. Arrange the TStringGrid on the form and run the application to see the AnnouncementComments data.

    👁 The View data on a Form. (Salesforce is shown.)
    

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to ServiceDesk Plus Data in C++Builder
• DataBind Controls to ServiceDesk Plus Data in Delphi
• Build a Simple VCL Application for ServiceDesk Plus Data