Integrate with Azure Data Lake Storage Data in JReport Designer

The CData JDBC Driver for Azure Data Lake Storage data enables access to live data from dashboards and reports as if Azure Data Lake Storage were a relational database, allowing you to query Azure Data Lake Storage data using familiar SQL queries. This article shows how to connect to Azure Data Lake Storage data as a JDBC data source and create reports based on Azure Data Lake Storage data in JReport Designer.

Connect to Azure Data Lake Storage Data

1. Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Azure Data Lake Storage 2016\lib\cdata.jdbc.adls.jar;
   ...
   

2. Create a new data source by clicking File New Data Source.
3. In the resulting dialog, create a name for the data source (CData JDBC Driver for Azure Data Lake Storage), select JDBC, and click OK.
4. In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
   • Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver: cdata.jdbc.adls.ADLSDriver
   • URL: Enter the JDBC URL. This starts with jdbc:adls: and is followed by a semicolon-separated list of connection properties.

     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:

     jdbc:adls:Schema=ADLSGen2;Account=myAccount;FileSystem=myFileSystem;AccessKey=myAccessKey;InitiateOAuth=GETANDREFRESH
   • User: The username to authenticate with; typically left blank.
   • Password: The password to authenticate with; typically left blank.

5. In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.

   Click Done once the dialog has completed loading the tables.

6. In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Azure Data Lake Storage), right-click on Queries, and select Add Query.
7. In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK.
8. In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:

   SELECT FullPath, Permission FROM Resources WHERE Type = 'FILE'
   

   With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Azure Data Lake Storage data to a new or existing report.

   NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.

Add Azure Data Lake Storage Data to a Report

You are now ready to create a report with Azure Data Lake Storage data.

1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
2. Select the Query (or create a new one; see above).
3. Assign a Category and Value for the chart from the columns in your Query and click Finish.
4. Click the View tab for your report to see the chart.