The purpose of this document is to provide additional quick installation guidance on installing IBM Cognos TM1 9.5 and upgrading existing TM1 models. This document should be used in combination with the "IBM Cognos TM1 – Installation Guide version 9.5".
Upgrading to IBM Cognos TM1 9.5 from TM1 9.4.1.
Exclusions and Exceptions
This example is performed on a 32-bit Windows 2003 Server with Apache Tomcat and IIS. This example installation is performed on a single server using basic TM1 security settings (Mode = 1 (and Mode = 5 but without specifying Cognos 8 Security)).
TM1 9.5 Server Install and Upgrade
- Backup Existing TM1 Data
The first step in upgrading your TM1 Servers and TM1 Webs is to make a complete backup of your TM1 Server Data Directories and your TM1 Web Directory.
Please refer to the Proven Practice Document: TM1 Backup and Recovery Guide for further details on creating a backup for TM1 Data.
The screenshot below shows two compressed backup files: TM1Data.7z for the TM1 Data Directory; and wwwroot.7z for the TM1 Web files.
Image of TM1 Data Backup
These files can be used to restore the TM1 9.4 Server data and TM1 9.4 Web virtual directory should anything go wrong during the upgrade to TM1 9.5.
- Install Pre-Requisites
The next step is to verify that you have all of the pre-requisites installed on the machine that will have TM1 9.5 installed on it. From Windows Start go to Control Panel > Add Remove Programs and verify that Microsoft .Net Framework 3.5 has been installed.
Image of .Net Frameworks installed
If you do not see Microsoft .NET Framework 3.5 then you must download it from:
Then install it and verify it has been applied by returning to the Control Panel and viewing the Add/Remove Programs list.
Note: You may be prompted to re-start your computer after installing the Microsoft .NET Framework 3.5.
- Install TM1 9.5 Server Software
TM1 Installation Wizard should start automatically when you insert the TM1 9.5 software CD. Alternatively, you can commence installation by running "Setup.exe" from the TM1 Install folder.
Image of TM1 Installation Directory
Note: If you are upgrading from a prior TM1 version such as TM1 9.4.1, it is not necessary to uninstall the prior version if you will be installing TM1 9.5 into the same directory. TM1 9.5 will overwrite the previous version program files in that directory. Your data directories should not be affected by the installation of TM1 9.5 over a prior version.
After accepting the Software License Agreement, you will be presented with the option of choosing which TM1 Products you would like to install. You are limited to choosing a single product on this screen. However, if you want to install additional products onto the current computer you can re-start the TM1 9.5 Setup.exe and choose "Modify" and then select the additional components. Alternately, you could choose "Custom" in the next screen and select all of the components that you would like to install. Thereby, eliminating the need to re-run the Setup.exe to install the additional software components.
Image of TM1 Installation Wizard - step 1
Then after selecting the product, you are also prompted to select a "Standard" or "Custom" Installation Option. The Standard option will install all the components for the product you selected from the previous screen. You also have the option to change the installation location at this point by clicking on the "Change..." button.
TM1 Install Wizard - Step 2
Next, you will be provided with the option of accepting the default ports for TM1 Admin Host and the TM1 Admin Server SSL. You have the option to change the TM1 Admin Server SSL port number at this point if you find that it conflicts with other programs.
TM1 Install Wizard - Step 3
The TM1 Admin Host and several other TM1 processes run as a Service on Windows and at this point in the installation process, you are prompted to enter an account which TM1 can use to launch the Services in Windows upon start-up. Usually, this account should have administrator privileges. Enter the account and passwords in the boxes provided and click "Next".
TM1 Install Wizard - Step 4
Next you can click "Install" and the software should begin the installation process. When the installation completes, you will receive a success message and then you may click the "Finish" button.
TM1 Install Wizard - Step 5
- Starting and Verifying the TM1 9.5 Server Installation
After the TM1 9.5 Server Installation has completed, you should verify that the installation worked by starting the TM1 Services and navigating a TM1 Server instance.
To begin, open the Administration Tools from the Control Panel and open Services. Scroll down the list of services until you see TM1 Admin Server. Right-click on that service and choose Start from the drop-down menu. Also, if you are running any TM1 Server instances as a Windows Service, you can start them now.
TM1 Admin Server - Service
After starting the TM1 Services, you can now launch TM1 Architect to verify that your TM1 Server instance(s) are opening correctly in the TM1 version 9.5.
TM1 Server - Startup Screen
Navigate the Applications, Cubes, Views, Dimensions, etc and when you are satisfied that the TM1 Server is complete and running as expected, you can Exit the program.
TM1 Web 9.5 Install and Configuration
After completing the TM1 Server 9.5 installation, the next step covered in the quick guide is to install and configure the TM1 Web 9.5 components.
To install TM1 Web 9.5, re-launch "Setup.exe" for TM1 9.5 and choose "Modify". Expand the Clients section of the Components Installation Wizard and choose: "TM1 Web Components".
TM1 Installation Wizard - Additional Components1
Provide credentials that will allow TM1 Web to install this software on the server.
TM1 Server Services Account
You may accept the default directory or provide a new location for the installation. If you are upgrading from TM1 Web 9.4.1, it is recommended to install TM1 Web 9.5 in the same directory. TM1 Web 9.5 will simply overwrite the TM1 Web 9.4 files.
TM1 Install Wizard - Web Components
After the TM1 Web 9.5 components have installed you will received the successful installation message. Click "Finish".
TM1 Installation Wizard - Web Components Finished
TM1 Web 9.5 installs a complete and pre-configured IIS Virtual Directory that can be accessed by opening IIS and browsing your Web Sites and Virtual Directories. You can immediately start using TM1 Web to work with your TM1 Server instances and the Cube Views within those TM1 Servers.
You can navigate to TM1 Web 9.5 from your browser by entering the following URL:
Where "localhost" is the name of the server where TM1Web is installed.
TM1 Web 9.5 working with upgraded TM1 9.4 model: Planning Sample.
TM1 Contributor 9.5 Configuration
TM1 Contributor 9.5 is new functionality for TM1. So, there is no comparable upgrade path. The example below takes the existing TM1 9.4 Server called Planning Sample that was upgraded to TM1 Server 9.5 in the previous examples and deploys that model with the new TM1 Contributor 9.5 functionality.
- Install .NET Framework v3.5
- TM1 Web 9.5
- Install Java Runtime Environment (JRE) version 6
- Install Apache Tomcat or IBM Websphere Community Edition
In this example, Apache Tomcat is used. Note: Apache Tomcat requires that Java Runtime Environment (JRE) version 6 be installed before you are permitted to install Apache Tomcat on your server.
After installing Apache Tomcat, ensure that the encoding is set for ‘utf=-8’ in the file: tomcat-users.xml
The default location for this file is: C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf\
Open tomcat-users.xml in Notepad and look at the first line of the file. If required, change the ‘encoding’ value to ‘utf-8’ and ‘Save’ the file.
Image of Tomcat-users.xml file
The default port for Apache Tomcat is port 8080. To login to Apache Tomcat, navigate your browser to the following URL:
Where "localhost" is the name of the server where Apache Tomcat is installed.
Login to Tomcat Manager by clicking on the Tomcat Manager link in the upper-left section of the Apache Tomcat main page. Deploy the WAR file called "pmpsvc.war" that was included in the installation of TM1 Contributor 9.5. This file is located in the following directory: ...\Program Files\Cognos\TM1\Cadmin\pmpsvc.war
Image of Tomcat Admin locating pmpsvc.war file.
After Tomcat deploys the pmpsvc WAR file, it will be displayed under Applications in Tomcat Manager.
Image of Tomcat Manager displaying active pmpsvc.war file
To launch TM1 9.5 Contributor, enter the following URL:
Image of URL displaying TM1 Contributor address
The first time you log into TM1 9.5 Contributor you will be presented with an initialization screen. The values should be populated based on the components that you have installed.
Image of initial TM1 Contributor logon screen choosing a TM1 Server
If the information is correct click "OK".
You will then be prompted for your TM1 login information. Enter your TM1 user ID and password and click "Login".
When you have arrived at the TM1 Contributor main page, look for a folder icon in the upper-right section of the screen. This folder is named "Design an Application".
Image of choosing 'Design an Application'
The first time you click on this folder you will be prompted to download and install a .msi file called CognosRCP.msi
Image of CognosRCP.msi being downloaded.
Click "Run" to install the file.
After the install completes, re-start your browser session and navigate back to the TM1 Contributor Page. Then click on the "Design an Application" folder again.
The TM1 Contributor 9.5 Administration Tool should now launch and present you with the following Application Design screen:
Image of initial design screen of TM1 Contributor
Once you are in the TM1 Contributor Administration Tool, you can follow the process wizard to help you design and deploy TM1 Contributor models.
You can drag cube views and hierarchy dimensions from the TM1 Objects pane to the Design pane.
Image of TM1 Cube Views and Approval Hierarchy
Image of TM1 Contributor successfully validating.
Validate the application that you have designed...
Image of TM1 succesfully deploying on TM1 Contributor.
Deploy the application...
Defining TM1 Contributor node security
Assign security and rights to each node in the dimension hierarchy...
Image of TM1 Contributor successfully saving security rights
Verify your TM1s.cfg security setting for this TM1 Server...
Note: It is a best practice to define the Integrated Security Mode before designing the TM1 Contributor application. Once an Integrated Security Mode has been defined for one TM1 Contributor application, that same Integrated Security Mode should be used for all TM1 Contributor Applications.
Image of Tm1s.cfg file being opened in MS Notepad
TM1 Contributor application link displayed
After the TM1 Contributor application has been created, it will be displayed in the main TM1 Contributor screen.
TM1 Contributor warning message 'Application is currently Inactive'
However, one more step is required to launch the application. You must click on the far-right folder called: Activate this Application...
Now the TM1 Contributor application can be opened and navigated.
Image of TM1 Contributor workflow and status
Image of TM1 Contributor cubes opened.
Users can input data, use planning capabilities and create Sandbox Areas to perform ‘What-If’ Analysis.
Image of TM1 Contributor Workflow updated to "Locked"
Finally, workflow capabilities are provided to improve communication within the planning process.
Troubleshooting the install
Error attempting to open "Design an Application" folder in TM1 Contributor. ModelingADT.msi and CognosRCP.msi have not been installed, yet. Solution: install the .msi files from the command line.
Installing the ModelingADT.msi file...
Installing the CognosRCP.msi file.
Image of command-line install of CognosRCP.msi
|Cognos TM1 9.5 Upgrade Part 1- Server||TM1_95_Server_Upgrade.zip||26,305KB|
|Cognos TM1 9.5 Upgrade Part 2- Web and Contributor||TM1_95_Web_Contrib_Config.zip||49,130KB|