Connect to Miro Data in CloverDX (formerly CloverETL)

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Transfer Miro data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Miro enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Miro as sources. In this article, you will use the JDBC Driver for Miro to set up a simple transfer into a flat file. The CData JDBC Driver for Miro enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Miro as sources. In this article, you will use the JDBC Driver for Miro to set up a simple transfer into a flat file.

Connect to Miro as a JDBC Data Source

  1. Create the connection to Miro data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
  3. Enter the JDBC URL.

    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';

Query Miro Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Miro JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example:
    SELECT ,  FROM Boards WHERE BoardId = '3074457361234567890'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Boards table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.

Ready to get started?

Connect to live data from Miro with the API Driver

Connect to Miro