Ready to get started?

Learn more about the CData JDBC Driver for Alfresco or download a free trial:

Download Now

Integrate Alfresco Data in the Pentaho Report Designer

Publish reports based on Alfresco data in the Pentaho BI tool.

The CData JDBC Driver for Alfresco data enables access to live data from dashboards and reports. This article shows how to connect to Alfresco data as a JDBC data source and publish reports based on Alfresco 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 Alfresco connection. In the resulting dialog, configure the connection properties as shown below.

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

      To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Alfresco JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.alfresco.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      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:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;
    • Custom Driver Class Name: Enter cdata.jdbc.alfresco.AlfrescoDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Alfresco Data to a Report

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

  1. Add the Alfresco 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 DBID, Column1 FROM Alfresco WHERE Column2 = MyFilter
  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 Alfresco table.
  4. Finally, run the report to see the chart.