Connect to Miro Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Miro into your processes in RapidMiner. This article uses the CData JDBC Driver for Miro to transfer Miro data to a process in RapidMiner.

Connect to Miro in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Miro:

1. Add a new database driver for Miro: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   jdbc:api:
   

4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   cdata.jdbc.api.APIDriver
   

   👁 The JDBC driver configuration. (Salesforce is shown.)
   
6. Create a new Miro connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Miro driver you configured previously.
9. Enter your connection string in the Host box.

   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.

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

   A typical connection string is below:

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

10. Enter your username and password if necessary. 👁 The connection to the JDBC data source. (Salesforce is shown.)
    

You can now use your Miro connection with the various RapidMiner operators in your process. To retrieve Miro data, drag the Retrieve operator from the Operators view. 👁 A Retrieve operation to select data. (Salesforce is shown.)
With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Miro data.