IBM Cognos Proven Practices: Case Study: Upgrade to IBM Cognos 10

Product(s): IBM Cognos 8 BI, IBM Cognos 10 BI; Area of Interest: Upgrade/Migration

A case study where a new distributed IBM Cognos 10.1 BI environment is installed alongside an existing distributed IBM Cognos BI 8.3 environment using the IBM Cognos BI 8.3 content store and configuration files as a basis.

Arun Sekar, IT Analyst, Tata Consultancy Services (TCS)

Arun S is an Assistant Consultant in Tata Consultancy Services, India; He has worked in various verticals like Life Science, Health Care and Retail Domain providing BI Solutions. He is a BI Solution Architect with expertise on Cognos Series 7 tools, IBM Cognos 8 and IBM Cognos 10 BI, Tibco Spotfire and Informatica. He is specialized in administering Series 7, IBM Cognos 8 and IBM Cognos 10 and TIBCO Spotfire Tools. He is an Oracle Certified Associate, IBM Cognos Administrator and IBM Cognos Report Designer.



Ganapathy Srinivasan Ramanujam, Assistant Systems Engineer, Tata Consultancy Services (TCS)

Ganapathy Srinivasan Ramanujam is an Assistant Systems Engineer in Tata Consultancy Services, India having around 4 years of IT experience; who is a Certified IBM Cognos Administrator and IBM Cognos Report Designer having extensive experience in Cognos Administration and IBM Cognos series 8v Tools and Frame Work Modeling. He has been associated with TCS and mainly focused on Retail BI solutions. His main expertise is in IBM Cognos 8 BI that to specialized in IBM Cognos 8 Administration. Ganapathy Srinivasan Ramanujam is an IT Analyst in Tata Consultancy Services, India who is a Certified IBM Cognos Administrator, IBM Cognos Report Designer and IBM Cognos BI Technical Specialist. He has extensive experience in implementing solutions in IBM Cognos/TIBCO Spotfire. Ganapathy has been associated with TCS and mainly focused on Retail BI solutions. His main expertise is in IBM Cognos 8 and IBM Cognos 10 BI Tools specializing in IBM Cognos 8 and IBM Cognos 10 Administration.



29 August 2012

Also available in Chinese Russian

Introduction

Purpose

This document explains the process involved and best practices in installing, configuring and upgrading from IBM Cognos BI version 8.3 to IBM Cognos BI 10.1.

Applicability

This document is intended for IBM Cognos BI administrators who would like to upgrade their IBM Cognos BI version 8.3 installations to IBM Cognos 10.1.

Exclusions and Exceptions

While this document is specific to the 8.3-to-10.1 upgrade, the process and information provided may be beneficial for anyone upgrading from other versions of IBM Cognos 8 to IBM Cognos 10.1.


Determine the IBM Cognos 10 Architecture

The main factors that need to be considered while determining what the architecture for the new IBM Cognos 10 BI environment are as follows,

  • Concurrent user load.
  • Geographic location of the end users.
  • Maximum number of batch reports that will be done during non-peak and peak period.
  • Maximum number of interactive reports that will be done during peak and non-peak periods.
  • Authentication providers to be configured and used.
  • Third-party portals into which the IBM Cognos BI reports are to be integrated.

For this upgrade, it was determined that the new IBM Cognos 10 BI environment would only need to support the existing IBM Cognos 8 BI user count and workloads. As a result, the architecture of IBM Cognos 10 environment was able to remain the same as the IBM Cognos BI 8.3 environment. It was also determined that the same physical machines could host the new IBM Cognos 10 BI environment using different ports and other slight modifications.

We planned to upgrade all our applications to the new IBM Cognos 10.1 release to be compatible with other enterprise wide changes (such as Internet Explorer 8 usage) and to leverage the new features of IBM Cognos 10.1. All the applications using IBM Cognos 8.3 will be moved to IBM Cognos 10.1 in a phased manner and the IBM Cognos 8.3 instance will be shut down once complete. In conjunction with other factors such as the cost to procure new hardware and existing server utilization the decision to reuse the existing Windows hardware was made.

Application users will be moving to the IBM Cognos 10.1 environment and after testing, their artifacts on IBM Cognos 8.3 will be disabled. Only during the testing phase will same set of users be accessing both the IBM Cognos 8.3 and the IBM Cognos 10.1 environments. After this phase, the users will be accessing only the IBM Cognos 10.1 environment. An assessment of the hardware (server) utilization was performed prior to proceeding with this approach. It is important to ensure that the hardware has sufficient resources to support both environments and the user workload during the upgrade period.

Both IBM Cognos 8.3 and IBM Cognos 10 will exist on the same Windows 2003 R2 Enterprise Edition boxes using different port numbers.

As can be seen in Table 1 below, the new IBM Cognos 10 BI components will be installed alongside their IBM Cognos 8 counterparts with two noticeable exceptions - the primary Content Manager of IBM Cognos 10 will reside on the same machine as the secondary Content Manager of IBM Cognos 8.3 and the secondary Content Manager of IBM Cognos 10 will reside on the same machine as the primary Content Manager of IBM Cognos 8.3. This was done to provide necessary system resources for processing.

Table 1: Existing architecture of IBM Cognos 8.3 and proposed architecture of IBM Cognos 10
Machine NameIBM Cognos 8.3 GatewayIBM Cognos 8.3 Application TierIBM Cognos 8.3 Content ManagerIBM Cognos 10 GatewayIBM Cognos 10 Application TierIBM Cognos 10 Content Manager
AXXXX
BXX
CXPrimaryXSecondary
DXSecondaryXPrimary

Approach To Upgrading The Content Store

There are effectively two approaches to upgrading the Content Store.

Approach 1 - Use the deployment utility to the move the contents of the Content Store from the IBM Cognos 8.3 BI environment to the IBM Cognos 10 environment via the export/import wizard in the IBM Cognos Administration console. The pros and cons of this approach can be summarized as follows,

ProsCons
Using deployment utility is a straight forward process and can be carried out through the IBM Cognos Administration console itself.Security settings and capabilities needs to be deployed separately.
Enables transporting the content to a different RDBMS. For example, MS SQL Server in IBM Cognos 8.3 and DB2 in IBM Cognos 10.Time consuming as each project needs to be deployed separately.

Approach 2 - Upgrade the entire IBM Cognos 8.3 BI Content Store to IBM Cognos 10 by taking a cold backup of the IBM Cognos 8.3 BI Content Store database schema and import it into a new database that will be used for the IBM Cognos 10 Content Store.

ProsCons
Since we are upgrading the entire Content Store all the contents existing in IBM Cognos 8.3 will be upgraded to IBM Cognos 10 including security and users’ My Folder contents.Need backup of existing Content Store and this needs to be imported as a new DB.
Since the entire Content Store is upgraded less time consuming and all the user preferences will be preserved in IBM Cognos 10 as well.Can be deployed to the same database type only.

IBM recommends that, if possible, Approach 2 be used as it will upgrade the entire Content Store. If the requirement is to only move a portion of the Content Store or there is the need to change the underlying database of the Content Store (i.e. from Oracle to DB2), then Approach 1 would be the better option.

As we are going to install IBM Cognos 10.1 on the same Windows machines where IBM Cognos 8.3 is already installed, the ODBC drivers that already exist for the data source connections can be reused with IBM Cognos 10.1. If the plan is to use Dynamic Query Mode in the new IBM Cognos 10 environment, the JDBC drivers for the data sources will need to be installed.

Finally, a decision was made to create a new Audit database for the IBM Cognos 10.1 environment instead of continuing to use the existing Audit database of the IBM Cognos 8.3 environment. As the IBM Cognos 8.3 environment is phased out, the information in the Audit database will remain intact and be available as an archive. The steps to create an Audit database are contained in the IBM Cognos 10 Installation and Configuration Guide and it is assumed that this database has been created prior to installing IBM Cognos 10.1.


Installation and Configuration

Consistency Check

The first step is the Consistency Check. This step is required to make sure that the source Content Store is clean and can be used for the IBM Cognos 10 upgrade. It is strongly recommended that cold database backup of the Content Store database be done before performing the consistency check.

  • Login to the IBM Cognos BI 8.3 environment with a userid that is a member of the System Administrators role in the Cognos namespace.
  • Navigate to the IBM Cognos Administration page.
  • Click on the Configuration tab, click on the Content Administration option on the left side panel, click on the drop-down next to the New content maintenance icon and click New Consistency Check….
  • Run the consistency check.
Figure 1 - Consistency check option in IBM Cognos Administration
Figure 1 - Consistency check option in IBM Cognos Administration

After the New Consistency Check… item is selected, the New Content Maintenance Task wizard: Consistency Check will appear.

There are two types of consistency checks. The first type only checks references that are entirely within the Content Store and the second type will check for inconsistencies between the Content Store and selected external security namespaces. Both types of consistency checks are required.

Consistency check on Content Store only

This consistency check can be used to check and remove any outdated data from the IBM Cognos Content Store. From the New Content Maintenance Task wizard, select the Internal references option as shown in Figure 2 to ensure the Content Store data is checked for any inconsistencies and click the Next button.

Figure 2 - Run consistency check for internal references
Figure 2 - Run consistency check for internal references

A Run with options screen will be presented. From this screen, we specify the time to run the content maintenance task and whether or not the task should only find inconsistencies or find and then fix the inconsistencies. As shown in Figure 3, we only want to find the inconsistencies so they can be analyzed before they are fixed so we select the mode Find only. Click the Run button to start the consistency check.

Figure 3 - Run the internal consistency check immediately in “Find only” mode
Figure 3 - Run the internal consistency check immediately in “Find only” mode

When the consistency check has finished running, the View run history details screen will be presented. In Figure 4, the response from the consistency check was “The content store database is consistent”. If there were any inconsistencies reported, we would need to investigate each one and then re-run the consistency check in Find and fix mode to fix the inconsistencies.

Figure 4 - Result of running the internal consistency check in “Find only” mode
Figure 4 - Result of running the internal consistency check in “Find only” mode

Consistency check on external namespace

A consistency check against external security namespaces is necessary to ensure that the user accounts present in Content Store are in sync with the authentication provider(s) being used.

Some of the users might be removed from the authentication provider but these users will still remain in the Content Store. These users can be removed from the Content Store through this process.

Before performing this step, the user running the consistency check must be logged into all of the external security namespaces. This will ensure all the users in the Content Store are can be processed and synchronized with the appropriate authentication provider or removed from the Content Store.

From the consistency check wizard, select the References to external namespaces and the All namespaces options and click the Next button.

Figure 5 – Consistency check to reference all external security namespaces
Figure 5 – Consistency check to reference all external security namespaces

As shown earlier in Figure 4, the Run with options screen will be presented. Specify the time to run the consistency check, ensure the Find only mode is selected and click the Run button. If any discrepancies are found, the consistency check should be re-run in Find and fix mode after a Content Store backup is taken.

Content Store Backup & Restore

After the Consistency Check step is completed, request the database administrator (DBA) to take a cold backup of the resulting IBM Cognos 8.3 Content Store database and import it into a new database that will be used for the IBM Cognos 10 Content Store. Record the following details for future reference,

IBM Cognos 8.3 Content Store specifications

Database Type:
Server Name:
Schema (if required):
User ID:
Password:

Backup Content Store Specifications (will be used for IBM Cognos 10 Content Store)

Database Type:
Server Name:
Schema (if required):
User ID:
Password:

Install Primary Content Manager For IBM Cognos 10

After the Content Store Backup and Restore step is completed, it’s time to start installing the IBM Cognos 10 environment as per the architecture defined earlier. Start by installing the primary Content Manager on the same machine as the secondary Content Manager for the IBM Cognos 8.3 environment. The new install will require a different port number and a different service name.

In the IBM Cognos 10 install program, select only the Application Tier and Content Manager components as shown below in Figure 6.

Figure 6 – The Content Manager and Application Tier components selected in the install program
Figure 6 – The Content Manager and Application Tier components selected in the install program

We can export the configuration from IBM Cognos 8.3 and use that for the IBM Cognos 10.1 installation. This will ensure that there is no need to reconfigure all the authentication providers and other configuration settings such as file system location and Java memory settings. Using an exported configuration also reduces the risk of typographical errors, especially since many of the configuration settings will not be changing.

Note: Since the configuration from the IBM Cognos 8.3 environment will be used as the basis for IBM Cognos 10.1 environment, the IBM Cognos 10.1 services should NOT be started until the Content Store database name, Audit database name and port numbers are modified.

  • Copy appropriate JDBC jar files to the IBM Cognos 10 installation location. These files should be copied to <c10_root>\webapps\p2pd\WEB-INF\lib.
  • Export the IBM Cognos 8.3 configuration from the machine that hosts the primary Content Manager (Machine C from Table 1 above) and save it as cogstartup.xml. Note that the contents of the exported configuration will not be encrypted. This export is performed from within IBM Cognos Configuration by selecting the File > Export As… option. The exported cogstartup.xml file should be saved into the <c8_root>\logs directory.
  • Copy the exported cogstartup.xml file to the <c10_root>\configuration sub-directory of the new IBM Cognos 10 instance.
  • Open IBM Cognos Configuration for the newly installed instance of IBM Cognos 10. It will prompt with a warning message stating that the cogstartup.xml is an older version and will be upgraded. Select OK at which point the IBM Cognos 8.3 configuration file will be upgraded to an IBM Cognos 10 configuration file, which can then be used for making the modification described below. When this step has completed, an information dialog stating that the configuration files have been upgraded will be presented. Click OK to continue.
    Figure 7 - IBM Cognos Configuration showing that the configuration file imported from the IBM Cognos 8.3 environment has been upgraded for use with IBM Cognos 10
    Figure 7 - IBM Cognos Configuration showing that the configuration file imported from the IBM Cognos 8.3 environment has been upgraded for use with IBM Cognos 10
  • Modify the Content Store details to point to the Content Store database that was restored from backup in the previous step.
  • Modify the Audit database details to refer to the new audit database for IBM Cognos 10.
  • Modify the hostname of the Content Manager and Dispatcher.
  • Check all the port numbers to see if they are available and if necessary, select new available ports. We use the netstat command to determine if a port is already in use or available for configuration. Netstat command displays protocol statistics and current network connections. In Figure 8, command netstat –an | find “9301” shows the connections that are listening or established which means the port 9301 is already in use.
    Figure 8 - Port status on the Dispatcher and CM machines using the netstat command
    Figure 8 - Port status on the Dispatcher and CM machines using the netstat command
  • Modify the port numbers of dispatchers, log servers and shutdown.
  • Check the value of the file system location to ensure that the location exists on the new machine.
  • For each of the authentication providers, verify that the parameters are the same as on the IBM Cognos 8.3 environment.
  • Test the Content Store connection.
  • Test the Audit database connection.
  • Check that the Java Runtime Environment (JRE) is pointing appropriately in the IBM Cognos 10 configuration. To do this press Ctrl+F3 to bring up the Properties dialog as shown in Figure 9. The JRE information will be in the System Properties tab.
    Figure 9 – JRE properties for the IBM Cognos 10.1 installation
    Figure 9 – JRE properties for the IBM Cognos 10.1 installation
  • Modify the IBM Cognos 10.1 service name so that it is different from the IBM Cognos 8.3 service name. This change needs to be done before saving the configuration and starting the new IBM Cognos 10.1 instance.
  • Save the configuration. This will create new cryptographic keys. In addition, the configuration files that were exported in clear text will now be encrypted as part of the save process.
  • Start the new IBM Cognos 10 instance from IBM Cognos Configuration. Since this will be the first time IBM Cognos 10 has been started and the IBM Cognos 10 Content Manager configuration is pointing to the restored IBM Cognos 8.3 database, a dialog stating that the Content Store database will be upgraded will appear (see Figure 10). Note that the checkbox for Upgrade report specifications? has been unchecked intentionally so that initial startup time of the new IBM Cognos 10 primary Content Manager will be fast. The task of upgrading report specifications will be done later on in the upgrade process. Click the OK button to continue.
    Figure 10 – Dialog stating that the Content Store database will be upgraded
    Figure 10 – Dialog stating that the Content Store database will be upgraded
    Since this the first time starting the new IBM Cognos 10 instance, it will take longer than normal to start as the Content Store schema is being upgraded. We need to wait until the console says it is started successfully. Check the <c10_root>/logs folder to check the progress of the upgrade. You can see references of IBM Cognos 10 components getting upgraded and the details of the upgrade in the cogserver.log file.
  • When IBM Cognos 10 has been started, verify that Content Manager is running by accessing http://<hostname>:<port>/p2pd/servlet in a browser, replacing <hostname> and <port> with the actual values. An HTML page containing the Content Manager build number, the time Content Manager was started, the current time and the current state of the Content Manager will be presented (see Figure 11). The State: field should have a value of Running.
    Figure 11 – Content Manager status page showing a state of Running
    Figure 11 – Content Manager status page showing a state of Running
  • When the above message is obtained. It confirms that the primary Content Manager is started and is up and running correctly. We can now proceed with standby Content Manager installation as well as the dispatcher and gateway installations.

Install Standby Content Manager

After the Install Primary Content Manager for IBM Cognos 10 step is completed, start installing the IBM Cognos 10 standby Content Manager. Recall that we chose to install this on the machine where primary Content Manager of IBM Cognos 8.3 is installed to ensure the resources were shared appropriately.

Install the Application Tier and Content Manager components alone on this machine for IBM Cognos 10.1 as shown in Figure 12. The new install will require a different port number and a different service name.

Figure 12 – The install program showing the Content Manager and Application Tier components selected
Figure 12 – The install program showing the Content Manager and Application Tier components selected

Once again, we can export the configuration from IBM Cognos 8.3 and use that for IBM Cognos 10.1 installation. This will ensure that there is no need to reconfigure all the Authentication providers and other configuration settings such as the file system location and Java memory settings.

Note: Since the configuration from the IBM Cognos 8.3 environment will be used as the basis for IBM Cognos 10.1 environment, the IBM Cognos 10.1 services should NOT be started until the Content Store database name, Audit database name and port numbers are modified.

  • Copy appropriate JDBC jar files to the IBM Cognos 10 installation location. These files should be copied to <c10_root>\webapps\p2pd\WEB-INF\lib.
  • Export the IBM Cognos 8.3 configuration of secondary Content Manager (Machine D from Table 1 above) and save it as cogstartup.xml. Note that the contents of the exported configuration will not be encrypted. This export is performed from within IBM Cognos Configuration by selecting the File > Export As… option. The exported cogstartup.xml file should be saved into the <c8_root>\logs directory.
  • Copy the exported cogstartup.xml file to the <c10_root>\configuration sub-directory of the IBM Cognos 10 installation location.
  • Open IBM Cognos Configuration for this newly installed instance of IBM Cognos 10. As seen when configuring the primary Content Manager installation, you will be prompted with a warning message stating that the cogstartup.xml is an older version and will be upgraded. Click the OK button and it will be upgraded to the IBM Cognos 10 format.
  • Modify the Content Store details to point to the restored Content Store backup database taken above.
  • Modify the Audit database details to refer to the new audit database for IBM Cognos 10.
  • Modify the hostname of the Content Manager and Dispatcher.
  • Check all the port numbers to see if they are available and if necessary, select new available ports. Use the netstat command as described earlier in the section titled Install Primary Content Manager For IBM Cognos 10.
  • Modify the port numbers of dispatchers, log servers and shutdown.
  • Add the Content Manager URIs making sure that the primary Content Manager is first in the list followed by the secondary Content Manager.
    Figure 13 - Adding the Content Manager URIs
    Figure 13 - Adding the Content Manager URIs
  • Check the value of the file system location to ensure that the location exists on the new machine.
  • For each of the authentication providers, verify that the parameters are the same as on the IBM Cognos 8.3 environment.
  • Test the Content Store connection.
  • Test the Audit database connection.
  • Check that the Java Runtime Environment (JRE) is pointing appropriately in the IBM Cognos 10 configuration. To do this press Ctrl+F3 to bring up the Properties dialog as shown back in Figure 9. The JRE information will be in the System Properties tab.
  • Modify the IBM Cognos 10 service name so that it is different from the IBM Cognos 8.3 service name. This change needs to be done before saving the configuration and starting the new IBM Cognos 10 instance.
  • Save the configuration. This will create new cryptographic keys. In addition, the configuration files that were exported in clear text will now be encrypted as part of the save process.
  • Start the standby Content Manager.
  • When IBM Cognos 10 has been started, verify that standby Content Manager is running by accessing http://<hostname>:<port>/p2pd/servlet in a browser, replacing <hostname> and <port> with the actual values. The HTML that is returned should look similar to what is shown in Figure 14. The State: field should have a value of Running as standby.
    Figure 14 – Standby Content Manager Status
    Figure 14 – Standby Content Manager Status

Install Cognos 10 Dispatchers

After the Install Standby Content Manager step is completed, start installing the IBM Cognos 10 Dispatcher components as per the architecture recommendation. Install only the Application Tier components in this machine as shown here in Figure 15.

Figure 15 - The install program showing the only the Application Tier components selected
Figure 15 - The install program showing the only the Application Tier components selected

Note: Since the configuration from the IBM Cognos 8.3 environment will be used as the basis for IBM Cognos 10.1 environment, the IBM Cognos 10.1 services should NOT be started until the Content Store database name, Audit database name and port numbers are modified.

  • Copy appropriate JDBC jar files to the IBM Cognos 10 installation location. These files should be copied to <c10_root>\webapps\p2pd\WEB-INF\lib.
  • Export the IBM Cognos 8.3 configuration of Application Tier Components and save it as cogstartup.xml. Note that the contents of the exported configuration will not be encrypted. This export is performed from within IBM Cognos Configuration by selecting the File > Export As… option. The exported cogstartup.xml file should be saved into the <c8_root>\logs directory.
  • Copy this cogstartup.xml file to the <c10_root>\configuration sub-directory of the IBM Cognos 10 installation location.
  • Open IBM Cognos Configuration for this newly installed instance of IBM Cognos 10. As seen when configuring the primary Content Manager installation, you will be prompted with a warning message stating that the cogstartup.xml is an older version and will be upgraded. Click OK and it will be upgraded to the IBM Cognos 10 format.
  • Modify the hostname of the Content Manager and Dispatcher.
  • Check all the port numbers to see if they are available and if necessary, select new available ports. Use the netstat command as described earlier in the section titled Install Primary Content Manager For IBM Cognos 10.
  • Modify the port numbers of dispatchers, log servers and shutdown.
  • Add the Content Manager URIs, making sure that the primary Content Manager is first in the list followed by the secondary Content Manager.
  • Add the Dispatcher URIs.
  • Modify the Audit database details to refer to the new database that was created for IBM Cognos 10 auditing and test the connection.
  • Check that the Java Runtime Environment (JRE) is pointing appropriately in the IBM Cognos 10 configuration. To do this press Ctrl+F3 to bring up the Properties dialog as shown back in Figure 9. The JRE information will be in the System Properties tab.
  • Modify the IBM Cognos 10.1 service name so that it is different from the IBM Cognos 8.3 service name. This change needs to be done before saving the configuration and starting the new IBM Cognos 10 instance.
  • Save the configuration. This will create new cryptographic keys. In addition, the configuration files that were exported in clear text will now be encrypted as part of the save process.
  • Start the Dispatcher.
  • Type the URL http://<hostname>:<port>/p2pd/servlet/dispatch in a web browser, replacing <hostname> and <port> with actual values, and if the Dispatcher is running you will see an HTML page containing a dropdown list of all the external security namespaces configured for this Dispatcher (see Figure 16).
    Figure 16 – IBM Cognos 10 Dispatcher status
    Figure 16 – IBM Cognos 10 Dispatcher status
  • Repeat the steps above for installing other IBM Cognos 10 Dispatchers.

Once all the IBM Cognos 10 Dispatchers are installed, use the URL http://<hostname>:<port>/p2pd/servlet/dispatch/p2plbDiag to see the status of all the Services and Dispatchers in the IBM Cognos 10 environment. You must to be logged with a userid that is a member of System Administrators role to view the status.

Install IBM Cognos 10 Gateway

After the Install Cognos 10 Dispatchers step has been completed, start installing the IBM Cognos 10 Gateways. The basic process remains the same. Export the IBM Cognos 8.3 configuration, import it in IBM Cognos 10 and modify the port numbers. If required, add an SSL (Secure Sockets Layer) certificate to the web server. The Dispatcher ports need to be open from the IBM Cognos 10 Gateway machines to provide communication between Gateways and Dispatchers.

On Machine A from Table 1 above, start the IBM Cognos 10 install program and select only the Gateway component as shown below in Figure 17.

Figure 17 – The install program showing the only the Gateway component selected
Figure 17 – The install program showing the only the Gateway component selected
  • Export the IBM Cognos 8.3 Gateway configuration and save it as cogstartup.xml. Note that the contents of the exported configuration will not be encrypted. This export is performed from within IBM Cognos Configuration by selecting the File > Export As… option. The exported cogstartup.xml file should be saved into the <c8_root>\logs directory.
  • Copy this cogstartup.xml file to the <c10_root>\configuration sub-directory of the IBM Cognos 10 installation location.
  • Open IBM Cognos Configuration for this newly installed instance of IBM Cognos 10. As seen when configuring the primary Content Manager installation, you will be prompted with a warning message stating that the cogstartup.xml is an older version and will be upgraded. Click OK and it will be upgraded to the IBM Cognos 10 format.
  • Modify the port numbers of the Dispatchers to the ones we used when installing the IBM Cognos 10 dispatchers.
  • Save the configuration for the Gateway.

After the Gateway configuration is completed, you can verify the IBM Cognos 10 instance by launching the web gateway URI in the web browser. You should be presented with the default IBM Cognos 10.1 logon screen (see Figure 18) which contains a dropdown list that allows the user to select one of the security namespaces defined in IBM Cognos Configuration.

Figure 18 – The default IBM Cognos 10 logon screen
Figure 18 – The default IBM Cognos 10 logon screen

Install Audit Deployment For IBM Cognos 10

The Audit tables in IBM Cognos 10.1 have additional fields and these additional fields are reflected in the model and reports contained in the IBM Cognos 10.1 Audit deployment. At this point in the upgrade process, the IBM Cognos 10.1 Content Store contains the Audit package from the IBM Cognos 8.3 environment. While these Audit reports will upgrade when it comes time to upgrade report specifications, the upgrade process will not add the additional fields. It is recommended that the existing Audit package be deleted from the Content Store and the replaced with the new Audit package provided with IBM Cognos 10.1.

From a browser, connect to IBM Cognos 10.1 through the newly established gateway URL and login with an account that has System Administrator access. From IBM Cognos Connection, navigate to the location where IBM Cognos 10.1 Audit package has been deployed (this will be the same location the IBM Cognos 8.3 Audit package). The default location is Public Folders > Audit.

Before proceeding, if you have created additional Content Store objects such as reports (including report outputs) and schedules under Public Folders > Audit, you will want to make backup copies of these objects or move them to another location in the Content Store.

Click on the check box beside the Audit package and then click on the Delete icon as shown in the Figure 19.

Figure 19 – IBM Cognos Connection showing the Audit deployment selected and mouse hovered on the delete icon
Figure 19 – IBM Cognos Connection showing the Audit deployment selected and mouse hovered on the delete icon

The dialog shown in Figure 20 will appear informing the user that deleting entries may result in broken links in other Content Store objects. Click OK to continue.

Figure 20 - The dialog requesting confirmation to delete the existing Audit package
Figure 20 - The dialog requesting confirmation to delete the existing Audit package

The Audit package has now been removed.

To completely remove the existing Audit setup, we will also need to remove the existing data sources used by the Audit package. Navigate to IBM Cognos Administration, click on the Configuration tab and ensure that Data Source Connections is selected from the list of options on the left. Select the Audit data source and click on the Delete icon as shown in Figure 21. If the url_xml data source was also created, it can be selected along with the Audit data source.

Figure 21 – The Audit data source selected for deletion in IBM Cognos Administration
Figure 21 – The Audit data source selected for deletion in IBM Cognos Administration

Once again, the dialog informing the user that deleting entries may result in broken links in other Content Store objects will appear. Click OK to continue.

The Audit package brought into the IBM Cognos 10.1 environment from IBM Cognos 8.3 as part of the Content Store upgrade process has now been completely removed. To deploy the IBM Cognos 10.1 Audit package, follow the steps provided in the IBM Cognos 10.1 Administration and Security Guide.


Customization and Performance Tuning in Cognos 10 Instance

This section explains about the customization (skinning changes) that may need to be done to the new IBM Cognos 10 environment to bring the look and feel to the client standards.

Skinning Changes and Customization

Any customization incorporated in the IBM Cognos 8.3 instance will need to be re-implemented in the new IBM Cognos 10 environment. The customization .CSS and .XML files will need to be updated on the IBM Cognos 10 Gateway, Dispatcher and Content Manager machines. Be aware that there may be differences in the .CSS and .XML files between IBM Cognos 8.3 and IBM Cognos 10.1 and you should consult the “IBM Cognos 10 Administration and Security Guide” for more information.

Performance tuning of IBM Cognos 10.1 server instances

As part of the performance tuning, the high affinity connections, low affinity connections, time out settings for report service, inactivity time out, maximum size of report output in email and other environment specific settings need to be modified in the new IBM Cognos 10.1 environment using the values from IBM Cognos 8.3 as the basis.

For both the Report Service and the Batch Report Service, modify the high and low affinity settings and the maximum number of processes service during peak and non-peak periods.

Login to the IBM Cognos 10.1 environment and navigate to the IBM Cognos Administration page. Click on the Configuration tab, and select the Dispatchers and Services item on the left side panel. On the right side panel you will see the list of Dispatchers configured in the environment. Click on set properties of each Dispatcher and select the Settings tab.

Select Tuning in the Category drop-down box. Modify the following settings so that they match the IBM Cognos 8.3 configuration settings.

  • Processing capacity
  • Number of high affinity connections for the batch report service during non-peak period
  • Number of low affinity connections for the batch report service during non-peak period
  • Maximum number of processes for the batch report service during non-peak period
  • Number of high affinity connections for the report service during non-peak period
  • Number of low affinity connections for the report service during non-peak period
  • Maximum number of processes for the report service during non-peak period
  • Queue time limit of the report service (seconds)
  • Maximum size of an uncompressed email attachment in MB
  • Number of high affinity connections for the batch report service during peak period
  • Number of low affinity connections for the batch report service during peak period
  • Maximum number of processes for the batch report service during peak period
  • Number of high affinity connections for the report service during peak period
  • Number of low affinity connections for the report service during peak period
  • Maximum number of processes for the report service during peak period
  • Non Peak period start hour
  • Peak period start hour

Please note the performance characteristics of IBM Cognos 10.1 are likely to be different than IBM Cognos 8.3. Continued performance monitoring of the IBM Cognos 10.1 should be done after the upgrade process has been completed.

If there are other environment settings that need to be brought over from the IBM Cognos 8.3 environment, make those changes at this time as well.

Renaming IBM Cognos 10.1 Services

You may find it useful to rename each of the IBM Cognos 10 services in the IBM Cognos Administration console by inserting the Dispatcher name to the beginning of the service. Renaming the services in this manner will be helpful when monitoring the status of services as they can be tagged to the Dispatcher that they belong to.

For example, if we had Dispatchers named 230, 231 and 233, the renaming the Report Service and the Batch Report Service would result in something like,

  • 230_ReportService
  • 231_ReportService
  • 233_ReportService
  • 230_BatchReportService
  • 231_BatchReportService
  • 233_BatchReportService

This will be helpful to monitor the status of each of the Dispatcher services in the IBM Cognos Administration console as shown in Figures 22 and 23.

Figure 22 - The status of all Report services in the IBM Cognos 10 environment
Figure 22 - The status of all Report services in the IBM Cognos 10 environment
Figure 23 - The status of all Batch Report services in the IBM Cognos 10 environment
Figure 23 - The status of all Batch Report services in the IBM Cognos 10 environment

New Service Account

A new service account should be used to start the IBM Cognos 10 services. This will be used for monitoring purposes. Java Virtual Machine (JVM) utilization and the IBM Cognos 10 Report Server processes (BiBusTKServerMain.exe) can be distinguished and monitored when using a new service account. Any abnormality on the system resources during report execution will be helpful when debugging IBM Cognos 10 server related issues. As seen in Figure 21, the account cogdevsc10 will be used as the service account for the service named IBM Cognos:9501. Ensure that this service account has sufficient permissions to run IBM Cognos 10. Typically this service account will be a member of the Administrators group on the Windows machine.

Figure 24 – Setting the IBM Cognos 10 service account
Figure 24 – Setting the IBM Cognos 10 service account
Figure 25 – Windows Task Manager showing cogdevsvc10 being used for the IBM Cognos 10 processes and cogdevsvc1 for the IBM Cognos 8.3 processes
Figure 25 – Windows Task Manager showing cogdevsvc10 being used for the IBM Cognos 10 processes and cogdevsvc1 for the IBM Cognos 8.3 processes

Upgrade Report Specifications

The final step is to upgrade the report specifications in the IBM Cognos 10 environment using the New Report Upgrade wizard.

Report specifications can be upgraded either during the Content Manager installation and starting process or through the report upgrade wizard from the administration page. As we chose not to upgrade the reports during Content Manager Startup, we must use Report Upgrade Tasks to upgrade the reports. Failure to upgrade the reports will have an ongoing performance impact as each time a report is opened in IBM Cognos 10 it will be upgraded. If not saved, the report specification will remain at the old version and this automatic upgrade will occur every time the report is opened

  • From the IBM Cognos 10 Administration tool, click on the Configuration tab.
  • As shown in Figure 26, select the New Report Upgrade… task from the drop-down associated with the New content maintenance icon.
    Figure 26 – The New Report Upgrade…. task selected in IBM Cognos Administration
    Figure 26 – The New Report Upgrade…. task selected in IBM Cognos Administration
  • The New Content Maintenance Task wizard: Report Upgrade will appear. Select the packages, reports and/or folders to upgrade (see Figure 27) and click on OK.
    Figure 27 – Select the items that the New Content Maintenance task wizard for report upgrade should process
    Figure 27 – Select the items that the New Content Maintenance task wizard for report upgrade should process
  • Click on the Next button as shown in Figure 28 to proceed to specifying the options for running the upgrade task.
    Figure 28 – Contents selected for upgrade
    Figure 28 – Contents selected for upgrade
  • Select Save and run once and click the Finish button to proceed with the upgrade task (see Figure 29).
    Figure 29 – Select a run frequency for the report upgrade
    Figure 29 – Select a run frequency for the report upgrade
  • Select Now as the time to run the upgrade task as shown in Figure 30.
    Figure 30 – Specify the time to run the upgrade task as now
    Figure 30 – Specify the time to run the upgrade task as now

Figure 31 shows the status of the report upgrade. The status messages include the total number objects that were successfully upgraded, the number of objects that did not require an upgrade and lists the objects that experienced an error during upgrade. Each object that experienced an upgrade error will need to be further investigated. There are many reasons why a report could not be upgraded.

Figure 31 - Report upgrade wizard completion status
Figure 31 - Report upgrade wizard completion status

IBM Cognos SDK Applications

If IBM Cognos SDK applications are being used, all the IBM Cognos SDK applications will need to be upgraded to make use of the IBM Cognos BI 10.1 libraries (JAR files and .NET assemblies) before connecting and running the IBM Cognos 10.1 reports. There may also additional code changes necessary to existing applications as a result of deprecated functions and/or differences in product behavior. Consult the IBM Cognos 10 SDK Developer’s Guide for detailed information on upgrading SDK applications to the IBM Cognos 10.1 level.


Patch Updates

IBM Cognos 10.1 is the base install. IBM provides fix packs that may be installed over existing IBM Cognos 10 instances to resolve known issues. You can search for available updates and fix packs on the IBM Cognos Support site at the following URL,

http://www.ibm.com/support/entry/portal/us/Downloads?cm_re=other-_-suprcn-_-download


Appendix A - References

IBM Cognos 10.1 Installation and Configuration Guide

IBM Cognos 10.1 Architecture and Deployment Guide

IBM Cognos 10.1 Administration and Security Guide

IBM Cognos 10.1 SDK Developer Guide

Comments

developerWorks: Sign in

Required fields are indicated with an asterisk (*).


Need an IBM ID?
Forgot your IBM ID?


Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.

 


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name



The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.

 


All information submitted is secure.

Dig deeper into Big data and analytics on developerWorks


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Business analytics
ArticleID=831885
ArticleTitle=IBM Cognos Proven Practices: Case Study: Upgrade to IBM Cognos 10
publish-date=08292012