Rapidly Develop ServiceDesk Plus-Driven Apps with Active Query Builder

Write standard .NET to expose ServiceDesk Plus data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for ServiceDesk Plus enables standards-based access to ServiceDesk Plus. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to ServiceDesk Plus as an ODBC Data Source

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;

Use SQL to Interact with ServiceDesk Plus

Follow the steps below to create a WinForms visual query builder.

1. Open Active Query Builder for .NET WinForms. 👁 Opening Active Query Builder.
   
2. In the new Windows Forms project go to the "File" menu and click "Connect..."
3. Under Database Connections, click "Add..." 👁 Adding a new Connection.
   
4. Set your desired Connection Name (e.g. CData ServiceDesk Plus), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown. 👁 Selecting a previously configured DSN (Amazon Athena is shown).
   
5. Click "OK" to save the new connection.
6. Back in the Database Connection wizard, select the newly created connection and click "OK." 👁 A newly added Connection (Amazon Athena is shown).
   
7. Click "File" > "New Query" to create a QueryBuilder

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.