Import Real-Time Webex Data via JDBC in ColdFusion to Build Applications

Dibyendu Datta
Lead Technology Evangelist

Use CData JDBC drivers to import and use Webex 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 API Driver for JDBC, you can link your ColdFusion web and mobile applications to operational Webex data. This allows for your applications to be more robust and complete. This article details how to use the JDBC driver to create a table populated with Webex data from within a ColdFusion markup file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Webex data. When you issue complex SQL queries to Webex, the driver pushes supported SQL operations, like filters and aggregations, directly to Webex and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Webex data using native data types.

Configuring the Connection to Webex

You will need a JDBC connection string to establish a connection between Coldfusion and Webex.

To authenticate to Webex, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with Webex. To do so, navigate to the Webex Developer Portal and create a new integration. Your OAuth application will be assigned a client id and a client secret.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to the client_id that is specified in your app settings.
OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
CallbackURL: Set this to the Redirect URI that is specified in your app settings.
Scope: Set this in ProfileSettings to specify the OAuth scopes requested during authorization. Multiple scopes can be space-separated (e.g. ProfileSettings='Scope=spark:all spark:kms').

Example connection string:

Profile=C:\profiles\Webex.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;ProfileSettings='Scope=your_scopes';

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Webex JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Using the built-in connection string designer to generate a JDBC URL (webex is shown.)

Adding a Data Source and Creating a Table

After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with Webex data and display it in a table written in the ColdFusion Markup Language, or CFML:

Copy the JDBC Driver for Webex and lic file from "C:\Program Files\CData[product_name]\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".
```
            cdata.jdbc.api.jar
            cdata.jdbc.api.lic
        
```
Note: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.
From the ColdFusion administrator interface, choose Data & Services.
Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button.
Next, populate the driver properties.
- JDBC URL will need to be in the format: jdbc:api:|connectionString|.
- A typical connection string looks like this:
  
  jdbc:api:Profile=C:\profiles\Webex.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;ProfileSettings='Scope=your_scopes';
- The Driver Class is: cdata.jdbc.api.APIDriver
- The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
Now, test the connection by clicking the check mark to the left of the CDataWebexJDBC 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="WebexQuery" dataSource="CDataWebexJDBC"> 
          SELECT * FROM AdminAuditEvents 
        </cfquery>

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

            
          <cftable  
          query = "WebexQuery" 
          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 | Webex AdminAuditEvents Table Demo </title></head> 
        <body> 
        <cfoutput>#ucase("Webex AdminAuditEvents Table Demo")#</cfoutput> 
        <cfquery name="WebexQuery" dataSource="CDataWebexJDBC"> 

          SELECT * FROM AdminAuditEvents 

        </cfquery> 
        <cftable  
          query = "WebexQuery" 
          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>

Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Webex data!

As a note, the CData JDBC 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 JDBC Driver for Webex and start building Webex-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Webex with the API Driver

Connect to Webex

CData is the data layer that makes AI work in production—live connectivity and replication across hundreds of the most critical enterprise sources, semantic context, and built-in governance. Powering AI for Databricks, Microsoft, Google, Palantir, and 10,000+ customers worldwide.