Purpose of Document
This document is intended to augment existing install and configuration documentation.
This document applies to IBM Cognos Insight 10.1.x and 10.2.
This document assumes experience with software installations and working in Microsoft Windows environments.
This document will discuss and describe server and client installations and configurations for IBM Cognos Insight.
To understand more about what Cognos Insight is and can do, please see the developerWorks article IBM Cognos Insight – Overview and Use Case.
The IBM Cognos Insight User Guide is available on the IBM Cognos Insight Information Center listed below in the Resources section.
The Cognos Insight client can be installed in one of two ways, manually or by provisioning it through IBM Cognos Business Intelligence, IBM Cognos TM1 Applications, or IBM Cognos Express.
The following will discuss what is required on the server side for installations and how to install and configure the Cognos Insight client for desktop users.
Cognos TM1 Applications and Cognos Express bundle the Cognos Insight provisioning component, therefore no additional work is required beyond the appropriate installation and configuration of these technologies.
Cognos BI requires that the Cognos Insight provisioning component called Cognos Connection Installer for Cognos Insight be installed separately. Before installing the provisioning component, ensure you are installing the correct bit depth (32 bit or 64 bit) for your version of BI and that the Cognos BI environment you are installing it to is supported. You can obtain this information by visiting the IBM Cognos Insight Software Environments pages listed in the Resources section at the bottom of this document.
The following decision tree, seen in Figure 1, starts off with the question, “Are you using a supported Microsoft Windows operating system?”
If the answer is “Yes”, then it asks “Are you using a 64 bit version of the operating system?”
If the answer is “Yes”, then it says to “Install the Cognos Connection Installer for Cognos Insight 64 bit install package”.
If the answer is “No”, then it says to “Install the Cognos Connection Installer for Cognos Insight 32 bit install package”.
If you are not using a supported Microsoft Windows operating system, then it asks “Are you using a supported 64 bit UNIX or Linux operating system?”
If the answer is “Yes”, then it asks “Are you using a 64 bit version of Cognos BI?”
If the answer is “Yes”, then it says to “Install the Cognos Connection Installer for Cognos Insight 64 bit install package”.
If the answer is “No” to using a supported 64 bit UNIX or Linux operating system, or using Cognos BI, then it says to “Visit the Cognos Insight Software Environments page to ensure you set up a supported environment”. This is due to the fact that the Cognos Connection Installer for Cognos Insight is not supported for 32 bit versions of Cognos BI on UNIX or Linux.
Figure 1 - Decision tree for installing Cognos Connection Installer for Cognos Insight
The Cognos Connection Installer for Cognos Insight consists of two components, the Cognos Insight BI Integration component for the application tier and the Gateway component for the gateway tier.
Before installing Cognos Connection Installer for Cognos Insight, stop the Cognos BI server(s).
If Cognos BI is a single server install, when installing Cognos Connection Installer for Cognos Insight, select both the Cognos Insight BI Integration component and the Cognos Insight BI Integration Gateway component.
If Cognos BI is installed in a distributed environment with multiple application tiers, install the Cognos Insight BI Integration component on each server where Cognos BI application tier components are installed. Then install the Cognos Insight BI Integration Gateway component on each server where the Cognos BI gateway components are installed.
Start the Cognos BI server(s). Users with the appropriate permissions can now install or start Cognos Insight from IBM Cognos Connection, as seen on the Cognos Connection Welcome page in Figure 2, where a Create a workspace on my computer link is now available.
Figure 2 - Cognos Connection Welcome page with the Create a workspace on my computer link
Cognos Insight can also be found in the Launch menu in Cognos Connection.
In Cognos BI 10.1.x, to install or open Cognos Insight from Cognos Connection, users must have Execute and Traverse permissions on the Executive Dashboard capability, or the Report Studio capability in conjunction with the Express User Interface Profile found in the Security section of Cognos Connection Administration console. In Cognos BI 10.2, a new role called Cognos Insight Users and a capability called Cognos Insight were added, allowing for more granular control of the components.
Cognos Insight is a 32 bit Windows-only client application. However, if installed on a 64 bit Windows operating system, by default, the data component will run in 64 bit mode but can be configured to run in 32 bit mode if required. More will be discussed on this topic in section titled Configure Data Source Connections.
Again, the Cognos Insight client software can be installed in one of two ways: by installing it manually or by provisioning it through Cognos BI, Cognos TM1 Applications, or Cognos Express.
Simply double-click on the installation EXE and follow the installation wizard prompts. You can select the location to which you would like the installation files to be unpacked. The default locations are as follows:
For Windows XP - C:\Program Files\IBM\CognosInsight
For Windows 7 - C:\Program Files(x86)\IBM\CognosInsight
From there, the Cognos Insight MSI installer will be automatically run. Once the installation is complete, the application files, themes and preference files, and data storage folders will be written to various locations in the user’s profile. Please see the IBM Cognos Insight File Locations section for more information.
Simply click on the IBM Cognos Insight link under the Launch menu in Cognos Connection, as seen in Figure 3, or the Open IBM Cognos Insight icon in the Cognos TM1 Applications portal, as seen in Figure 4.
Figure 3 - Cognos Insight link in IBM Cognos Connection
Figure 4 - Cognos Insight icon in the Cognos TM1 Applications portal
As stated in the Install documentation, some web browser settings can affect whether your computer can provision Cognos Insight from Cognos BI, Cognos Express, or Cognos TM1 Applications. If provisioning Cognos Insight fails, check the following settings.
- Enable file downloads.
- Enable pop-ups from the Cognos Connection URL.
- Allow script initiated downloads without prompting.
- If you are using the Microsoft Internet Explorer web browser, enable MIME-sniffing.
If your browser is configured properly, you will be presented with an Install Now button, as seen in Figure 5.
Figure 5 - Cognos Insight Install Now button
Click the Install Now button. Depending on the browser you are using, you may be prompted to either Save or Run the file. If you save the file, once the download is completed, run the MSI file to start the installation. If you choose Run, the MSI file will be downloaded and started automatically.
Once the installation is complete, the application files, themes and preference files, and data storage folders will be written to various locations in the user’s profile. Please see the IBM Cognos Insight File Locations section for more information.
You can now open Cognos Insight from the Cognos portals.
IBM Cognos Insight File Locations
Default location of Cognos Insight application files on the user's computer
This is the location where the actual program files are stored.
For Windows XP - C:\Documents and Settings\username\Application Data\IBM\Cognos Insight
For Windows 7 - C:\Users\username\AppData\Roaming\IBM\Cognos Insight
Default location of the recent workspaces that appear on the Getting Started page in Cognos Insight
In this location you will find PNG files of recent workspaces which are displayed in the Cognos Insight Getting Started screen. If you delete a PNG file in this location, it will remove that particular item from your Open recent workspace section of the Getting Started screen.
For Windows XP - C:\Documents and Settings\username\.CognosInsight
For Windows 7 - C:\Users\username\.CognosInsight
Note: Other application files are also stored in this location that may need to be manually removed after you uninstall.
Default location of temporary data files
This location will contain two folders, Distributed and Private. The Distributed folder will contain temporary data files when opening a workspace from Cognos TM1 Applications in distributed mode. The Private folder contains temporary data files when creating or opening a workspace locally.
For Windows XP - C:\Documents and Settings\username\IBMCognos\TM1
For Windows 7 - C:\Users\username\IBMCognos\TM1
Note: Data files stored in the Distributed folder are not deleted automatically when you close Cognos Insight. If no longer needed (i.e., you do not intend to work in that disturbed workspace any longer) or you require extra disk space, you can manually delete the contents of the Distributed folder.
Configure Server Connections
You can configure IBM Cognos Insight to communicate with IBM Cognos BI, IBM Cognos TM1, IBM Cognos Express, and IBM Cognos Business Viewpoint.
The IBM Cognos BI configuration is used to share a workspace as a CDD file in Cognos Connection or to publish Cognos Insight workspaces as Cognos BI workspaces or reports. To share a workspace, you require write permission to the location in Cognos Connection you wish to share the file. To publish a workspace or reports in Cognos Connection, you require administrator privileges on the Cognos BI server.
The IBM Cognos TM1 configuration is used to publish a Cognos Insight workspace as an application to the Cognos TM1 Applications portal, and to connect to a Cognos TM1 Server to author a new workspace or update an existing one or import data from a Cognos TM1 Cube View. All require administrator privileges on the Cognos TM1 server.
Note: There are two considerations when publishing to a Cognos TM1 server.
- By default, only 10 Cognos Insight published servers can be running at once. If that is exceeded, Cognos Insight throws an error and a setting on the Cognos TM1 server needs to be changed. Refer to the tech note titled for Publishing multiple Cognos Insight workspaces fails for more information (http://www-01.ibm.com/support/docview.wss?uid=swg21590313).
- Publishing to a multi-tiered Cognos TM1 environment requires manual steps on the Cognos TM1 server. See the tech note titled Cognos Insight workspace cannot be published directly to a multi-tier Cognos TM1 installation (http://www-01.ibm.com/support/docview.wss?uid=swg21599439) for more information
The Cognos Business Viewpoint configuration is used to transfer in hierarchies from Cognos Business Viewpoint which become available as dimensions in Cognos Insight. When a Cognos Business Viewpoint server is configured in Cognos Insight, a Transfer In option becomes available under the Get Data menu.
These configurations are implemented in My Preferences under the Actions menu.
In the My Preferences dialog, you can configure one or more of each server type. The following shows the syntax format for each server type followed by an example.
For Cognos BI: http://<server name>/<vdir name>/cgi-bin/<cognos.cgi> or http://<server name>/<vdir name>//cgi-bin/<cognosisapi.dll>
For Cognos TM1: http://<server name>:<port number>/pmpsvc/services
For Cognos Business Viewpoint: http://<server name>:<port number>/bv
Figure 6 shows the My Preferences dialog with server URIs under the System column and their associated server type under the Type column.
Figure 6 – My Preferences dialog showing a configuration for each server type
Configure Data Source Connections
Cognos Insight can import data from various sources, including the following:
- Files (CSV, TAB, TXT, XLS)
- Relational data sources through ODBC
- IBM Cognos BI reports and packages
- IBM Cognos TM1 Cube Views
- IBM Cognos Business Viewpoint hierarchies
Please refer to the IBM Cognos Insight User Guide for details around supported file formats and data structures and any restrictions that may apply. Again, the IBM Cognos Insight User Guide is available on the IBM Cognos Insight Information Center listed below in the Resources section.
The following will discuss issues when trying to connect to a data source.
Files (CSV, TAB, TXT, XLS)
Files require no additional configuration. If the file type and format is supported, you can point to the file and perform the import.
Relational Data Sources through ODBC
For relational data sources, you must create an ODBC connection to the data source prior to import in Cognos Insight.
As discussed earlier in the Client Installs section, Cognos Insight is a 32 bit Windows only client application. However, if Cognos Insight is installed on a 64 bit Windows operating system, then by default, the data component will run in 64 bit mode. However, it can be configured to run in 32 bit mode if required.
For example, if you install Cognos Insight on a 64 bit version of Microsoft Windows but are using 32 bit ODBC drivers to connect to your data source, you will need to configure your ODBC connection using the 32 bit ODBC Data Source Administrator console (located at <system_drive>\Windows\SysWoW64\odbcad32.exe) and then configure your Cognos Insight data component to run in 32 bit mode.
To do so, go to the Cognos Insight installation location which can be located by looking at the Target property in the Properties dialog of the Cognos Insight shortcut located on your desktop.
- Open the configurations folder, and then open the config_10.2.xxxx.x folder.
- Open config.ini in a text editor and add the following line to the end of the file:
- Save and close the file.
- Start Cognos Insight and proceed to import the relational data source using the 32 bit ODBC connection you defined.
To connect to 64 bit ODBC connections, in the config.ini file, either delete the line that reads
DTM1_DISABLE_64BIT=trueor change the value to
For more information refer to the following tech note titled IBM Cognos Insight Cannot Connect to 32-bit ODBC Driver on a 64-bit Microsoft Windows Platform (http://www-01.ibm.com/support/docview.wss?uid=swg21616205).
IBM Cognos BI Reports and Packages
When importing data through reports or packages from Cognos BI, you will need to provide a valid IBM Cognos BI Server Address (URL). An example of a valid URL is http://my-server/cognos10-2/cgi-bin/cognos.cgi as seen in Figure 7.
Figure 7 - Import Data wizard showing a valid Cognos BI Server Address
Your Cognos BI administrator can provide the Cognos BI server URL to you. You will also need the appropriate permission to access the content. If you receive an error, speak to the Cognos BI administrator to determine your access to the content.
IBM Cognos TM1 Cube Views
To import from Cognos TM1 Cube Views, you will need to have configured a Cognos TM1 server in My Preferences as described earlier in the Configure Server Connections section. You will then need to connect to the Cognos TM1 server by selecting Connect to IBM Cognos TM1 from the Actions menu as seen in Figure 8. This requires administrator privileges on the Cognos TM1 server.
Figure 8 - Actions menu showing Connect to IBM Cognos TM1 highlighted
You will be prompted to provide your credentials and to select the Planning Server you would like to connect to. Once connected, you will have the option to select IBM Cognos TM1 Cube View in the Import Data wizard as seen in Figure 9.
Figure 9 - Import Data wizard showing Cognos TM1 Cube View highlighted in the Type drop down box
Also, when connected to a Cognos TM1 server, you can author new workspaces in Cognos Insight by adding content from the Content pane on the right, which displays the items available to you from the Cognos TM1 application.
IBM Cognos Business Viewpoint Hierarchies
To transfer in hierarchies from IBM Cognos Business Viewpoint that will be used as dimensions in Cognos Insight, you will need to have configured a Cognos Business Viewpoint server in My Preferences as described earlier in the Configure Server Connections section. You will then have the Transfer In option in the Get Data menu as seen in Figure 10.
Figure 10 Get Data menu showing Transfer In option highlighted
You will then be prompted to provide your credentials, after which you can transfer in hierarchies as required.
Creating Custom Themes
To create a custom theme where you control the fonts, colour schemes, and images, you can start by using an existing theme as a template. For example, on a Windows 7 system, you could use C:\Users\username\AppData\Roaming\IBM\Cognos Insight\configuration\config_10.2.1083.0\org.eclipse.osgi\bundles\57\1\.cp\model\themes\moondusk_theme.zip.
You can make a copy of this ZIP file and edit its contents to meet your needs. This may require graphics editing and will require knowledge of editing XML files. Once complete, in IBM Cognos Insight, in the Style menu, select Apply Workspace Theme, and then click the Browse button (as seen in Figure 11) to navigate to your new custom theme.
Figure 11 - Browse button in Apply Workspace Theme dialog
- IBM Cognos Insight 10.1 and 10.1.1 Information Center
- IBM Cognos Insight 10.2 Information Center
- Supported Environments for IBM Cognos Insight 10.1
- Supported Environments for IBM Cognos Insight 10.1.1
- Supported Environments for IBM Cognos Insight 10.2