Connect to Azure Data Lake Storage Data in Jaspersoft Studio

This article shows how to connect to Azure Data Lake Storage from Jaspersoft Studio as a standard JDBC data source with the CData JDBC Driver for Azure Data Lake Storage. You will use the standard Jaspersoft wizards to build SQL queries to Azure Data Lake Storage. The queries are executed directly to the Azure Data Lake Storage APIs, enabling real-time connectivity to Azure Data Lake Storage data.

Connect to Azure Data Lake Storage Data as a JDBC Data Source

To create a JDBC data source in Jaspersoft Studio, create a data adapter:

1. In the Repository Explorer view, right-click the Data Adapters node and click Create Data Adapter.
2. Select Database JDBC Connection.
3. Enter a user-friendly name for the driver.
4. On the Driver Classpath tab, click Add. In the resulting dialog, navigate to the lib subfolder of the installation directory. Select the driver JAR.
5. On the Database Location tab, enter the class name of the JDBC driver: cdata.jdbc.adls.ADLSDriver.
6. Enter the JDBC URL.

   Authenticating to a Gen 1 DataLakeStore Account

   Gen 1 uses OAuth 2.0 in Azure AD for authentication.

   For this, an Active Directory web application is required. You can create one as follows:

   1. Sign in to your Azure Account through the .
   2. Select "Azure Active Directory".
   3. Select "App registrations".
   4. Select "New application registration".
   5. Provide a name and URL for the application. Select Web app for the type of application you want to create.
   6. Select "Required permissions" and change the required permissions for this app. At a minimum, "Azure Data Lake" and "Windows Azure Service Management API" are required.
   7. Select "Key" and generate a new key. Add a description, a duration, and take note of the generated key. You won't be able to see it again.

   To authenticate against a Gen 1 DataLakeStore account, the following properties are required:

   • Schema: Set this to ADLSGen1.
   • Account: Set this to the name of the account.
   • OAuthClientId: Set this to the application Id of the app you created.
   • OAuthClientSecret: Set this to the key generated for the app you created.
   • TenantId: Set this to the tenant Id. See the property for more information on how to acquire this.
   • Directory: Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.

   Authenticating to a Gen 2 DataLakeStore Account

   To authenticate against a Gen 2 DataLakeStore account, the following properties are required:

   • Schema: Set this to ADLSGen2.
   • Account: Set this to the name of the account.
   • FileSystem: Set this to the file system which will be used for this account.
   • AccessKey: Set this to the access key which will be used to authenticate the calls to the API. See the property for more information on how to acquire this.
   • Directory: Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.adls.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 for Azure Data Lake Storage:

   jdbc:adls:Schema=ADLSGen2;Account=myAccount;FileSystem=myFileSystem;AccessKey=myAccessKey;InitiateOAuth=GETANDREFRESH

Create Reports with Azure Data Lake Storage Data

Follow the steps below to build an SQL query to Azure Data Lake Storage, the basis of a simple report:

1. Click File -> New Jasper Report. Select a template, select the parent project, and specify the report file.
2. In the Data Adapter menu, select the data adapter you created in the previous section.
3. In the Diagram tab, drag tables into the box and click the columns you want. Or, enter a custom query on the Texts tab. For example: SELECT FullPath, Permission FROM Resources WHERE Type = 'FILE'
4. Select the fields you want to include in the dataset. This example uses all fields.
5. Skip the Group By step and finish the wizard.

In the Preview tab, you can see the report as it would look with the current Azure Data Lake Storage data.

Create a Chart

The following sections show how to create a chart tied to its own SQL query. When retrieving the data from the remote data source, more restrictive queries, written for specific report objects, can result in faster performance.

Create a DataSet

Follow the steps below to create a new dataset to populate the chart:

1. In the report editing area, click the Design tab.
2. In the Outline view, right-click the root node for the report and click Create Dataset.
3. Enter a name for the dataset and click the option to create a new dataset from a connection or data source.
4. In the Data Adapter menu, select the data adapter you created in the first section.
5. Enter a query such as the following:
   SELECT FullPath, Permission FROM Resources WHERE Type = 'FILE'
6. Select the fields you want in the dataset. This example uses FullPath and Permission.
7. Skip the step to group by fields and finish the wizard.

Configure the Chart

After adding the dataset, follow the steps below to map column values to the chart axes in the chart wizard:

1. Click the Summary node in the Outline view. In the Properties view, set the height to 400 pixels. The summary band is printed at the end of the report.
2. Drag a chart from the Palette onto the summary. The chart wizard is displayed.
3. Select the chart type. This example uses a bar chart.
4. In the Dataset menu, select the dataset you created for the chart.
5. In the Dataset tab, select the option to use the same JDBC connection used to fill the master report.
6. Specify the chart's series: Click the button next to the Series menu and click Add. In the Expression Editor that is displayed, double-click the FullPath column to set the expression to $F{FullPath}.

7. Specify the y-axis values: In the chart wizard, click the button next to the Value box. In the Expression Editor, double-click Permission to set the expression to $F{Permission}.

8. Specify the labels for the series elements: In the chart wizard, click the button next to the Label box. In the Expression Editor, double-click the FullPath column to set the expression to $F{FullPath}. If needed, convert the column type to string, as in the following expression: $F{FullPath}.toString()
9. Expand the chart to fill the summary section: right-click the chart and click Size to Container -> Fit Both.

Running the Report

You can now generate reports on Azure Data Lake Storage data just as you would any other JDBC data source. Jaspersoft Studio periodically refreshes the data across report runs.