Create CouchDB Reports on JasperReports Server

The CData JDBC driver for CouchDB enables you to provide access to CouchDB data across the enterprise. This article shows how to deploy the driver on JasperReports server and create a simple report based on a reporting domain, a business view of CouchDB data.

Deploy the Driver JAR

Follow the steps below to deploy the driver JAR on JasperReports Server. The instructions below contain specifics for CouchDB and the Tomcat server bundled with JasperReports Server. If you are using JBoss AS 7 instead of Tomcat, you can follow the standard process to deploy the CouchDB JDBC Driver on JBoss.

1. Copy the driver JAR and .lic file, located in the lib subfolder of the installation directory, to the lib subfolder of the apache-tomcat folder, located in the JasperReports Server installation directory.

2. Navigate to apache-tomcat -> webapps -> jasperserver-pro -> META-INF and add the following resource entry to the context.xml file:

   <Resource name="jdbc/apachecouchdb" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.apachecouchdb.ApacheCouchDBDriver" url="jdbc:apachecouchdb:Url=http://localhost:5984;User=abc123;Password=abcdef;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>

   Specify the required connection properties in the JDBC URL -- the url attribute.

   Set the following to connect:

   • Url: The Url of your instance. For example: http://localhost:5984
   • User The Apache CouchDB user account used to authenticate.
   • Password The Apache CouchDB 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 CouchDB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.apachecouchdb.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.

3. Navigate to jasperserver-pro -> WEB-INF and add the following reference to the web.xml file: CouchDB data JSP jdbc/apachecouchdb javax.sql.DataSource Container
4. Restart the server.

Create the CouchDB JDBC Data Source

Follow the steps below to map the CouchDB JDBC driver to a JDBC data source:

1. Log into JasperReports Server and click Create -> Data Source.
2. In the Type menu, select JNDI Data Source.
3. In the Service Name box, enter the JDNI lookup defined in the resource definition in the web.xml file. In the example, the lookup is "jdbc/apachecouchdb".
4. Click Save to create the Data Source.

Create a Domain

A domain is a metadata and access-control layer that surfaces a relevant business view to report creators. Follow the steps below to select CouchDB columns, apply filters, and execute SQL to create a domain.

1. Click Create -> Domain. Enter an Id for the domain and select a save location.
2. Click Browse in the Data Source section and select the CouchDB data source you created.
3. In the Domain Design section, click Create with Domain Designer.
4. Select the schema containing your tables.
5. On the Tables tab, select a table in the Data Source pane and then click the arrow to add them to the Selected Tables pane.
6. On the Derived Tables tab, you can define domains based on SQL queries. For example,

     SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'
     

7. On the Joins tab, you can join tables by selecting the columns you want to build the join condition and selecting the join type.
8. On the Pre-Filters tab, drag and drop columns to define search criteria that filters the data exposed through the domain.
9. On the Display tab, select CouchDB data into the data sets presented to the user.
10. Click OK to accept your changes and click Submit to create the domain.

Explore Data in Real Time

After you have created a domain, you are ready to connect to data. Follow the steps below to create an Ad Hoc View in the Ad Hoc Editor.

1. Click Create -> Ad Hoc View.
2. In the resulting dialog, select the CouchDB domain you created.
3. On the Choose Data page, select columns that you want to use in the view. In the Pre-Filters section, you can create filters based on the selected fields. In the Display section, you can modify column information as presented by the domain.
4. After completing the wizard, select the view type and add columns to the view. JasperSoft uses the metadata of the driver to detect the available dimensions and measures, based on the data type. Drag dimensions and measures onto the Columns and Rows boxes. Right-click a measure to change the summary calculation. Drag the Columns slider to the the desired data level in the Filters section.
5. To access updates to the data as you design the view, change the menu selection from Sample Data to Full Data in the design mode toolbar. As you make changes, JasperSoft Server executes the underlying SQL queries to the driver.
6. Save the view.

Create a Real-Time Report

You can now create reports hosted on JasperSoft Server. To do so from the Ad Hoc Editor, click Save Ad Hoc View and click Create Report.