Integrate Vercel Data in the Pentaho Report Designer

The CData JDBC driver for Vercel data enables access to live data from dashboards and reports. This article shows how to connect to Vercel data as a JDBC data source and publish reports based on Vercel data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Vercel connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     Using API Key Authentication

     Vercel uses Bearer token authentication. You can use either a personal access token or an OAuth access token as the API key.

     To obtain a personal access token:

     1. Log into your Vercel account at https://vercel.com/
     2. Navigate to Account Settings > Tokens.
     3. Click Create Token, enter a name and expiration, and click Create.
     4. Copy the generated token (it will only be shown once).

     After obtaining your token, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Vercel personal access token or OAuth access token.

     Example Connection String

     Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
     

     Working with Teams

     Many Vercel resources are scoped to a team. To scope all requests to a specific team, set the TeamId connection property to your team's ID. You can find your team ID by querying the Teams table or from the Vercel dashboard. Alternatively, you can specify TeamId in your SQL queries using the WHERE clause where supported.

     Connecting to Vercel

     Once the authentication is configured, you can connect to Vercel and query data from any of the available tables such as Projects, Deployments, Teams, and Domains.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Vercel 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.)
     

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     Below is a typical JDBC URL:

     jdbc:api:Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;

   • Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.
   👁 Required connection properties defined in the JDBC URL. (Salesforce is shown.)
   

Add Vercel Data to a Report

You are now ready to create a report with Vercel data.

1. Add the Vercel source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

   SELECT , FROM User WHERE = ''

   👁 The query to retrieve data, specified in the JDBC data source configuration wizard. (Salesforce is shown.)
   
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the User table.
4. Finally, run the report to see the chart.