Integrate Azure Synapse Data in the Pentaho Report Designer

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

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

     Connecting to Azure Synapse

     In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

     • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
     • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

     Authenticating to Azure Synapse

     Connect to Azure Synapse using the following properties:

     • User: The username provided for authentication with Azure.
     • Password: The password associated with the authenticating user.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.azuresynapse.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:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;

   • Custom Driver Class Name: Enter cdata.jdbc.azuresynapse.AzureSynapseDriver.
   • 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 Azure Synapse Data to a Report

You are now ready to create a report with Azure Synapse data.

1. Add the Azure Synapse 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 Id, ProductName FROM Products WHERE ProductName = 'Konbu'

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