Integrate Vimeo Data in the Pentaho Report Designer

The CData JDBC driver for Vimeo data enables access to live data from dashboards and reports. This article shows how to connect to Vimeo data as a JDBC data source and publish reports based on Vimeo 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 Vimeo 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.

     Vimeo is a professional video hosting platform. The Vimeo API uses personal access tokens (bearer tokens) to enable secure access to video metadata, user information, channels, groups, categories, and related resources.

     Using API Key Authentication

     To authenticate to the Vimeo API, you will need to provide a personal access token. To obtain your access token:

     1. Log in to your Vimeo account at https://vimeo.com
     2. Navigate to https://developer.vimeo.com/apps
     3. Create a new app or select an existing app
     4. Under "Personal Access Tokens", click "Generate" to create a new token
     5. Select the required scopes: public and private for read access
     6. Copy the generated token

     After obtaining your access token, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Vimeo personal access token.

     Example connection string

     Profile=C:\profiles\Vimeo.apip;ProfileSettings='APIKey=your_personal_access_token';
     

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Vimeo 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\Vimeo.apip;ProfileSettings='APIKey=your_personal_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 Vimeo Data to a Report

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

1. Add the Vimeo 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 Videos WHERE UserUri = '/users/12345678'

   👁 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 Videos table.
4. Finally, run the report to see the chart.