Import Real-Time Linear 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 ODBC Driver for Linear, you can link your ColdFusion web and mobile applications to operational Linear 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 Linear data from within a ColdFusion markup file.
To follow along with this tutorial, you need to install the CData ODBC Driver for Linear 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.
You can authenticate to Linear with a personal API key or with OAuth 2.0. The API key is the simplest option for connecting with your own Linear account.
Authenticating with an API Key
Set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: A Linear personal API key.
To create a personal API key, log in to Linear, open Settings > Security & access > Personal API keys, select New API key, and create it. Copy the key immediately, because Linear shows it only once.
Authenticating with OAuth
OAuth requires a custom OAuth application registered in Linear (Settings > API > OAuth applications), which provides the OAuthClientId and OAuthClientSecret. Two flows are supported:
- Authorization code: Set AuthScheme to OAuth, InitiateOAuth to GETANDREFRESH, and provide OAuthClientId, OAuthClientSecret, and the CallbackURL defined in your application (e.g., http://localhost:33333). The driver opens Linear in your browser so you can grant access.
- Client credentials: Set AuthScheme to OAuthClient and provide OAuthClientId and OAuthClientSecret. This authenticates the application itself, with no browser interaction, and suits machine-to-machine integrations.
By default, the driver requests the read,write scopes. The driver refreshes the access token automatically when it expires.
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 Linear 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 Linear 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 CDataLinearODBC 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="LinearQuery" dataSource="CDataLinearODBC"> SELECT * FROM Team </cfquery>And a CFTable can be used to quickly output the table in HTML:<cftable query = "LinearQuery" 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 | Linear Team Table Demo </title></head> <body> <cfoutput>#ucase("Linear Team Table Demo")#</cfoutput> <cfquery name="LinearQuery" dataSource="CDataLinearODBC"> SELECT * FROM Team </cfquery> <cftable query = "LinearQuery" 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 Linear 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 Linear and start building Linear-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.