Connect to HubDB in SpagoBI

The CData JDBC Driver for HubDB enables you to connect to live HubDB data from business intelligence and data mining tools that support the JDBC standard. This article shows how to integrate HubDB data into a report in SpagoBI Studio and host it on SpagoBI Server.

• Deploy the Driver in SpagoBI Server
• Create a Report in SpagoBI Studio
• Host HubDB Reports on SpagoBI Server

Deploy the JDBC Driver in SpagoBI Server

Follow the steps to create a JDBC data source for HubDB in SpagoBI Server.

1. Copy the driver JAR into %CATALINA_BASE%/lib. These files are located in the lib subfolder of the installation directory.

2. Add a HubDB driver resource to the context. The following resource definition can be added to the GlobalNamingResources element in server.xml: <Resource name="jdbc/hubdb" auth="Container" type="javax.sql.DataSource" driverclassname="cdata.jdbc.hubdb.HubDBDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxactive="20" maxidle="10" maxwait="-1"/>

3. Add the following resource link to give access to Web applications. For this article, add the following line to META-INF\context.xml for SpagoBI. <ResourceLink global="jdbc/hubdb" name="jdbc/hubdb" type="javax.sql.DataSource"/>
4. Restart the server.

After adding the driver to the resources for the SpagoBI server, add the data source: In SpagoBI, click Resources -> Data Source -> Add and enter the following information:

• Label: Enter a unique identifier for the driver.
• Description: Enter a description for the driver.
• Dialect: Select Default Dialect.
• Read Only: Select the read-only option. This option determines whether the data source is the default database to save datasets created by the end user.
• Type: Select JDBC.
• URL: Enter the JDBC URL using the required connection string properties:

  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:

  1. Log into your HubSpot app developer account.
     • Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
  2. On the developer account home page, click the Apps tab.
  3. Click Create app.
  4. 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.
  5. 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.
  6. Click Create App. HubSpot then generates the application, along with its associated credentials.
  7. On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.

  8. 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
  9. Click Save changes.
  10. 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:

  1. In your HubDB account, click the settings icon (the gear) in the main navigation bar.
  2. In the left sidebar menu, navigate to Integrations > Private Apps.
  3. Click Create private app.
  4. On the Basic Info tab, configure the details of your application (name, logo, and description).
  5. On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
  6. A minimum of hubdb and crm.objects.owners.read is required to access tables.
  7. After you are done configuring your application, click Create app in the top right.
  8. Review the info about your application's access token, click Continue creating, and then Show token.
  9. 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.

  A typical JDBC URL is below:

  jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
• Driver: Enter the class name for the driver: cdata.jdbc.hubdb.HubDBDriver

Create Reports in SpagoBI Studio

Follow the steps below to populate reports based on HubDB data in SpagoBI Studio. You will create a dataset that populates a chart with the results of an SQL query. In the next section, you will host this report on SpagoBI Server.

First, you will need to connect to HubDB data from a report in SpagoBI Studio:

1. In SpagoBI Studio, click File -> New -> Project and select Report Project in the Business Intelligence and Reporting Tools folder.
2. Click File -> New -> Report and select Blank Report.
3. In the Data Explorer view, right-click Data Sources and click New Data Source.
4. Select JDBC Data Source and enter a name for the data source.
5. Click Manage Drivers and click Add to add the driver JAR, cdata.jdbc.hubdb.jar. The driver JAR is located in the lib subfolder of the installation directory.
6. In the Driver Class menu, select the driver class, cdata.jdbc.hubdb.HubDBDriver.
7. In the Database URL box, enter the JDBC URL. A typical JDBC URL is below: jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH See the "Getting Started" chapter of the driver help for a guide to obtaining the required connection properties.

After you have connected to HubDB data, create a dataset that contains the results of an SQL query:

1. Right-click the DataSet folder and click New Data Set. Select the JDBC data source for HubDB and enter a name for the dataset.
2. Build the SQL query. In this example, this query will be used to add a chart to the dashboard. For example: SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'

You can use the dataset to populate report objects. Follow the steps below to create a chart.

1. In the Palette view, drag a chart onto the canvas.
2. In the Select Chart Type tab, select a bar chart.
3. In the Select Data tab, click the Use Data From option and select the HubDB data set from the menu.
4. Drag PartitionKey from the table to the series for the x-axis.
5. Drag Name from the table to the series for the y-axis.

Host HubDB Reports on SpagoBI Server

Follow the steps below to host documents based on live HubDB data on SpagoBI Server. You will use the report you created in the previous section as a template. To enable report users to access the live data, create placeholder parameters to be replaced by the HubDB JDBC data source on the server:

1. If you have not already done so, open the Report Design perspective in SpagoBI Studio.
2. In the Data Explorer view, right-click the Report Parameters folder and click New Parameter. Add the url parameter and assign an empty value to it. This parameter is a placeholder for the JDBC data source on the SpagoBI Server.
3. Right-click the HubDB data source and click Edit.

4. In the Property Binding node, set the JDBC Driver URL binding property to the url parameter: Click the box for the property. In the Category section, select Report Parameters. Select All in the Subcategory section and double-click the parameter.

   You can also enter the following in the JavaScript syntax:

   params["url"].value

Next, create a new document for the report on SpagoBI Server.

1. In SpagoBI Server, click Documents Development -> Create Document -> Generic Document. The Document Details page is displayed.
2. To create the document, enter the following:
   • Label: Enter a unique identifier for the document.
   • Name: Enter a user-friendly name for the document.
   • Type: Select Report from the menu.
   • Engine: Select BIRT Report Engine.
   • Data Source: Select the HubDB Data Source you created in Create a JDBC Data Source for HubDB in SpagoBI Server.
3. In the Show Document Templates section, select the folder where you want the document to be stored.

4. In the Template section, click Choose File. Navigate to the folder containing your report project. Select the .rptdesign file.

   Note: You can find the path to the project in the project properties.

5. Click the Save button.

When you run the report on the server, the placeholder url parameter is replaced with the JDBC URL defined on the server.