Create Data Visualizations in Cognos BI with Discourse Data

You can use the CData ODBC driver for Discourse to integrate Discourse 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 Discourse.

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.

The Discourse API uses API Key authentication.

Using API Key Authentication

Discourse requires API Key and Username for authentication. API Keys are generated in the Discourse Admin panel under the API section. You can create user-specific API keys or all-users API keys. Once you have obtained the API Key, set it along with the Domain and Username in the ProfileSettings connection property.

Example Connection string

Profile=C:\profiles\Discourse.apip;ProfileSettings='Domain=forum.example.com;APIKey=your_api_key;Username=your_username;'AuthScheme=APIKey;

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 Discourse 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 API Sys, and a user-friendly name.

3. Click Retrieve Objects and choose the CData Discourse 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 Discourse 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 Discourse API. To execute queries to the live Discourse 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 Discourse 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 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.

👁 Discourse 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 Discourse 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 , FROM Backups WHERE = ''

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 for each from the Backups 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 column to the Series (pie slices) box and the column to the Default Measure box.

5. Modify the default properties for the Default Measure (the 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.)