Connect to Miro Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData API Driver for JDBC, HULFT Integrate can work with live Miro data. This article explains how to connect to Miro and move the data into a CSV file.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Miro data. When you issue complex SQL queries to Miro, the driver pushes supported SQL operations, like filters and aggregations, directly to Miro 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 Miro data using native data types.

Enable Access to Miro

To enable access to Miro data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.api.jar (and cdata.jdbc.api.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Miro Data

Once you copy the JAR files, you can create a project with access to Miro data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next
4. Name the script (e.g.: APItoCSV)

Once you create the project, add components to the script to copy Miro data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Miro. Set the following properties:
   • Name: Miro Connection Settings
   • Driver class name: cdata.jdbc.api.APIDriver
   • URL: jdbc:api:Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';
     
     

     Built-in Connection String Designer

     For assistance 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.

     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.

     
2. Write your SQL statement. For example:

   SELECT ,  FROM Boards

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. Boards.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map Miro Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Miro data into a CSV file.

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Miro data in HULFT Integrate. Reach out to our Support Team if you have any questions.