Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Create HubDB Reports on JasperReports Server
Deploy the CData JDBC Driver on JasperReports Server to provide real-time HubDB data access from reports, embedded analytics, and more.
The CData JDBC Driver for HubDB enables you to provide access to HubDB 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 HubDB data.
Deploy the Driver JAR
Follow the steps below to deploy the driver JAR on JasperReports Server. The instructions below contain specifics for HubDB 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 HubDB JDBC Driver on JBoss.
- 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.
-
Navigate to apache-tomcat -> webapps -> jasperserver-pro -> META-INF and add the following resource entry to the context.xml file:
<Resource name="jdbc/hubdb" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.hubdb.HubDBDriver" url="jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH" 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.
There are two authentication methods available for connecting to HubDB data source: OAuth Authentication with a public HubSpot application and authentication with a Private application token.
Using a Custom OAuth App
AuthScheme must be set to "OAuth" in all OAuth flows. Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).
Follow the steps below to register an application and obtain the OAuth client credentials:
- Log into your HubSpot app developer account.
- Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
- On the developer account home page, click the Apps tab.
- Click Create app.
- On the App info tab, enter and optionally modify values that are displayed to users when they connect. These values include the public application name, application logo, and a description of the application.
- On the Auth tab, supply a callback URL in the "Redirect URLs" box.
- If you're creating a desktop application, set this to a locally accessible URL like http://localhost:33333.
- If you are creating a Web application, set this to a trusted URL where you want users to be redirected to when they authorize your application.
- Click Create App. HubSpot then generates the application, along with its associated credentials.
- On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.
Under Scopes, select any scopes you need for your application's intended functionality.
A minimum of the following scopes is required to access tables:
- hubdb
- oauth
- crm.objects.owners.read
- Click Save changes.
- Install the application into a production portal with access to the features that are required by the integration.
- Under "Install URL (OAuth)", click Copy full URL to copy the installation URL for your application.
- Navigate to the copied link in your browser. Select a standard account in which to install the application.
- Click Connect app. You can close the resulting tab.
Using a Private App
To connect using a HubSpot private application token, set the AuthScheme property to "PrivateApp."
You can generate a private application token by following the steps below:
- In your HubDB account, click the settings icon (the gear) in the main navigation bar.
- In the left sidebar menu, navigate to Integrations > Private Apps.
- Click Create private app.
- On the Basic Info tab, configure the details of your application (name, logo, and description).
- On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
- A minimum of hubdb and crm.objects.owners.read is required to access tables.
- After you are done configuring your application, click Create app in the top right.
- Review the info about your application's access token, click Continue creating, and then Show token.
- Click Copy to copy the private application token.
To connect, set PrivateAppToken to the private application token you retrieved.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the HubDB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.hubdb.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.
- Log into your HubSpot app developer account.
-
Navigate to jasperserver-pro -> WEB-INF and add the following reference to the web.xml file:
HubDB data JSP jdbc/hubdb javax.sql.DataSource Container - Restart the server.
Create the HubDB JDBC Data Source
Follow the steps below to map the HubDB JDBC driver to a JDBC data source:
- Log into JasperReports Server and click Create -> Data Source.
- In the Type menu, select JNDI Data Source.
- 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/hubdb".
- 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 HubDB columns, apply filters, and execute SQL to create a domain.
- Click Create -> Domain. Enter an Id for the domain and select a save location.
- Click Browse in the Data Source section and select the HubDB data source you created.
- In the Domain Design section, click Create with Domain Designer.
- Select the schema containing your tables.
- 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.
- On the Derived Tables tab, you can define domains based on SQL queries. For example,
SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'
- On the Joins tab, you can join tables by selecting the columns you want to build the join condition and selecting the join type.
- On the Pre-Filters tab, drag and drop columns to define search criteria that filters the data exposed through the domain.
- On the Display tab, select HubDB data into the data sets presented to the user.
- 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.
- Click Create -> Ad Hoc View.
-
In the resulting dialog, select the HubDB domain you created.
-
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.
- 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.
- 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.
- 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.
![A report based on live data. (Salesforce is shown.)](../articles/jdbc-jasperserver-5.png)