Import Real-Time ServiceDesk Plus Data via ODBC in ColdFusion to Build Applications

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST. When ColdFusion is paired with the CData API Driver for ODBC, you can link your ColdFusion web and mobile applications to operational ServiceDesk Plus data. This allows for your applications to be more robust and complete. This article details how to use the ODBC driver to create a table populated with ServiceDesk Plus data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData API Driver for ODBC and Adobe ColdFusion.

Configuring the Connection

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 process. 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;

Adding a Data Source and Creating a Table

After creating a DSN, follow the steps below to add a new data source, test our connection to it, create a ColdFusion markup file, and, finally, import ServiceDesk Plus Data and display it in a table in ColdFusion:

1. From the ColdFusion administrator interface, choose Data & Services. 👁 Selecting Data & Services
   
2. Here, click "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our ODBC driver, choose "ODBC Socket", then click the "Add" button. 👁 Adding Data Source Name
   
3. From the ODBC DSN Dropdown menu select CData ServiceDesk Plus Sys. Under the Advanced Settings section, leave the Connection String blank. Note that any properties specified in this input field will override the ones specified in the DSN Configuration. 👁 Populating driver properties
   
4. Now, test the connection by pressing the check mark to the left of the CDataServiceDesk PlusODBC data source you just created. When the data source reports an "OK" status, it is ready for use. 👁 Testing the connection
   
5. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

   The following code queries the data source:

    
    <cfquery name="ServiceDesk PlusQuery" dataSource="CDataServiceDesk PlusODBC"> 
    SELECT * FROM AnnouncementComments 
    </cfquery> 
    

   And a CFTable can be used to quickly output the table in HTML:

    
    <cftable 
    query = "ServiceDesk PlusQuery" 
    border = "1" 
    colHeaders 
    colSpacing = "2" 
    headerLines = "2" 
    HTMLTable 
    maxRows = "500" 
    startRow = "1"> 
   
    <cfcol header="<b></b>" align="Left" width=2 text=""/> 
   
    <cfcol header="<b></b>" align="Left" width=15 text=""/> 
   
    ...
   
    </cftable> 
    

   Full code, including the HTML portion is available below:

    
    <html> 
    <head><title>CData Software | ServiceDesk Plus AnnouncementComments Table Demo </title></head> 
    <body> 
    <cfoutput>#ucase("ServiceDesk Plus AnnouncementComments Table Demo")#</cfoutput> 
    <cfquery name="ServiceDesk PlusQuery" dataSource="CDataServiceDesk PlusODBC"> 
   
    SELECT * FROM AnnouncementComments 
   
    </cfquery> 
    <cftable 
    query = "ServiceDesk PlusQuery" 
    border = "1" 
    colHeaders 
    colSpacing = "2" 
    headerLines = "2" 
    HTMLTable 
    maxRows = "500" 
    startRow = "1"> 
    <cfcol header="<b></b>" align="Left" width=2 text=""/> 
   
    <cfcol header="<b></b>" align="Left" width=15 text=""/> 
   
    ...
   
    </cftable> 
    </body> 
   
    </html> 
    

6. Finally, run the code in a browser. It produces a table populated with ServiceDesk Plus data! 👁 Running the code
   

As a note, the CData ODBC Drivers also support parameterized queries using the cfqueryparam element. For example:

SELECT * FROM Account WHERE name = 

Get Started Today

Download a free, 30-day trial of the CData ODBC Driver for ServiceDesk Plus and start building ServiceDesk Plus-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.