Create Data Visualizations in Cognos BI with HubDB Data

You can use the CData ODBC driver for HubDB to integrate HubDB data with the drag-and-drop style of Cognos Report Studio. This article describes both a graphical approach to create data visualizations, with no SQL required, as well as how to execute any SQL query supported by HubDB.

Configure and Publish the Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, 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.

If you are running Cognos from a 64-bit machine and want to modify the DSN or create other HubDB DSNs, you must use a system DSN. You will also need to open the 32-bit ODBC Data Source Administrator. You can open it with the following command:

C:\Windows\sysWOW64\odbcad32.exe 

After creating a DSN, you can then publish the data source:

1. Open Cognos Administration and click Data Source Connections to add a new data source:

2. Select the ODBC option and enter the DSN, CData HubDB Sys, and a user-friendly name.

3. Click Retrieve Objects and choose the CData HubDB database object. 👁 The DSN used to add the data source. (Salesforce is shown.)
   

Add Data Visualizations to a Report

You can now create reports on HubDB data in Cognos Report Studio by dragging and dropping table columns from the Source Explorer onto report objects. The sections below show how to create a simple report with a chart that shows up-to-date data.

As you build the report, Cognos Report Studio will generate SQL queries and rely on the driver to execute them. The driver will convert queries into requests to the HubDB API. To execute queries to the live HubDB data, the driver depends on the capabilities of the underlying API.

Create a Chart Based on an Aggregate

You can populate almost any report object in Cognos with HubDB data by simply dragging and dropping columns from the Source Explorer onto the dimensions of the object. The column in the Series dimension of the chart is automatically grouped.

Additionally, Cognos sets a logical default aggregate function for the measure dimension based on the data type. For this example, override the default by clicking the Name column in the Data Items tab and set the Aggregate Function property to Not Applicable. The Rollup Aggregate Function property must be set to Automatic.

👁 HubDB columns used in a pie chart. (Salesforce is shown.)

Convert a Query Object to SQL

When you know the query you need, or if you want to adjust the generated query, convert a query object into an SQL statement. After a query has been converted to SQL, the UI controls are not available for the query object. Follow the procedure below to populate a chart with user-defined SQL.

Cognos will rely on the driver to execute the user-defined query. Using the driver's SQL engine ensures that queries will always return up-to-date results, as there is no cached copy of the data.

1. Hover over the Query Explorer and click the Queries folder to display the query objects in your report.

2. If you want to edit the autogenerated query, click the button in the Generated SQL property for the query object. In the resulting dialog, click Convert.

   If you want to enter a new SQL statement, drop an SQL object in-line with the query object.

3. Modify the properties for the SQL object: Select the HubDB data source in the SQL properties and set the SQL Syntax property to Native.

4. Click the button in the SQL property and enter the SQL query in the resulting dialog. This example uses the query below:

   SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'

5. Modify the properties for the query object: Set the Processing property to "Limited Local". This value is required to convert a query object to SQL.

   👁 A query object created from an SQL statement.
   

Fill a Chart with the Results of a Query

You can now access the results of the SQL query as objects in the Data Items tab. Follow the procedure below to create a chart with the results; for example, the Name for each PartitionKey from the NorthwindProducts table.

1. Return to the page by hovering over the Page Explorer and then clicking the page object.
2. Drag a pie chart from the toolbox onto the workspace.
3. In the properties for the chart, set the Query property to the name of the query you created above.
4. Click the Data Items tab and drag columns onto the x- and y-axes. In this example, drag the PartitionKey column to the Series (pie slices) box and the Name column to the Default Measure box.

5. Modify the default properties for the Default Measure (the Name values): In the Aggregate Function box, select the Total option.

👁 A pie chart populated with the result of executing the SQL query. (Salesforce is shown.)

Run the report to add the results of the query.

👁 The rendered report. (Salesforce is shown.)