Import Real-Time Shortcut 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 Shortcut 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 Shortcut 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.
Start by setting the Profile connection property to the location of the Shortcut Profile on disk (e.g. C:\profiles\Shortcut.apip). Next, set the ProfileSettings connection property to the connection string for Shortcut (see below).
Shortcut API Profile Settings
Log into your Shortcut account, navigate to Settings > API Tokens, and click Generate Token.
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 Shortcut Data and display it in a table in ColdFusion:
-
From the ColdFusion administrator interface, choose Data & Services.
-
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.
-
From the ODBC DSN Dropdown menu select CData Shortcut 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.
-
Now, test the connection by pressing the check mark to the left of the CDataShortcutODBC data source you just created.
When the data source reports an "OK" status, it is ready for use.
-
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="ShortcutQuery" dataSource="CDataShortcutODBC"> SELECT * FROM Categories </cfquery>And a CFTable can be used to quickly output the table in HTML:<cftable query = "ShortcutQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"> <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> <cfcol header="<b>Name</b>" align="Left" width=15 text="Name"/> ... </cftable>Full code, including the HTML portion is available below:<html> <head><title>CData Software | Shortcut Categories Table Demo </title></head> <body> <cfoutput>#ucase("Shortcut Categories Table Demo")#</cfoutput> <cfquery name="ShortcutQuery" dataSource="CDataShortcutODBC"> SELECT * FROM Categories </cfquery> <cftable query = "ShortcutQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"> <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> <cfcol header="<b>Name</b>" align="Left" width=15 text="Name"/> ... </cftable> </body> </html> -
Finally, run the code in a browser. It produces a table populated with Shortcut data!
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 Shortcut and start building Shortcut-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.