Connect to Miro Data from PowerBuilder via JDBC

The CData JDBC driver for Miro is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for Miro in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Miro to retrieve data.

Connect to Miro Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Miro. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

   Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

2. Click Tools -> Database Painter.
3. Right-click the JDBC node and click New Profile.
4. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • Driver Name: Enter the class name of the driver, cdata.jdbc.api.APIDriver
   • URL: 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';

   👁 The JDBC data source defined in the Database Profile Setup dialog. (Salesforce is shown.)
   
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Miro Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve Miro data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC"
SQLCA.AutoCommit = False
SQLCA.DBParm = "Driver='cdata.jdbc.api.APIDriver',URL='jdbc:api:Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';";
CONNECT USING SQLCA;
dw_boards.SetTransObject(SQLCA);
dw_boards.Retrieve();