Learn more
 

Ready to get started?

Download a free trial of the Kintone ODBC Driver to get started:

 Download Now

Learn more:

Kintone Icon Kintone ODBC Driver

The Kintone ODBC Driver is a powerful tool that allows you to connect with live Kintone applications, directly from any applications that support ODBC connectivity.

Access Kintone applications and databases from virtually anywhere through a standard ODBC Driver interface.

In this article

Related articles

Import Real-Time Kintone Data in ColdFusion to Build Applications


Use CData ODBC drivers to import and use Kintone data in ColdFusion.

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 Kintone, you can link your ColdFusion web and mobile applications to operational Kintone 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 Kintone data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData ODBC Driver for Kintone 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.

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

  • Url: The URL of your account.
  • GuestSpaceId: Optional. Set this when using a guest space.

Authenticating with Kintone

Kintone supports the following authentication methods.

Using Password Authentication

You must set the following to authenticate:

  • User: The username of your account.
  • Password: The password of your account.

Using Basic Authentication

If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

Using Client SSL

Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

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 Kintone Kintone data and display it in a table in ColdFusion:

  1. From the ColdFusion administrator interface, choose 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.
  3. From the ODBC DSN Dropdown menu select CData Kintone 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.
  4. Now, test the connection by pressing the check mark to the left of the CDataKintoneODBC data source you just created. When the data source reports an "OK" status, it is ready for use.
  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="KintoneQuery" dataSource="CDataKintoneODBC"> 
          SELECT * FROM Comments 
        </cfquery>
    And a CFTable can be used to quickly output the table in HTML: 
                
          <cftable  
          query = "KintoneQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 

          <cfcol header="<b>CreatorName</b>" align="Left" width=2 text="CreatorName"/> 

          <cfcol header="<b>Text</b>" align="Left" width=15 text="Text"/> 

          ...

        </cftable>
    Full code, including the HTML portion is available below: 
                
        <html> 
        <head><title>CData Software | Kintone Comments Table Demo </title></head> 
        <body> 
        <cfoutput>#ucase("Kintone Comments Table Demo")#</cfoutput> 
        <cfquery name="KintoneQuery" dataSource="CDataKintoneODBC"> 

          SELECT * FROM Comments 

        </cfquery> 
        <cftable  
          query = "KintoneQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 
          <cfcol header="<b>CreatorName</b>" align="Left" width=2 text="CreatorName"/> 

          <cfcol header="<b>Text</b>" align="Left" width=15 text="Text"/> 

          ...

        </cftable> 
        </body> 

        </html>
  6. Finally, run the code in a browser. It produces a table populated with Kintone 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 Kintone and start building Kintone-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.