Integrate Elasticsearch Data in the Pentaho Report Designer

The CData JDBC driver for Elasticsearch data enables access to live data from dashboards and reports. This article shows how to connect to Elasticsearch data as a JDBC data source and publish reports based on Elasticsearch data in Pentaho.

Getting Started

---

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 Elasticsearch connection. In the resulting dialog, configure the connection properties as shown below.

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

     Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

     The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

     Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.elasticsearch.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:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
   • Custom Driver Class Name: Enter cdata.jdbc.elasticsearch.ElasticsearchDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add Elasticsearch Data to a Report

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

1. Add the Elasticsearch 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 Orders.Freight, Customers.ContactName FROM Customers INNER JOIN Orders ON Customers.CustomerId=Orders.CustomerId
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 Orders table.
4. Finally, run the report to see the chart.