Build Dashboards with ServiceDesk Plus Data in DBxtra
The CData ODBC driver for ServiceDesk Plus enables access to live data from ServiceDesk Plus under the ODBC standard, allowing you work with ServiceDesk Plus data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to ServiceDesk Plus data as a generic ODBC Data Provider and create charts, reports, and dashboards based on ServiceDesk Plus data in DBxtra.
Connect to ServiceDesk Plus Data
- If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
Using OAuth Authentication
ServiceDeskPlus uses Zoho OAuth 2.0 for secure authentication. To set up OAuth access:
- Register your application in the Zoho Developer Console at https://api-console.zoho.com
- Configure your redirect URI to match your application setup
- 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;
When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
- Open the DBxtra application and in the New menu click Project and name the Project.

- Select ODBC Connection as the Data Connection Type.

- Click the browse option () for the Data Source.
- In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab.

- On the Connection tab, select the Data Source Name and the initial catalog to use (CData).

- Name the Connection and select the appropriate User Groups.

- Double-click the Connection from within the Project to connect to the data.

Create a Dashboard with ServiceDesk Plus Data
You are now ready to create a dashboard with ServiceDesk Plus data.
- Right-click Report Objects under the Project and select New Report Object.

- In the new Report Object, click the link to create the Query.
- In the Select Data Connection window, select the newly created data connection.

- On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations.

- On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.)

With a new Dashboard created, you are ready to begin analysis of ServiceDesk Plus data. Thanks to the ODBC Driver for ServiceDesk Plus, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date ServiceDesk Plus data.