Query Miro Data in ColdFusion

The CData JDBC driver for Miro seamlessly integrates connectivity to Miro data with the rapid development tools in ColdFusion. This article shows how to connect to Miro data in ColdFusion and query Miro tables.

Create a JDBC Data Source for Miro in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:api: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     Using API Key Authentication

     Miro uses API Key authentication with an access token. To generate an access token:

     1. Log in to your Miro account
     2. Navigate to Settings > Your apps
     3. Click "Create new app" or select an existing app
     4. Configure the required permissions (e.g., boards:read, teams:read)
     5. Install the app and generate an access token
     6. Copy the generated access token (it will only be shown once)

     After obtaining your access token, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your access token.

     Connecting to Miro

     Once the authentication is configured, you can connect to Miro and query data from any of the available tables such as Boards, Items, Teams, Organizations, and more.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.api.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     

     A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.api.APIDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Miro data source in the Actions column. After reporting a status of OK, the Miro data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Miro. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="APIQuery" dataSource="CDataAPI">
  SELECT * FROM Boards WHERE BoardId = <cfqueryparam value="#BoardId#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#APIQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
  "SELECT * FROM Boards WHERE BoardId = ?", 
  [
    { value="3074457361234567890", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAPI" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?BoardId=3074457361234567890