You are on page 1of 83

IBM Cognos TM1 9.

4 MR1

TM1 INSTALLATION GUIDE

Product Information
This document applies to IBM Cognos TM1 Version 9.4 MR1 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).

Copyright
Copyright 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company. Portions of Cognos ULC software products are protected by one or more of the following U.S. Patents: 6,609,123 B1; 6,611,838 B1; 6,662,188 B1; 6,728,697 B2; 6,741,982 B2; 6,763,520 B1; 6,768,995 B2; 6,782,378 B2; 6,847,973 B2; 6,907,428 B2; 6,853,375 B2; 6,986,135 B2; 6,995,768 B2; 7,062,479 B2; 7,072,822 B2; 7,111,007 B2; 7,130,822 B1; 7,155,398 B2; 7,171,425 B2; 7,185,016 B1; 7,213,199 B2; 7,243,106 B2; 7,257,612 B2; 7,275,211 B2; 7,281,047 B2; 7,293,008 B2; 7,296,040 B2; 7,318,058 B2; 7,325,003 B2; 7,333,995 B2. Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others. While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to the information contained in this document will be documented in subsequent editions. U.S. Government Restricted Rights. The software and accompanying materials are provided with Restricted Rights. Use, duplication, or disclosure by the Government is subject to the restrictions in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer clause at DFARS 252.227-7013, or subparagraphs (C)(1) and (2) of the Commercial Computer Software - Restricted Rights at 48CFR52.227 as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA 01803. This document contains proprietary information of Cognos. All rights are reserved. No part of this document may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos.

Table of Contents
Introduction

7 9

Chapter 1: TM1 Installation Overview

Installation Checklist 10 TM1 Service Account 12 .NET Framework Requirements 12 Microsoft ASP.NET Framework 3.0 is not Registered 13 Enable TM1 Excel Service 13 ASPNET User is not Defined 14 Logging Installation Messages 15 Installing Components on Different Machines 15 Important Notes on Distributed Installations 16 Starting the Installation Wizard 16 Accept the License Agreement 16 Choose a Product to Install 17 Microsoft Framework Reminder 17 Custom or Standard Installation Options 17 Installation Location 18 Selecting Components to Install 18 Chapter 2: Installing TM1

19

Custom TM1 Installation 19 Custom TM1 Components 19 Configuring TCP/IP Ports for TM1 21 Username and Password for TM1 Services 22 Installing TM1 on Networks without Domains 23 Security Settings 23 Integrated Login Modes 24 Configuring the TM1 Server 25 Configuring TM1 Clients 26 Begin the Installation 27 Post-Installation Tasks 27 Standard TM1 Installation 28 Chapter 3: Installing TM1 Perspectives

31

Custom TM1 Perspectives Installation 31 Configuring TM1 Perspectives 32 Standard TM1 Perspectives Installation 32 Chapter 4: Installing TM1 Web

35

Custom TM1 Web Installation 35 Configuring TM1 Web Components 35 Configuring TCP/IP Ports for TM1 Web 38 Username and Password for TM1 Services 38 Security Settings 38

Installation Guide 3

Table of Contents Configuring the TM1 Server 39 Configuring TM1 Clients 40 Configuring Web Components 40 Standard TM1 Web Installation 40 Chapter 5: Installing TM1 for 64-bit Windows

43

Custom 64-bit TM1 Installation 43 Configuring TCP/IP Ports for 64-bit TM1 43 Username and Password 43 Security Settings 44 Configuring the 64-bit TM1 Server 44 Standard 64-bit Installation 44 Chapter 6: Installing TM1 x86 on a x64 Windows System

47

WOW64 (32-bit) Application Space 47 Installation Notes about TM1 Components 47 Importance of Installation Order 48 Location of Installed TM1 Program Files 48 Naming Conventions for x86 and x64 TM1 Services 49 Installing TM1 x86 in Windows x64 49 Running the TM1 Database with Both x86 and x64 TM1 Servers 49 Chapter 7: Installing TM1 on UNIX

51

Pre-Installation Tasks 51 UNIX Installation Checklist 51 UNIX Compatible Components 52 Starting the Installation Wizard 52 Select a Language 53 Select TM1 UNIX Components 53 Accept the License Agreement 54 Set the Installation Location 54 Configure TCP/IP Ports 54 TM1 Server Configuration 55 Installation Summary 55 After You Complete the Installation 55 S89IBM_TM1 Startup Script 56 Uninstalling UNIX TM1 56 Silent UNIX Installation 57 Console Installation 57 Starting a UNIX TM1 Server 58 Running the UNIX TM1 Server in Background Mode 58 Chapter 8: Installing TM1 Workflow

59

Workflow Prerequisites 59 Licensing 59 Running the Workflow Installation Wizard 60 Selecting Workflow Installation Components 61 Workflow Components 61 Destination Folder for Workflow Components 62 Installing Workflow for the First Time 62

4 TM1

Table of Contents Installing Workflow for One Existing TM1 Database 62 Installing Workflow for Multiple TM1 Databases 62 Upgrading to Workflow from Planning Manager 1.3 63 Upgrading Planning Manager for One Existing TM1 Database 63 Upgrading Planning Manager for Multiple TM1 Databases 63 Configuring Workflow for Excel 64 Troubleshooting the Workflow Excel Add-in 65 Using Workflow with TM1 Web 65 Workflow On The Web 65 Workflow Features in TM1 Web 65 Localizing TM1 Web Toolbar Captions 65 Chapter 9: Using IBM Cognos 8 Security with TM1

67

IBM Cognos 8 Security Overview 67 Setting Up a TM1 Server to Use IBM Cognos 8 Security 68 Configuring the TM1 Server 68 Configuring the TM1 Client 70 Defining a Cognos User to Function as a TM1 Administrator 71 Importing Cognos Groups into TM1 72 Creating Users 72 Administering TM1 Object Security 73 Configuring TM1 Web to Use IBM Cognos 8 Security 73 Logging in to TM1 Top 73 User Considerations When Using IBM Cognos 8 Authentication 73 Chapter 10: Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services Configure TM1 to use IBM Cognos 8 Security 75 Install the TM1 Viewer Portlets 75 Configure Access to IBM Cognos 8 From the TM1 Viewer Portlets 76 Uninstall the TM1 Viewer Portlets 76 Chapter 11: Maintaining and Upgrading Your TM1 Installation Maintaining TM1 Components 77 Modify Components 77 Repair the TM1 Installation 78 Remove TM1 79 Upgrading TM1 79 Backing Up Your TM1 Data 79 Restoring Your TM1 Database 79 Index

75

77

81

Installation Guide 5

Table of Contents

6 TM1

Introduction
This manual describes how to install the IBM Cognos TM1 software components on Windows and UNIX operating systems. Business Performance Management is the continuous management and monitoring of Financial, Operational, Customer and Organizational performance across the enterprise. Business Performance Management solutions have the following capabilities to facilitate the proactive steering of business direction: Wide deployment Collaborative decision making Continuous and real-time review and refinement Monitoring of Key Performance Indicators

IBM Cognos TM1 integrates business planning, performance measurement and operational data to enable companies to optimize business effectiveness and customer interaction regardless of geography or structure. TM1 provides immediate visibility into data, accountability within a collaborative process and a consistent view of information, allowing managers to quickly stabilize operational fluctuations and take advantage of new opportunities.

Audience
To use this guide, you should be familiar with your TM1 system and network requirements and having a basic understanding of programming and installation concepts.

Related Documentation
Our documentation includes user guides, getting started guides, new features guides, readmes, and other materials to meet the needs of our varied audience. The following documents contain related information and may be referred to in this document. Note: For online users of this document, a Web page such as The page cannot be found may appear when clicking individual links in the following table. Documents are made available for your particular installation and translation configuration. If a link is unavailable, you can access the document on the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).

Document
IBM Cognos TM1 AP1

Description
Describes the functions and features of the IBM Cognos TM1 API. The API is intended to give complete access to all the features and functionality of the TM1 OLAP engine. Describes how to create and maintain objects on a TM1 server, administer security, and develop TM1 applications.

IBM Cognos TM1 Developers Guide

Installation Guide 7

Introduction

Document

Description

IBM Cognos TM1 Opera- Provides a basic understanding of TM1 architecture, server operations, tions Guide authentication, and component security. IBM Cognos TM1 Refer- A collection of reference materials that describes TM1 functions, ence Guide variables, and other programming elements. IBM Cognos TM1 Rules Guide Describes how to use TM1 rules to build an application that reveals business data in sophisticated and useful ways based on simple raw data. Describes how to use TM1 TurboIntegrator to import data and metadata into TM1 from a variety of sources. Describes how to use the TM1 Windows clients: TM1 Architect, TM1 Perspectives, and TM1 Client. It also describes the Web-based client, TM1 Web.

IBM Cognos TM1 TurboIntegrator Guide IBM Cognos TM1 Users Guide

Finding Information
Product documentation is available in online help from the Help menu or button in IBM Cognos products. To find the most current product documentation, including all localized documentation and knowledge base materials, access the IBM Cognos Resource Center (http://www.ibm.com/software/ data/support/cognos_crc.html). You can also read PDF versions of the product readme files and installation guides directly from IBM Cognos product CDs.

Getting Help
For more information about using this product or for technical assistance, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html). This site provides information on support, professional services, and education.

Printing Copyright Material


You can print selected pages, a section, or the whole book. You are granted a non-exclusive, nontransferable license to use, copy, and reproduce the copyright materials, in printed or electronic format, solely for the purpose of operating, maintaining, and providing internal training on IBM Cognos software.

8 TM1

Chapter 1: TM1 Installation Overview


The TM1 Installation Wizard is designed to help you install TM1 software into the hardware environment you have configured for your TM1 applications. TM1 is organized into three installation packages: TM1 - This installation package installs, by default, all major TM1 components with the exception of TM1 Web and several minor components. Typically, you would choose this installation option when you want to install various TM1 components in a distributed environment. It also enables you to install multiple TM1 servers (to a maximum of 3) on the same computer in a single installation session. For more information, see "Installing TM1" (p. 19). TM1 Perspectives - TM1s Excel add-in client. TM1 Perspectives enables you to use the familiar and powerful features of Excel to perform complex analysis on data stored in a TM1 server. Typically, you would choose this installation option if you want to install TM1 Perspectives on a single stand-alone development machine. TM1 Perspectives installs with its own local TM1 server or it can connect to a remote TM1 server installed on another computer in your environment. For more information, see "Installing TM1 Perspectives" (p. 31). TM1 Web - This installation package installs, by default, all major TM1 components, plus TM1 Web server and client components. Choose this option if your users will be connecting to TM1 servers using the TM1 Web client. For more information, see "Installing TM1 Web" (p. 35).

When you install TM1, you can click the Help button at the lower left corner of the TM1 Installation Wizard for context-sensitive assistance. Use the Table of Contents, Index, and Search tabs to navigate the help system and locate a particular topic.

Tab
Before You Install

Topic
Installation Checklist TM1 Service Account Hardware and Software Logging Installation Messages Installing Components on Different Machines

Installation Guide 9

Chapter 1: TM1 Installation Overview

Tab
Running the Wizard

Topic
Starting the Installation Wizard Choose Setup Language Accept the License Agreement Choose a Product to Install Installation Location Custom or Standard Installation Options

Installing TM1 Products

Installing TM1 Perspectives Installing TM1 Installing TM1 Web Installing TM1 for 64-bit Windows Installing TM1 x86 on a x64 Windows System Installing TM1 on UNIX Installing TM1 Workflow

Additional Topics

Maintaining and Upgrading Your TM1 Installation

Note: Installation Wizard error messages are displayed in English. If you are upgrading to a newer version of TM1, see "Upgrading TM1" (p. 79).

Installation Checklist
To prepare to install TM1, you should complete the tasks described in the following checklist: Familiarize yourself with TM1 terms and concepts. See the IBM Cognos TM1 Users Guide and the IBM Cognos TM1 Developers Guide. Determine which components you want to install and how they should be distributed across your hardware environment. In a production environment, TM1 components are usually distributed across multiple computers. See the IBM Cognos TM1 Operations Guide for details on how to design the optimal TM1 environment. Determine your hardware and software requirements.

Component
Operating Systems (Clients)

Specification
Windows Vista Windows XP (Intel 32-bit)

10 TM1

Chapter 1: TM1 Installation Overview

Component

Specification
iMac (OS X) for TM1 Web

Web Browsers

Internet Explorer 6.x/7 for TM1 Web Firefox 2.0 for TM1 Web

Operating Systems (Servers)

Windows 2003 R2 (Intel 32-bit) Windows 2003 R2 x64 (64 bit) (see note 4) Solaris 10 Sparc (64-bit) AIX 5.3

Web Servers Databases

IIS (ASP) V6 32-bit and 64-bit MS SQL 2005 Oracle 10g/11g DB2 9.5 and 9.1

Notes: 1. Architect/Perspectives require Excel 2002 (XP), 2003 or 2007. Note: Excel XP (2002) is in Microsoft extended support. Cognos will make a best effort to address any issues but may be limited by the support available through Microsoft. ODBO support via Excel 2007 Pivot tables is not supported. Advanced Rules Editor requires .NET Framework 2.0 on the client. 2. Cognos TM1 Connector for use with SAP BW - BW version 3.5 and Netweaver BI 7 supported. 3. For TM1 Web Excel 2003 or 2007 (with latest service pack) recommended on the Web Server. (Excel 2002 supported - see release notes for installation note); Web Application requires .NET 3.0. 4. For Windows 2003 R2 x64 on the Microsoft supported processors - Microsoft lists support for AMD Opteron, AMD Athlon 64, Intel Xeon with Intel EM64T or Intel 64, and Intel Pentium with Intel EM64T or Intel 64 (see MS site http://www.microsoft.com/ windowsserver2003/64bit/x64/enterprise.mspx). 5. TM1 Workflow is only localized currently into English, French and German. If you plan to import data from another relational database, install your database software first.

Installation Guide 11

Chapter 1: TM1 Installation Overview If you are running Oracle on UNIX, install the appropriate UNIX client software for your Oracle database on the UNIX machine. Use the Oracle Network Configuration Assistant to specify a local net service name. For more information, see "Installing TM1 on UNIX" (p. 51). Decide what language to set as the default for the installation. You can choose from a variety of currently available languages. Your choice of language determines the language in which the Installation Wizard runs. It also determines the language in which TM1 components will run. Create your TM1 Service Account. Before you install TM1, we recommend that you create a single domain account for all your Windows-based TM1 Services.

TM1 Service Account


Before you install TM1, we recommend that you create a single domain account for all your Windows-based TM1 services, such as the TM1 Server, TM1 Admin Server, and TM1 Excel Service. The account should be a member of the Local Administrator group and must have the following privileges on the local machine: Act as part of the operating system Bypass traverse checking Increase quotas Replace a process level token Log on as a service Have read privileges on the Windows Registry item

The Installation Wizard will enable and use these privileges during the installation process. This account applies only to Windows-based services and agents. TM1 services installed on Solaris or HP/UX always run as ROOT.

.NET Framework Requirements


The TM1 Rules Editor requires the installation of the Microsoft .NET Framework Version 3.0. You can download it from the Microsoft (c) website. When you install a message appears to remind you of this requirement. To ensure that the .NET Framework 3.0 is properly installed and registered on your computer, perform these steps.

Steps
1. Open a Command Prompt window and navigate to the following directory: C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727

12 TM1

Chapter 1: TM1 Installation Overview 2. Execute the following command: aspnet_regiis.exe -i For a complete list of supported platforms and software, refer to the TM1 platform matrix available on the IBM Cognos Resource Center http://www.ibm.com/software/data/support/ cognos_crc.html.

Microsoft ASP .NET Framework 3.0 is not Registered


If you do not perform the previous steps, or for some reason the Microsoft ASP.NET Framework 3.0 is installed but not registered on your computer, you may receive the following error when you install TM1: Error 1720: There is a problem with this Windows Installer package. A script required for this install to complete could not be run. Contact your support personnel or package vendor. This error may also display if Microsoft Internet Information Services (IIS) is not installed on your computer. If you experience this error, follow these steps to correct the error and successfully install TM1.

Steps
1. Uninstall TM1 using Add/Remove Programs in the Windows Control Panel. 2. Make sure Microsoft Internet Information Services (IIS) is installed on your system. You can check this by using the Add/Remove Windows Components feature. 3. Manually register the Microsoft ASP.NET Framework. For more information, see ".NET Framework Requirements" (p. 12). 4. Run the TM1 Installation Wizard again.

Enable TM1 Excel Service


If the .NET Framework is not installed before you install TM1 Web, the TM1 Excel Service will be disabled when you complete the TM1 Web installation. This service provides critical TM1 Web functionality, and you must complete the following steps to set the service Startup property to Automatic after you install the .NET Framework.

Steps
1. Open the Windows Control Panel. 2. Double-click Administrative Tools. 3. Double-click Services. 4. Double-click TM1 Excel Service. 5. Change the Startup Type from Disabled to Automatic. 6. Click OK.

Installation Guide 13

Chapter 1: TM1 Installation Overview Additionally, if you plan to run TM1 Web you must install Microsoft Excel 2002 or Excel 2003 on the same machine where the IIS web server is installed. If Excel 2002 or 2003 is not present on the machine where the IIS web server is installed, the TM1 Web installation displays a warning message, but allows you to continue the installation.

ASPNET User is not Defined


If you attempt to install TM1 Web on a system where the Microsoft .NET Framework is not yet installed, the TM1 Web installation will fail if the ASPNET user is not defined on the system. Error 1609: An error occurred while applying security settings. ASPNET is not a valid user group. This could be a problem with the package, or a problem connecting to a domain controller on the network. Check your network connection and click Retry, or Cancel. You must define the ASPNET user before you install TM1 Web. Follow these steps to create the ASPNET user.

Steps
1. Open the Windows Control Panel. 2. Double-click Administrative Tools. 3. Double-click Computer Management. 4. Click Local Users and Groups. 5. Right-click Users and select New User. The New User dialog box displays. 6. Configure the dialog box as follows, using a password of your choice.

7. Click Create.

14 TM1

Chapter 1: TM1 Installation Overview

Logging Installation Messages


The TM1 Installation Wizard automatically logs all messages issued during installation. Logged messages provide you with a record of: installation options installation actions location of all files installed by TM1 error messages final installation status (successful/not successful)

The log file is named TM1Install.log. It is written to the directory identified by your TEMP user environment variable. The log file remains until the next time you run an install. To determine the location of this directory you can issue the command echo $TEMP (UNIX) or echo %TEMP (Windows) or complete the following steps.

Steps
1. Open the Windows Control Panel. 2. Double-click System. 3. Click the Advanced tab. 4. Click Environment Variables. Find the TEMP variable in the list of user variables for the directory location of TM1Install.log.

Installing Components on Different Machines


You can install TM1 components on different machines in your hardware environment. For each component you want to install on a different machine, run the TM1 Installation Wizard on that machine. If you distribute components throughout your network, you must know certain information about where your components will be installed, and the configuration of those components. The following list provides information about what you need to know to install each component.

Component
TM1 Server

Description
To install the TM1 server, you must know the name of the machine on which the TM1 Admin Server is running. This can be installed without any knowledge of your network topology. To install the ODBC Gateway on separate machines, you must know the location of the Oracle client files, the Oracle Service Name, and the Oracle database username and password. Installation Guide 15

TM1 Admin Server ODBC Gateway

Chapter 1: TM1 Installation Overview

Important Notes on Distributed Installations


All services must be running under a single domain account. The TM1 Installation Wizard will set the parameters of the domain account for you, but you must create the account under which the services will run before you run the installation. If services are running under different accounts, they will not be able to communicate. This will lead to many problems. You can run services under the local system account only if all TM1 Services are running on the same machine. TM1 services must run on machines set to the same locale. You cannot, for example, install some services on a machine running the US English locale, and other services on a machine running the German locale. Set the locale using the Standards and Formats option in Windows Start Menu, Regional and Local Settings.

Starting the Installation Wizard


The installation wizard will guide you through the installation process.

Steps to Install TM1


1. Insert the TM1 CD you received in the drive or navigate to the folder where you downloaded the installation kit. 2. Locate and run the setup.exe file.

Steps to Choose a Setup Language


1. Click on the drop-down menu to choose one of the currently available languages. Your choice determines the language in which the TM1 Installation Wizard runs. It also determines the language in which TM1 components will run. 2. Click OK. The TM1 Installation Wizard starts. 3. If you are upgrading from a previous version of TM1, a message displays reminding you to create backup copies of your data before installing a new version that may not be compatible with earlier data. If you need to take this step, you can cancel out of the installation on the next dialog box. See "Maintaining and Upgrading Your TM1 Installation" (p. 77) for more details. 4. If you are ready to proceed with the installation, click Next.

Accept the License Agreement


The Software License Agreement is a legal agreement that describes the obligations of the licensor and your rights (the licensee). Read this agreement in full before proceeding with the installation of TM1 products. Use the Print button to print a copy of the license agreement if desired.

16 TM1

Chapter 1: TM1 Installation Overview To accept the license terms and continue with the installation, select I accept the terms of the license agreement, then click Next.

Choose a Product to Install


Select the installation package you want and click Next. You can choose from TM1 Perspectives - the standalone personal edition of TM1 TM1 - the TM1 server and clients TM1 Web - the TM1 server and clients, plus components for displaying TM1 data in a web browser

Microsoft Framework Reminder


A dialog box may display to remind you that the TM1 Rules Editor requires the installation of the Microsoft .NET Framework Version 3.0. See ".NET Framework Requirements" (p. 12) for more information. You can install the .NET Framework after the installation is complete. Click OK to proceed.

Custom or Standard Installation Options


Once you have selected an installation package, you can choose to perform a Standard or Custom installation. Use the Standard installation, see "Standard TM1 Installation" (p. 28), to perform an installation in single machine environment or when you want to install the default components using the default settings. See "Username and Password for TM1 Services" (p. 22) for the next step in the Standard installation process. A Custom installation, see "Custom TM1 Components" (p. 19), lets you select and configure the specific components in single or multiple machine environments. When the Back button is available, you can use it to back up through the installation prompts and change the choices made thus far. Click Cancel to exit the installation. Click Next to proceed to the next installation screen. Click Change to change the default installation location.

Installation Guide 17

Chapter 1: TM1 Installation Overview

Installation Location
In most installations, the default installation directory for TM1 is C:\Program Files\Cognos\TM1. If you perform a custom installation and choose to install only TM1 Web, the default installation directory is C:\Inetpub\wwwroot\TM1Web.

Steps
1. To change the default location where TM1 installs, click on the Change button. The Installation Location screen displays. 2. Navigate to the directory where you want to install and click OK.

Selecting Components to Install


If you choose Custom, you can specify which components to include in your installation. See the components list for "Installing TM1 Perspectives" (p. 31), "Installing TM1" (p. 19), or "Installing TM1 Web" (p. 35) for details. See "Installing TM1 for 64-bit Windows" (p. 43), "Installing TM1 x86 on a x64 Windows System" (p. 47), or "Installing TM1 on UNIX" (p. 51) for details on installing in those environments. See "Installing TM1 Workflow" (p. 59) for information about installing the TM1 Workflow component. Click the drop-down menu next to a component name to include or exclude a component:

Icon

Description
This feature will be installed on local hard drive. Select this option to include an individual component in the TM1 installation. This feature, and all subfeatures, will be installed on local hard drive. Select this option to include all components in a category for installation. For example, if you choose this option for the Clients, all components listed under Clients are included in the installation. This feature will not be available. Select this option to exclude a component from the TM1 installation. Components that are excluded from installation display with an X next to the component name.

+ (plus sign)

Expand selection. For components with subfeatures click + to expand the list.

18 TM1

Chapter 2: Installing TM1


This chapter describes how to install TM1 components using either the Standard or Custom installation options. For more information, see "Standard TM1 Installation" (p. 28) and "Custom TM1 Installation" (p. 19). "Custom TM1 Installation" (p. 19) "Custom TM1 Components" (p. 19) "Configuring TCP/IP Ports for TM1" (p. 21) "Username and Password for TM1 Services" (p. 22) "Installing TM1 on Networks without Domains" (p. 23) "Configuring the TM1 Server" (p. 25) "Configuring TM1 Clients" (p. 26) "Begin the Installation" (p. 27) "Post-Installation Tasks" (p. 27) "Standard TM1 Installation" (p. 28)

To run the Installation Wizard and install TM1 components, follow these steps.

Steps
1. After you have answered the introductory prompts. For more information, see "Standard TM1 Installation" (p. 28). The Choose a Product to Install screen displays. 2. Select TM1 and click Next.

Custom TM1 Installation


Use the Custom TM1 installation to select which TM1 components to install. A Custom installation also lets you specify the TM1 security model you want to use, and lets you set parameters such as server names and port numbers.

Custom TM1 Components


The following components are available as part of a TM1 Custom installation.

Installation Guide 19

Chapter 2: Installing TM1

Component

Installed Description by default


Yes TM1 Client Runs as an add-in to Microsoft Excel and provides limited access to data on remote TM1 Servers. Yes TM1 Perspectives Runs as an add-in to Microsoft Excel. With TM1 Perspectives, you can create and maintain objects and data on both local and remote TM1 Servers. Yes OLEDB Provider Installs the TM1 OLEDB for OLAP provider. The TM1 OLEDB Provider enables TM1 to perform MDX queries against OLAP data sources such as Microsoft Analysis Services.

Clients

Developers Environ- Yes ment

TM1 Architect A stand-alone TM1 client used to create and maintain data and metadata on both local and remote TM1 servers.

Yes

TM1 API Application programming interface that developers use to create C++ and VB applications that interact with TM1.

Yes

TM1 Java API Application programming interface that developers use to create Java applications that interact with TM1.

Yes

TM1 .NET API Application programming interface that developers use to create .NET applications that interact with TM1.

Servers

Yes

TM1 Admin Server A process that keeps track of all TM1 servers running on a network. An Admin Server runs on a computer known as an Admin Host. When a TM1 server starts, the server registers itself with an Admin Server that is running on a specified Admin Host. TM1 clients reference the Admin Server to determine which TM1 servers are available on the network.

20 TM1

Chapter 2: Installing TM1

Component

Installed Description by default


Yes TM1 Server The TM1 Server manages requests from TM1 clients. It loads the names of all available permanent objects (cubes, dimensions, etc.) into memory and responds to client requests by performing calculations, consolidations, and updates as required. The TM1 Server also manages security--granting or denying access to server objects and maintaining a log of changes to the database. No TM1 Web Components Installs TM1 Web server components required to access TM1 servers and data using a web browser. These components are selected for installation by default only as part of a TM1 Web installation. Yes TM1 Top A TM1 utility that enables you to dynamically monitor threads running in an instance of a Windows or UNIX TM1 server. TM1 Top runs only on a Windows system and is available only with the Windows installation of TM1. Note: To monitor a UNIX TM1 server, use the TM1 Installation Wizard to install TM1 Top on a Windows system and then configure TM1Top to connect to the UNIX TM1 server. When the ADMINHOST and SERVERNAME parameters are pointing to a UNIX machine, TM1 Top will monitor the UNIX environment. See the IBM Cognos TM1 Operations Guide for details on configuring the TM1Top.ini file.

Configuring TCP/IP Ports for TM1


Use the TCP/IP Port Configuration screen to specify the TCP/IP port number for the programs listed in the following table.

Program
TM1 Admin Host port number

Description
5495 is the port number on which the Admin Server on this machine listens for client requests.

Installation Guide 21

Chapter 2: Installing TM1

Program

Description

TM1 SSL Admin server port number 5498 All TM1 components communicate with the TM1 Admin Server using SSL. The Admin Server supports older TM1 clients that cannot use SSL by listening on two ports; one secured, the other unsecured. See "SSL and TM1" (p. 22) for more information. TM1 Client Message port number 12346 This port number establishes a secondary port for progress messages to use when a lengthy operation is waiting to be cancelled.

SSL and TM1


TM1 clients that can use SSL connect to the Admin Server via the secured port, while older clients that are incapable of using SSL to connect to the Admin Server via the unsecured port. When a TM1 server registers with the Admin Server, the TM1 server specifies whether it is using SSL or not. When a TM1 client contacts the Admin Server, the list of available TM1 Servers will vary according to which port the client uses to connect to the Admin Server. If the client uses the secured port, the Admin Server responds with a list of all TM1 servers available on the network. If the client uses the unsecured port, the Admin Server responds with a list of only those TM1 servers that do not use SSL.

Username and Password for TM1 Services


On Windows, all TM1 services must run under a single domain account. The TM1 Installation Wizard will configure the services to run under the domain account you specify.

Account
Username

Description
Specify a domain account using the syntax domain\username. For example: Company\nolan Note: Running TM1 services under the local system account is not recommended. Windows places restrictions on this account that may cause the TM1 software to operate incorrectly.

Password

Enter the password for the domain account that logs in and starts services. Re-enter your password to confirm correct entry.

Re-enter password

22 TM1

Chapter 2: Installing TM1 When you install TM1 in a distributed environment, where some components reside on one machine and some components on another, you must enter the same user name and password each time you run the installation. For more information, see "Installing TM1 on Networks without Domains" (p. 23).

Installing TM1 on Networks without Domains


If you install TM1 in a network that does not use a domain controller, you can set your TM1 services to use local accounts. If you use one or more local accounts for your TM1 services, you must be sure these accounts have the following privileges on their local machines: Act as part of the operating system Bypass traverse checking Increase quotas Replace a process-level token Log on as a service

If you set up file shares in your Windows network for use by TM1 components, be sure that each local account that you set up to run a TM1 service has access to those shares. Note: If you install on a machine that does not participate in a Windows domain, you cannot use Integrated Login. For more information, see "Security Settings" (p. 23).

Using Local Machine Syntax


Do not use "." as an abbreviation for the local machine domain when you specify login information. You must explicitly enter the machine name. In certain configurations, using the ".\username" syntax may cause serious problems.

Security Settings
Use the Security Settings screen to select one of three authentication modes for TM1.

Authentication Mode
Integrated Login

Description
Integrated Login enables TM1 users to automatically log in to TM1 components using their Windows login user name and password. If you choose to use Integrated Login, it runs in mixed mode by default. TM1 Authentication requires users to enter a username and password when they log into a TM1 component. When this authentication mode is used, usernames and passwords are stored on a TM1 server.

TM1 Authentication

Installation Guide 23

Chapter 2: Installing TM1

Authentication Mode
LDAP Authentication

Description
Use LDAP Authentication to centralize all your security information on a single LDAP server. When a TM1 user attempts to log in to TM1, his username and password are validated against the information stored on an LDAP server. If you choose to use LDAP Authentication, you must also supply values for LDAP Host and LDAP Port.

LDAP Port

The port on which the LDAP server is running. If a port is not specified, 389 (the standard LDAP default) is used. The domain name or dotted string representation of the IP address of the LDAP server host. If you do not enter an LDAP server host, 'localhost' is used by default. The node in the LDAP tree at which the search for the TM1 user being validated begins. For example, if the LDAP distinguished name for an individual TM1 user is in the form uid=nolan,ou=people,o=company.com, then the LDAP search base would be ou=people,o=company.com. Generally, the search base is one level above the node containing distinguished names for TM1 users in the LDAP directory hierarchy.

LDAP Host

LDAP Search Base

LDAP Search Field

The name of the LDAP attribute that is expected to contain the name of the TM1 user being validated. If you do not specify an attribute, cn (common name) is the default.

Integrated Login Modes


When Integrated Login is enabled, it runs in mixed mode by default. Integrated Login can also be configured to run in Integrated Login Only mode by modifying appropriate parameters in the Tm1s.cfg file. The two Integrated Login modes are described in the following table.

Login Mode
Mixed mode

Description
If client programs are set up to use Integrated Login, TM1 tries to log users into the TM1 components using their Windows user name and password. If a TM1 client is not set up to use Integrated Login, the user is prompted by TM1 for a user name and password.

24 TM1

Chapter 2: Installing TM1

Login Mode
Integrated Login Only

Description
Only TM1 clients set up to use Integrated Login will be allowed to log in to TM1 components. If a client is not set up for Integrated Login, the TM1 server displays an error and the user will not be allowed access the component.

For further details on Integrated Login, including details on server and client configuration parameters, see the IBM Cognos TM1 Operations Guide.

Changing Security Parameters


Once you have installed and set your TM1 authentication mode, you cannot modify it using the TM1 Installation Wizard. You must completely uninstall and then reinstall TM1. For further information about TM1 login authentication modes, including details on server and client configuration parameters, see the IBM Cognos TM1 Operations Guide.

Configuring the TM1 Server


Use the TM1 Server Configuration screen if you install multiple TM1 servers. You must assign a unique name and port number to each server. You can install up to three TM1 servers in one installation session.

Server Settings
Choose Database

Description
Select the database you want to install with the TM1 server. Click Apply after you select a database to set the server name and data directory path for the selected database. To install the Planning Sample database, select Planning Sample from the drop-down and click Apply. This updates the Server Name with Planning Sample. To install the Sample database, select Sample Database then click Apply to update Server Name with SData. To create an empty data directory where you can install your own custom data, select Custom. Then enter the Server Name to use. Click Change Data Directory to indicate the location of the custom data directory. Click Apply to update the fields.

Server Name

The name you want to use to identify the TM1 server.

Installation Guide 25

Chapter 2: Installing TM1

Server Settings

Description

Admin Server Host Machine Name The name of a computer on which a TM1 Admin Server is installed. When a TM1 server is running, it registers itself on this Admin Server. TM1 clients connect to this Admin Server to obtain information about TM1 servers available on a network. Port Number The port on which the TM1 server runs. This parameter is used to distinguish multiple TM1 servers running on the same computer. Valid port values fall between 5000 and 49151. The default is 12345. Click to change the data directory for the server you are installing. Select this option to configure another TM1 server during this installation session.

Change Data Directory

Configure Another TM1 Server

Configuring TM1 Clients


Use the TM1 Client Configuration screen to specify client parameters. Each client installation has its own Tm1p.ini file to which the values you set during installation are written.

Client Parameters

Description

Admin Server Host Machine Name The name of a computer on which a TM1 Admin Server is installed. When a TM1 server is running, it registers itself on this Admin Server. TM1 clients connect to this Admin Server to obtain information about TM1 servers available on a network. This option is not offered during a Perspectives installation as the Admin Server always runs on the same machine as the TM1 Server and Client. Disable Excel Edit in Cell Capability The Disable Excel Edit in Cell option is selected by default as it prevents users from accidently overwriting formulas in slice worksheets. We recommend that this option remains selected. Set TM1 to Autoload in Excel Select this option to automatically load the TM1 add-in (Tm1p.xla) when Excel starts. Clear this option to enable a user to manually launch TM1 after Excel starts.

26 TM1

Chapter 2: Installing TM1

Client Parameters
Use Integrated Login

Description
Select this option to enable Integrated Login for the client. Integrated Login allows you to log in to TM1 components using your Windows user name and password, without the need to complete a login dialog box. Clear the option to disable Integrated Login. Note: TM1 servers and components can be configured to refuse connections from clients that do not use Integrated Login. If servers and components on your system are configured this way, TM1 must use Integrated Login to access the components.

Begin the Installation


When all the setting have been made, a confirmation screen displays to reminds you that you can use Back to return through the installation settings before the installation commences. When you are ready to proceed with the installation, click Install. To prevent TM1 from being installed, click Cancel.

Post-Installation Tasks
Once the installation is complete, a confirmation screen displays. Complete Post-Installation Tasks Start Services Start a TM1 Server Installed as a Service or Application

Start Services
Once you have successfully installed TM1 you must start the following services:

Service
TM1 Admin Server TM1 Excel Service

Description
Service that manages the TM1 servers Handles requests to convert Excel files into XML format. It also handles requests to create Briefing Books, print to PDF, and slice a TM1 view into Excel. Services requests from TM1 clients by loading shared cubes into memory, managing security, sending data to spreadsheets, updating cubes on request, and maintaining a log of changes to the database. The TM1 Server will have the name of your server appended, such as TM1 Server Planning Sample, TM1 Server SData, etc.

TM1 Server

Installation Guide 27

Chapter 2: Installing TM1

Start a TM1 Server Installed as a Service or Application


To start a TM1 server that has been installed as a service, follow these steps.

Steps
1. Double-click the Windows Services icon from the Start Programs, Control Panel, Administrative Tasks menu. A list of installed services displays. 2. Select the entry for the TM1 server you want to start, for example TM1 Server - Planning Sample, and click the Start button. An Admin Server must be running before a TM1 server can start. If you have specified an Admin Host in the Tm1s.cfg file, the TM1 server will attempt to connect to an Admin Server on that host. The TM1 server will fail to start if it is unable to connect to an Admin Server for any reason. If you have not specified an Admin Host, the TM1 server attempts to connect to an Admin Server on the local machine. If an Admin Server is not currently running on the local machine, either as a service or an application, the TM1 server starts a new Admin Server application and connects to it. To start a remote server that has been set up as a Windows application, double-click the shortcut icon for the server you want to start.

Standard TM1 Installation


A Standard TM1 installation installs the following components. For a full description of these components, see "Custom TM1 Components" (p. 19).

Component

Installed by default
Yes

Description

Clients

TM1 Perspectives TM1 API TM1 Java API TM1 .NET API SSL TM1 Admin Server TM1 Server (local)

Developers Environment Yes Yes Yes Yes Servers Yes Yes

A Standard TM1 installation uses the following default values:

28 TM1

Chapter 2: Installing TM1

Item
Admin Server port # SSL port # TM1 server port # TM1 Client Message port number TM1 server name Admin Server host name Sample data directory for TM1 server

Default Value
5495 (unsecured) 5498 (secured) 12345 12356 SData Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\TM1Data\ PlanSamp C:\Program Files\Cognos\TM1\Custom\TM1Data\Pdata

Sample data directory for TM1 Perspectives/TM1 Architect Security mode

A Standard installation uses TM1 Authentication. Users must respond to a prompt for a user name and password when they login to TM1 components. A Custom installation gives you the option of using Integrated Login, which allows TM1 users to automatically login to TM1 components using their Windows login user name and password, or LDAP Authentication. For more information, see "Security Settings" (p. 23).

Disable Excels Edit Directly in Cell

Selected

Installation Guide 29

Chapter 2: Installing TM1

30 TM1

Chapter 3: Installing TM1 Perspectives


This chapter describes how to install TM1 Perspectives, the TM1 Excel Add-in, using the Standard or Custom installation. Topics include: "Custom TM1 Perspectives Installation" (p. 31) "Configuring TM1 Perspectives" (p. 32) "Standard TM1 Perspectives Installation" (p. 32)

Follow these steps to install TM1 Perspectives.

Steps
1. After you have answered the introductory prompts, see "Starting the Installation Wizard" (p. 16), the Choose a Product to Install screen displays. 2. Select TM1 Perspectives and click Next. 3. Choose Standard or Custom installation.

Custom TM1 Perspectives Installation


Use the Custom TM1 Perspectives installation to select which TM1 components to install, and to configure Perspectives settings. See "Standard TM1 Perspectives Installation" (p. 32) for defaults set when you choose the Standard Perspectives installation. After choosing the Custom TM1 Perspectives installation, click Next to proceed to the Component Selection screen. The following components are available as part of a TM1 Perspectives Custom installation. For a full description of these components. See "Custom TM1 Components" (p. 19).

Component
Clients

Installed by default Description


No Yes TM1 Client TM1 Perspectives TM1 Architect TM1 API TM1Java API TM1 .NET API

Developers Environment No Yes Yes Yes

Installation Guide 31

Chapter 3: Installing TM1 Perspectives

Component
Servers

Installed by default Description


No No No No TM1 Admin Server TM1 Server TM1 Web Components TM1 Top

Configuring TM1 Perspectives


When you install TM1 Perspectives you must specify values for the following parameters on the TM1 Client Configuration screen, see "Configuring TM1 Clients" (p. 26). These values are written to the Tm1p.ini file. Disable Excel Edit in Cell Capability Set TM1 to Autoload in Excel Use Integrated Login

Standard TM1 Perspectives Installation


A Standard Perspectives installation installs the following components. For a full description of these components, see "Custom TM1 Components" (p. 19).

Component
Clients Developers Environment

Installed by default Description


Yes Yes Yes Yes Yes TM1 Perspectives TM1 API TM1 Java API TM1 .NET API SSL TM1 Admin Server TM1 server (local) port #

Servers

Yes Yes

A Standard installation uses the following default values. For more information, see "Configuring the TM1 Server" (p. 25).

32 TM1

Chapter 3: Installing TM1 Perspectives

Item
Admin Server port # SSL port # TM1 server (local) port # Admin Server host name

Default Value
5495 (unsecured) 5498 (secured) 12345 Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\ TM1Data\Pdata Selected.

Sample data directory for TM1 Perspectives

Disable Excels Edit Directly in Cell option

Installation Guide 33

Chapter 3: Installing TM1 Perspectives

34 TM1

Chapter 4: Installing TM1 Web


TM1 Web includes all components of TM1, plus additional functionality to browse and update TM1 data using a standard web browser. This chapter describes how to install TM1 Web on a network using either the Standard or Custom installation options. Topics include: "Custom TM1 Web Installation" (p. 35) "Configuring TM1 Web Components" (p. 35) "Configuring TCP/IP Ports for TM1 Web" (p. 38) "Username and Password for TM1 Services" (p. 38) "Security Settings" (p. 38) "Configuring Web Components" (p. 40) "Standard TM1 Web Installation" (p. 40)

Steps
1. After you have answered the introductory prompts, see "Starting the Installation Wizard" (p. 16). The Choose a Product to Install screen displays. 2. Select TM1 Web and click Next. 3. Choose Standard or Custom installation.

Custom TM1 Web Installation


Use the Custom TM1 Web installation to select which TM1 Web components to install. A Custom TM1 Web installation also lets you choose the security mode to use and lets you set parameters such as server names and port numbers. See "Standard TM1 Web Installation" (p. 40) for the defaults set when you choose a Standard Web installation.

Configuring TM1 Web Components


On the Component Selection screen, the components listed in the following table are available for a TM1 Web Custom installation.

Installation Guide 35

Chapter 4: Installing TM1 Web

Component

Installed by default
Yes

Description

Clients

TM1 Client Runs as an add-in to Microsoft Excel and provides limited access to data on remote TM1 Servers.

Yes

TM1 Perspectives Runs as an add-in to Microsoft Excel. With TM1 Perspectives, you can create and maintain objects and data on both local and remote TM1 Servers.

Yes

OLEDB Provider Installs the TM1 OLEDB for OLAP provider. The OLEDB Provider enables TM1 to perform MDX queries against OLAP data sources such as Microsoft Analysis Services.

Developers Environment

Yes

TM1 Architect A stand-alone TM1 client used to create and maintain data and metadata on both local and remote TM1 servers.

Yes

TM1 API Application programming interface that developers use to create C++ and VBapplications that interact with TM1.

Yes

TM1 Java API Application programming interface that developers use to create Java applications that interact with TM1.

Yes

TM1 .NET API Application programming interface that developers use to create .NET applications that interact with TM1.

36 TM1

Chapter 4: Installing TM1 Web

Component

Installed by default
Yes

Description

Servers

TM1 Admin Server A process that keeps track of all TM1 servers running on a network. An Admin Server runs on a computer known as an Admin Host. When a TM1 server starts, the server registers itself with an Admin Server that is running on a specified Admin Host. TM1 clients reference the Admin Server to determine which TM1 servers are available on the network.

Yes

TM1 Server The TM1 Server manages requests from TM1 clients. It loads the names of all available permanent objects (cubes, dimensions, etc.) into memory and responds to client requests by performing calculations, consolidations, and updates as required. The TM1 Server also manages security-granting or denying access to server objects and maintaining a log of changes to the database.

No

TM1 Web Components Installs TM1 Web server components required to access TM1 servers and data using a web browser. These components are selected for installation by default only as part of a TM1 Web installation.

Installation Guide 37

Chapter 4: Installing TM1 Web

Component

Installed by default
Yes

Description

TM1 Top A TM1 utility that enables you to dynamically monitor threads running in an instance of a Windows or UNIX TM1 server. TM1 Top runs only on a Windows system and is available only with the Windows installation of TM1. Note: To monitor a UNIX TM1 server, use the TM1 Installation Wizard to install TM1 Top on a Windows system and then configure TM1 Top to connect to the UNIX TM1 server. When the ADMINHOST and SERVERNAME parameters are pointing to a UNIX machine, TM1 Top will monitor the UNIX environment. See the IBM Cognos TM1 Operations Guide for details on configuring the TM1Top.ini file.

Configuring TCP/IP Ports for TM1 Web


Specify the TCP/IP port number for the following components: TM1 Admin Host port number TM1 SSL Admin server Port #

Username and Password for TM1 Services


See "Username and Password for TM1 Services" (p. 22) for details. If you install TM1 in a distributed environment, where some components reside on one machine and some components on another, you must enter the same user name and password each time you run the installation. See also "Installing TM1 on Networks without Domains" (p. 23).

Security Settings
Use the Security Settings screen to select one of three authentication modes for TM1.

Authentication Mode Description


Integrated Login Integrated Login enables TM1 users to automatically log in to TM1 components using their Windows login user name and password. If you choose to use Integrated Login, it runs in mixed mode by default. TM1 Authentication requires users to enter a username and password when they log into a TM1 component. When this authentication mode is used, usernames and passwords are stored on a TM1 server.

TM1 Authentication

38 TM1

Chapter 4: Installing TM1 Web

Authentication Mode Description


LDAP Authentication Use LDAP Authentication to centralize all your security information on a single LDAP server. When a TM1 user attempts to log in to TM1, his username and password are validated against the information stored on an LDAP server. If you choose to use LDAP Authentication, you must also supply values for LDAP Host and LDAP Port. The port on which the LDAP server is running. If a port is not specified, 389 (the standard LDAP default) is used. The domain name or dotted string representation of the IP address of the LDAP server host. If you do not enter an LDAP server host, "localhost" is used by default. The node in the LDAP tree at which the search for the TM1 user being validated begins. For example, if the LDAP distinguished name for an individual TM1 user is in the form uid=nolan,ou=people,o=company. com, then the LDAP search base would be ou=people,o=company.com. Generally, the search base is one level above the node containing distinguished names for TM1 users in the LDAP directory hierarchy. LDAP Search Field The name of the LDAP attribute that is expected to contain the name of the TM1 user being validated. If you do not specify an attribute, cn (common name) is the default.

LDAP Port

LDAP Host

LDAP Search Base

Once you have installed you cannot change your TM1 authentication mode by re-running the Installation Wizard. See "Changing Security Parameters" (p. 25) for more information. See also the IBM Cognos TM1 Operations Guide.

Configuring the TM1 Server


When you install a TM1 server you must specify values for the following parameters. These values are written to the Tm1s.cfg file, which resides in the TM1 data directory. If you install multiple TM1 servers, you must assign a unique name and port number to each server. You can install up to three TM1 servers in one installation session. Choose Database Server Name Admin Server Host Machine Name Port Number Change Data Directory Configure Another TM1 Server

Installation Guide 39

Chapter 4: Installing TM1 Web See "Configuring the TM1 Server" (p. 39) for information on loading sample databases.

Configuring TM1 Clients


When you install one or more TM1 clients you must specify values for the following client parameters. These parameters are written to the Tm1p.ini file. Admin Server Host Name Disable Excel Edit in Cell Capability Set TM1 to Autoload in Excel Use Integrated Login

Configuring Web Components


TM1 Web is delivered through Active Server Pages (ASP) and is supported only on Microsoft IIS. The default installation directory for the TM1 Web ASP files is the root directory of your IIS installation. If you installed IIS in the Microsoft IIS default installation directory, the TM1 Web default location is C:\Inetpub\wwwroot\TM1Web\.

Steps
1. To install IIS to a different directory, click Change and navigate to the new directory. Note: The Windows permissions on the directory into which you install the Web components must be set to Everyone. If the Windows permissions on this directory are restricted, the TM1 Web client may not be accessible to all users. When you install TM1 Web, TM1 installs Charts (c) technology. Dundas Charts (c) provides the charting functionality of TM1 Web. Dundas Charts (c) technology is delivered through two DLLs that are installed on your IIS web server: C:\Inetpub\wwwroot\TM1Web\bin\DundasWebChart.dll C:\Inetpub\wwwroot\TM1Web\DundasWinChart\DundasWinChart.dll

2. After specifying the TM1 Web directory, click Next to proceed to the next installation screen. 3. If prompted to shut down IIS, click OK.

Standard TM1 Web Installation


A Standard TM1 Web installation installs the following components. For a full description of these components, see "Custom TM1 Components" (p. 19).

Component
Clients

Installed by default
Yes Yes

Description
TM1 Client TM1 Perspectives

40 TM1

Chapter 4: Installing TM1 Web

Component

Installed by default
Yes

Description
TM1 OLE DB Provider TM1 Architect TM1 API TM1 Java API TM1 .NET API SSL TM1 Admin Server TM1 Server (local) TM1 Web Components (ASP script files and TM1ExcelService.exe) TM1 Top

Developers Environment

Yes Yes Yes Yes Yes

Servers

Yes Yes Yes Yes

Yes

A Standard TM1 Web installation uses the following default values. For more information, see "Configuring the TM1 Server" (p. 25).

Item
Admin Server port # SSL port # TM1 server port # TM1 server name Admin Server host name

Default Value
5495 (unsecured) 5498 (secured) 12345 SData Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\ TM1Data\PlanSamp C:\Program Files\Cognos\TM1Custom\TM1Data\ Pdata

Sample data directory for TM1 server

Sample data directory for TM1 Perspectives/TM1 Architect

Installation Guide 41

Chapter 4: Installing TM1 Web

Item
Security mode

Default Value
A Standard installation uses TM1 Authentication. A Custom installation gives you the option of using TM1 Authentication, Integrated Login or LDAP Authentication.

Disable Excels Edit Directly in Cell

Selected.

42 TM1

Chapter 5: Installing TM1 for 64-bit Windows


This chapter describes how to install TM1 for 64-bit Windows using either the Standard or Custom installation options. Custom 64-bit TM1 Installation topics include: "Configuring TCP/IP Ports for 64-bit TM1" (p. 43) "Username and Password" (p. 43) "Security Settings" (p. 44) "Configuring the 64-bit TM1 Server" (p. 44)

Note: To install TM1 x86 (32-bit) components on a 64-bit Windows system, you must use the TM1 x86 Installation Wizard. The TM1 x86 Installation Wizard includes 32-bit versions of the TM1 Admin Server, TM1 Server, TM1 Clients, and other TM1 components such as the TM1 Top utility and the TM1 .NET API. For details see "Installing TM1 x86 on a x64 Windows System" (p. 47). After you have answered the introductory prompts (see "Starting the Installation Wizard" (p. 16)), choose "Standard 64-bit Installation" (p. 44) or "Custom 64-bit TM1 Installation" (p. 43).

Custom 64-bit TM1 Installation


When you install the 64-bit Windows version of TM1, you can choose to install any of the following components:

Component
TM1 Admin Server TM1 Server

Installed by default
Yes Yes

Configuring TCP/IP Ports for 64-bit TM1


Specify the TCP/IP port numbers for TM1 Admin Host and TM1 SSL Admin server. See "Configuring TCP/IP Ports for TM1" (p. 21) for more information.

Username and Password


On Windows, all TM1 services must run under a single domain account. The TM1 Installation Wizard will configure the services to run under the selected account. See "Username and Password for TM1 Services" (p. 22) for details.

Installation Guide 43

Chapter 5: Installing TM1 for 64-bit Windows

Security Settings
You can select one of three authentication modes for TM1, Integrated Login, TM1 Authentication, LDAP Authentication. For more information, see "Security Settings" (p. 23). Once youve installed you cannot change your TM1 authentication mode by re-running the Installation Wizard. For more information, see "Changing Security Parameters" (p. 25). See also the TM1 Operations Guide.

Configuring the 64-bit TM1 Server


When you install a TM1 server you must specify values for the following server parameters. These values are written to the Tm1p,ini file, which resides in the TM1 data directory. To distinguish x64 sample databases from x86 databases of the same name which may have been installed, the sample 64-bit database names have x64 appended to them. The default path of the TM1 data directory on a 64-bit Windows system is C:\Program Files\Cognos\TM1\Custom \TM1Data\PlanSamp. If you install multiple TM1 servers, you must assign a unique name and port number to each server. You can install up to three TM1 servers in one installation session. For more information, see "Configuring the TM1 Server" (p. 25). When you configure the TurboIntegrator, enter these values: Gateway Host Username Password

Standard 64-bit Installation


A Standard 64-bit installation installs the following components. For more information, see "Custom TM1 Components" (p. 19).

Component
Servers

Installed by default
Yes Yes

Description
TM1 Admin Server TM1 Server (local)

A Standard TM1 installation uses the following default values:

Item
Admin Server port # SSL port # TM1 server port #

Default Value
5495 (unsecured) 5498 (secured) 12345

44 TM1

Chapter 5: Installing TM1 for 64-bit Windows

Item
TM1 server name Admin Server host name

Default Value
SData Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\ TM1Data\PlanSamp C:\Program Files\Cognos\TM1\Custom\ TM1Data\Pdata A Standard installation uses TM1 Authentication. A Custom installation gives you the option of using TM1 Authentication, Integrated Login or LDAP Authentication.

Sample data directory for TM1 server

Sample data directory for TM1 Perspectives/TM1 Architect Security mode

Disable Excels Edit Directly in Cell

Selected.

Installation Guide 45

Chapter 5: Installing TM1 for 64-bit Windows

46 TM1

Chapter 6: Installing TM1 x86 on a x64 Windows System


This chapter describes how to install both the x86 version of TM1 on a single, 64-bit Windows system, such as Windows Server 2003 x64 or Windows XP Professional x64. Topics include: "Importance of Installation Order" (p. 48) "Location of Installed TM1 Program Files" (p. 48) "Naming Conventions for x86 and x64 TM1 Services" (p. 49) "Installing TM1 x86 in Windows x64" (p. 49) "Running the TM1 Database with Both x86 and x64 TM1 Servers" (p. 49)

Note: Windows XP Professional x64 is not a server class operating system and is not a recommended platform for a TM1 production environment. However, in some situations, it may be used as an individual x64 development environment for TM1. After you have answered the introductory prompts. See "Starting the Installation Wizard" (p. 16) for more information. Choose Standard or Custom installation.

WOW64 (32-bit) Application Space


You can install any TM1 x86 (32-bit) components on an X64 machine into what is called the Microsoft WOW64 space.

Installation Notes about TM1 Components


The following table summarizes information you need to consider when you install and run the TM1 components on Windows x64 operating systems.

Component
TM1 Admin Server

Considerations
You can install both the x86 and x64 versions of the TM1 Admin Server, but only one of them can be active. For details, see "Importance of Installation Order" (p. 48). You can install and run multiple copies of both the x86 and x64 versions of the TM1 server on the same machine. The only exception is that each server has to be configured to a unique port number. For details, see "Running the TM1 Database with Both x86 and x64 TM1 Servers" (p. 49).

TM1 Server

Installation Guide 47

Chapter 6: Installing TM1 x86 on a x64 Windows System

Component
TM1 Clients

Considerations
There are currently no 64-bit TM1 client applications available.

TM1 Top utility and The TM1 Top utility and the TM1 .NET API are 32-bit applications and TM1 .NET API can be installed only into the WOW64 space using the TM1 x86 installation.

Importance of Installation Order


The order in which you install x86 and x64 versions of TM1 determines which TM1 Admin Server will take precedence: Both TM1 Admin Servers are installed as a Windows service and their active or non-active status is configured automatically during installation. The Admin Server which is installed first (x86 or x64) takes precedence. Any TM1 servers associated with this system will depend on the first installed Admin Server. An Admin Server from a second installation can be installed, but it will not be active. The TM1 servers will still depend on the first Admin Server. If the installation of the first Admin Server is removed, then the second TM1 Admin Server becomes active and supports the TM1 servers.

The active/non-active status of a TM1 Admin Server is determined by its Startup Type setting in Windows Services: The active Admin Server has its service Startup Type set to Automatic. The non-active Admin Server has its service Startup Type set to Disabled.

For example, if you install TM1 x64 first and install TM1 x86 second, the x64 Admin Server is set to Automatic and the x86 version will be Disabled in Windows Services. If you then uninstall TM1 x64, the dependencies for all the related TM1 servers are automatically redirected to the remaining x86 Admin Server.

Location of Installed TM1 Program Files


When you install applications on a x64 Windows system, the program files for 32-bit and 64-bit applications are installed into different directories as follows: 64-bit applications are installed to C:\Program Files 32-bit applications are installed to C:\Program Files(x86)

For example, if you select the default installation location when you install both versions of TM1, the TM1 program files are installed in the following directories: TM1 x64 default directory: C:\Program Files\Cognos\TM1

48 TM1

Chapter 6: Installing TM1 x86 on a x64 Windows System TM1 x86 default directory: C:\Program Files(x86)\Cognos\TM1

Naming Conventions for x86 and x64 TM1 Services


The TM1 Installation Wizard uses the following naming conventions when configuring the Windows Services for the x86 and x64 TM1 Admin Server and TM1 server.

Component
TM1 x86 Admin Server TM1 x64 Admin Server TM1 x86 servers

Naming Conventions
TM1 Admin Server TM1 Admin Server (x64) TM1 Server - DatabaseName Where DatabaseName is the name of the database you selected during the installation. For example: TM1 Server - Planning Sample.

TM1 x64 servers

TM1 Server - DatabaseName x64 Where DatabaseName is the name of the database you selected during the installation. For example: TM1 Server - Planning Sample x64.

Installing TM1 x86 in Windows x64


No special steps are required to install the x86, 32-bit version of TM1 in a Windows x64 environment. The 64-bit Windows system detects that the program being installed is a 32-bit application and automatically installs it into the WOW64 space. When you install the x86 TM1 server and/or x86 Admin Server in a Windows x64 environment, the necessary executable files are installed in the <TM1_install_dir>\bin directory, but the corresponding Windows services are not created by the installation program. This is to avoid conflict in the event that an x64 TM1 server and/or x64 Admin Server are installed on the same system. You can manually start the x86 server or Admin Server, or you can manually create new Windows services to manage these components.

Running the TM1 Database with Both x86 and x64 TM1 Servers
After you install any TM1 sample databases with the x86 and x64 versions of TM1, the port numbers for the databases are set to the same port by default. For example, if you want to run the

Installation Guide 49

Chapter 6: Installing TM1 x86 on a x64 Windows System Planning Sample database with both the x86 and x64 versions of TM1 server, you have to edit the port number in one of the Tm1s.cfg files to point to a different port number.

Steps
1. Locate the Tm1s.cfg file for the sample database that was installed with either the x86 or x64 TM1 version. For example, if you installed both versions of TM1 to their default locations, then the Tm1s.cfg file for the Planning Sample database is located in the following directories: For x86 TM1: C:\Program Files(x86)\Cognos\TM1\Custom\TM1Data\PlanSamp For x64 TM1: C:\Program Files\Cognos\TM1\Custom\TM1Data\PlanSamp 2. Open the Tm1s.cfg file with a text editor, such as Windows Notepad. 3. Locate the line of code where the PortNumber parameter is set, as shown below, and change the value to a another valid port number. When you install a TM1 server with the Planning Sample database, the default port number for the sample is set to 12345. Valid port numbers are between 5001 and 49151. 4. Save and close the Tm1s.cfg file. 5. In Windows Services, stop and then restart the associated TM1 server.

50 TM1

Chapter 7: Installing TM1 on UNIX


This chapter describes how to install TM1 on UNIX. "Pre-Installation Tasks" (p. 51) "Starting the Installation Wizard" (p. 52) "After You Complete the Installation" (p. 55) "S89IBM_TM1 Startup Script" (p. 56) "Uninstalling UNIX TM1" (p. 56) "Silent UNIX Installation" (p. 57) "Console Installation " (p. 57) "Starting a UNIX TM1 Server" (p. 58)

Pre-Installation Tasks
Before you install the TM1 software, you should be aware of the following: Your UNIX account must have root privileges to successfully run the installation. This installation will modify the /etc/services file. It will also add a startup script named S89IBM_TM1 to the /etc/rc2.d directory (Solaris and AIX) or the /sbin/rc3.d/ directory (HP/UX).

Additionally, the following requirements must be met to support the graphical user interface of the installation program: You must have X server software installed on the machine that will host your TM1 components. You must have X server client software installed on the machine from which you run the TM1 Installation Wizard. Your UNIX account must be able to create an X-Windows connection. On many systems, you control this through the utility XHOST.

TM1 provides a silent server installation and a console installation that does not require an X windows system. See "Silent UNIX Installation" (p. 57) and "Console Installation " (p. 57).

UNIX Installation Checklist


To prepare to install TM1, you should complete the tasks described in the following checklist: Familiarize yourself with TM1 terms and concepts. See the IBM Cognos TM1 Users Guide and the IBM Cognos TM1 Developers Guide.

Installation Guide 51

Chapter 7: Installing TM1 on UNIX Determine which components you want to install and how they should be distributed across your hardware environment. Only the TM1 server can be run on UNIX. You cannot run clients or TM1 Web on UNIX. See the IBM Cognos TM1 Operations Guide for details on how to design the optimal TM1 environment. Determine your hardware and software requirements. Refer to the TM1 platform matrix available on the IBM Cognos Resource Center http://www. ibm.com/software/data/support/cognos_crc.html for hardware and software requirements. If you plan to import data from another relational database, install your database software first. If you are running Oracle on UNIX, install the appropriate UNIX client software for your Oracle database on the UNIX machine. Use the Oracle Network Configuration Assistant to specify a local net service name. Check the X-server software on your UNIX machine. To run the Graphical User Interface UNIX Installation Wizard, X-server software must be installed on the machine that will host your TM1 components. You must have X-server client software installed on the machine from which you run the TM1 Installation Wizard. If X-server software is not installed on the UNIX machine, run the console installation. For more information, see "Console Installation " (p. 57).

UNIX Compatible Components


Some TM1 components run only on Windows, so your TM1 system will be running in a heterogeneous environment. The following table shows each TM1 component and the operating system on which that component is supported. See also "Installing Components on Different Machines" (p. 15).

Supported on UNIX and Windows


TM1 Server TM1 Admin Server ODBC Gateway

Supported only on Windows


TM1 Architect TM1 Client TM1 Perspectives TM1 Web client TM1 Web server components

Starting the Installation Wizard


Before you start the Installation Wizard, be sure to read "Pre-Installation Tasks" (p. 51), which lists account requirements that you must fulfill to successfully install this software.

52 TM1

Chapter 7: Installing TM1 on UNIX Follow these steps to start the Installation Wizard.

Steps
1. Change directories to your CDROM directory, for example, cd /cdrom 2. Start the Installation Wizard by entering the installation command for your operating system:

Operating System
Sun Solaris AIX HP/UX

Installation Command
./install_solaris.bin ./install_aix.bin

Not supported in TM1 9.4 MR1

The IBM Cognos TM1 Installation Wizard starts.

Select a Language
You can choose from a variety of currently available languages. Your choice of language determines the language in which the Installation Wizard runs. It also determines the language in which TM1 components will run. In the case of a TM1 server, messages from the server display in the language you choose. Select a language, then click Next.

Select TM1 UNIX Components


The Choose Install Set screen displays. Select the components that you want to include in this installation.

Component

Installed by default
Yes

Description

Servers

TM1 Server The TM1 Server manages requests from TM1 clients. It loads the names of all available permanent objects (cubes, dimensions, etc.) into memory and responds to client requests by performing calculations, consolidations, and updates as required. The TM1 Server manages security; grants or denies access to server objects as required; and maintains a log of changes to the database.

Installation Guide 53

Chapter 7: Installing TM1 on UNIX

Component

Installed by default
Yes

Description

TM1 Admin Server A process that keeps track of all TM1 servers running on a network. An Admin Server runs on a computer known as an Admin Host. When a TM1 server starts, the server registers itself with an Admin Server that is running on a specified Admin Host. TM1 clients reference the Admin Server to determine which TM1 servers are available on the network.

Accept the License Agreement


The Software License Agreement is a legal agreement that describes the obligations of the licensor and your rights (the licensee). Read this agreement in full before proceeding with the installation of IBM Cognos TM1 products. To accept the license terms and continue with the installation, select I accept the terms of the license agreement, then click Next.

Set the Installation Location


To change the default installation directory from within the Installation Wizard, click Choose and navigate to the new directory location. To accept the default location, click Next.

Configure TCP/IP Ports


Enter the TCP/IP port numbers for the TM1 Admin Server and SSL here or click Next to accept the default port numbers and continue with the installation.

TCP/IP Port
Admin Server SSL Port

Default Value
5498

Description
All TM1 components communicate with the TM1 Admin Server using SSL on this specified port number. The port number on which the Admin Server on this machine listens for client requests.

Admin Host Port

5495

54 TM1

Chapter 7: Installing TM1 on UNIX

TM1 Server Configuration


Enter the following information to configure your TM1 server.

Item
Server Name

Description
The name you want to use to identify the TM1 server. The port on which the TM1 server runs. This parameter is used to distinguish multiple TM1 servers running on the same computer. Valid port values fall between 5000 and 49151. The default is 12345. The name of a computer on which a TM1 Admin Server is installed. When a TM1 server is running, it registers itself on this Admin Server. TM1 clients connect to this Admin Server to obtain information about TM1 servers available on a network. The Admin Server can reside on the same computer on which the TM1 Server is installed or another computer on your network.

Server Port Number

TM1 Admin Host

Do you want to install the sample data?

Select this option if you want to install the TM1 sample data, which is referenced extensively by the TM1 documentation. Clear this option if you do not want to install the sample data.

Path to TM1 Database

Specify the path to the TM1 servers data directory. If you have an existing TM1 data directory that you want to use with your new server installation, enter the full path to the directory.

Installation Summary
The installation summary provides the following information: The TM1 components you are installing. The amount of disk space your installed components require.

Click Next after reviewing the summary, then click Done after the installation is complete.

After You Complete the Installation


Once you have successfully installed the TM1 software you should perform the following tasks: Installation Guide 55

Chapter 7: Installing TM1 on UNIX

Task

For more information see

Login to ensure proper connectivity. You should IBM Cognos TM1 Users Guide log in to TM1 through TM1 Architect. Choose an authentication model. Set up TM1 security. Start TM1. IBM Cognos TM1 Operations Guide IBM Cognos TM1 Operations Guide "Starting a UNIX TM1 Server" (p. 58)

S89IBM_TM1 Startup Script


As part of a Solaris or AIX installation, TM1 creates the /etc/rc2.d/S89IBM_TM1 script, which runs every time you boot your UNIX machine. This script starts the axnet server process that launches ODBC gateways as requested by the TM1 server or the Application Server service. On an HP/UX installation, the S89IBM_TM1 script is created in the directory:
/sbin/rc3.d/

Uninstalling UNIX TM1


You can uninstall TM1 by running the Uninstall_TM1 program from your <TM1_Install>/TM1_Uninstall directory.

Steps
1. Go to the <TM1_Install>/TM1_Uninstall directory. The default location of this directory is / Cognos/TM1/TM1_Uninstall. 2. Run the TM1_Uninstall program by issuing the command ./TM1_Uninstall. The TM1 Uninstaller displays. 3. Click Next on the Introduction screen. 4. Select Complete Uninstall or Uninstall Specific Features, then click Next. If you select Complete Uninstall, all TM1 components will be removed immediately. If you select Uninstall Specific Features, you must choose individual components to uninstall. 5. If you select Uninstall Specific Features, clear the check box next to the components that you want to remove, then click Uninstall. 6. Click Done to complete the uninstall. 7. Click Finish after the uninstaller has removed TM1 from your system. To preserve your customizations, none of the files and subdirectories in the <TM1_Install>/Custom directory are removed when you uninstall TM1. For example, the

56 TM1

Chapter 7: Installing TM1 on UNIX configuration files remain available if you reinstall or upgrade your TM1 software. Similarly, any TM1 data directories that exist in <TM1_Install>/Custom/TM1Data are not removed.

Silent UNIX Installation


To run a silent UNIX TM1 installation, type the following line at a command prompt: <path_to_directory_containing_install.bin_executable>./install_<OS>.bin -silent For example, to install TM1 on Solaris from the /software/TM1 directory, enter the command /
software/TM1/./install_solaris.bin.

For example to install TM1 on AIX from the /software/TM1 directory, enter the command /
software/TM1/./install_aix.bin.

The TM1 server will be installed silently without user input, using the following default values:

Parameter
Install directory Components Server Name Server TCP/IP port Admin Host

Description
/Cognos/TM1 TM1 Server, Admin Server Planning Sample 12345 (blank, defaults to machine where TM1 server is running) /Cognos/TM1/Custom/TM1Data/PlanSamp Admin (blank)

Path to TM1 Database Administrative username Administrative password

Console Installation
To run a console UNIX TM1 server installation, enter the following line at a command prompt: <path_to_directory_containing_install.bin_executable>./install_<OS>.bin -i console For example, to complete a silent install of TM1 on Solaris from the /software/TM1 directory, enter the command /software/TM1/./install_solaris.bin -i console. To complete a silent install of TM1 on AIX from the /software/TM1 directory, enter the command /software/TM1/./install_aix.bin -i console. You will be prompted to enter server parameter values required to install and run the TM1 server.

Installation Guide 57

Chapter 7: Installing TM1 on UNIX

Starting a UNIX TM1 Server


When you install a UNIX TM1 server, a script named Tm1s_start_<server_name> is installed in the <TM1_install>/bin directory. For example, if you install a TM1 server named SData, the script is named Tm1s_start_SData. You can use this script to start your UNIX TM1 server.

Step
Run ./tm1s_start_<server_name> to start your TM1 server.

Running the UNIX TM1 Server in Background Mode


The TM1 Installation Wizard adds the following parameter to the Tm1s.cfg file: RunningInBackground=T When you run the TM1 server in background mode, you must use tm1srvstop.exe to shut down the server. For details, see the IBM Cognos TM1 Operations Guide.

58 TM1

Chapter 8: Installing TM1 Workflow


TM1 Workflow allows you to create and manage a workflow structure for your planning and budgeting activities. This document describes how to install Workflow on your TM1 server, and how to set up your TM1 users to access the Workflow clients. The following topics are described in this chapter: "Workflow Prerequisites" (p. 59) "Running the Workflow Installation Wizard" (p. 60) "Installing Workflow for the First Time" (p. 62) "Upgrading to Workflow from Planning Manager 1.3" (p. 63) "Configuring Workflow for Excel" (p. 64) "Using Workflow with TM1 Web" (p. 65)

Workflow Prerequisites
Before you install Workflow, you must have the following software installed and configured: IBM Cognos TM1 Server 9.4 or later. TM1 Client or TM1 Perspectives. (You do not need a TM1 Perspectives license on every client workstation. If users can run the TM1 Client, they can run Workflow.) If you want to run Workflow through TM1 Web, you must have TM1 Web installed. Each Workflow user must be running Excel 2003 or later If you are installing Workflow against an existing TM1 database:

The existing TM1 database must have a dimension that holds the names of budget versions. Without an existing version dimension, you cannot run Workflow.You should back up the existing database and store the copy in a safe place before running the Workflow installation.

Licensing
TM1 Workflow requires TM1 9.4 or later. You must have the following options enabled in your TM1 Server license: TM1 Server TurboIntegrator TM1 Workflow

Installation Guide 59

Chapter 8: Installing TM1 Workflow

Running the Workflow Installation Wizard


You can use the TM1 Workflow Installation Wizard to: Install Workflow for the first time Upgrade Planning Manager 1.3 to Workflow

Note: If you are upgrading from Planning Manager 1.2 or older, you must first upgrade to Planning Manager 1.3. For more details or support, visit the IBM Cognos Resource Center http://www.ibm. com/software/data/support/cognos_crc.html.

Steps
1. Run the Workflow setup.exe file on the Workflow installation CD or from the Workflow installation package that you downloaded. The Workflow Installation Wizard runs and displays the Welcome screen. 2. Click Next at the Welcome screen. The License Agreement screen appears. 3. Accept the license agreement and click Next. The Custom Setup screen appears. Use the Custom Setup screen to select the Workflow components that you want to install, depending on your specific installation scenario. For details, see the following sections: "Selecting Workflow Installation Components" (p. 61) "Installing Workflow for the First Time" (p. 62) "Upgrading to Workflow from Planning Manager 1.3" (p. 63) 4. Click Next. If you selected the Excel Addin option on the Custom Setup screen, the Excel Addin screen appears. The following Excel Addin options are available: Add the Addin to the list of available Addins in Microsoft Excel - This option makes Workflow appear in the Add-Ins dialog box that appears when you select Tools, Add-Ins in Excel. Automatically load the Workflow Addin when Microsoft Excel starts - This option starts and displays the Workflow toolbar when you start Excel.

5. Click Next. The Ready to Install the Program screen appears. 6. Click Install to complete the installation.

60 TM1

Chapter 8: Installing TM1 Workflow

Selecting Workflow Installation Components


Use the Custom Setup screen to select the Workflow components that you want to install, depending on your specific installation scenario. You can control whether a component is installed or not as follows: Choose the This feature will be installed on local hard drive icon to enable the installation of the selected component. Choose the This feature will not be available icon to disable the installation of the selected component.

Workflow Components
The available Workflow components include the following Server and Excel components:

Component

Description

Web Server Compon- Enables the Workflow toolbar and functionality in TM1 Web. ent Default installation location is: C:\Inetpub\wwwroot\TM1Web\ Database Components Includes the TM1 Workflow server files to add to an existing TM1 database that has not been used with Workflow yet. Default installation location is: C:\Program Files\Cognos\TM1\Custom\TM1Data\TM1 Planning Manager V2\ Planning Manager Upgrade Includes the Workflow upgrade files if you are upgrading from Planning Manager 1.3 Default installation location is: C:\Program Files\Cognos\TM1\Custom\TM1Data\TM1 Planning Manager V2 Upgrade\ Excel Addin Enables the Workflow toolbar and functionality in Excel. Default installation location is: C:\Program Files\Cognos\TM1\bin\

Installation Guide 61

Chapter 8: Installing TM1 Workflow

Destination Folder for Workflow Components


Each Workflow component is installed to its own specific destination folder. Click on each component individually to see its destination folder.

Steps
1. Select the component on the Custom Setup screen of the Workflow installation. 2. Click Change. The Change Current Destination Folder dialog appears. 3. Select a new destination folder. 4. Click OK to return to the installation wizard. 5. Repeat these steps to change the destination folder for any other Workflow component.

Installing Workflow for the First Time


Install a new instance of Workflow on a system with no previous installation of Workflow.

Steps
1. Run the Workflow installation and advance to the Custom Setup screen. 2. On the Custom Setup screen, use the default component selection to install only the following components: Web Server Component Database Components Excel Addin

3. Set the destination folder of the Database Components depending on how many TM1 databases you want to use with Workflow.

Installing Workflow for One Existing TM1 Database


To install Workflow into an existing TM1 database, select Database Components and change the Destination Folder to the data directory of the TM1 server that you want to use with Workflow.WARNING: Make sure the existing database has not been used with Workflow or you will over-write previous Workflow files.

Installing Workflow for Multiple TM1 Databases


To apply Workflow to multiple TM1 databases, install the TM1 Database PM Components to the default destination folder or to another empty folder.After the installation, you can then manually

62 TM1

Chapter 8: Installing TM1 Workflow copy the database component files into the other TM1 data directories that you want to use with Workflow.

Steps
1. On the Custom Setup screen, click Next and complete the installation. 2. Restart any of the TM1 servers where you installed Workflow to allow the Workflow options to be loaded. You also need to enable the Workflow option in the server license for each TM1 server that will use Workflow.

Upgrading to Workflow from Planning Manager 1.3


Use the following steps to upgrade an existing installation of Planning Manager version 1.3.

Steps
1. Back up your existing Planning Manager database and store the copy in a safe place before running the new Workflow installation. 2. Uninstall the previous version of Planning Manager using the Add or Remove Programs feature in the Windows Control Panel. 3. Run the Workflow installation and advance to the Custom Setup screen. 4. On the Custom Setup screen, select the following components to install: Web Server Component Database Components Planning Manager Upgrade Excel Addin

5. Set the destination folder of the Planning Manager Upgrade depending on how many databases you need to upgrade as follows.

Upgrading Planning Manager for One Existing TM1 Database


To upgrade Planning Manager for an existing TM1 database, select Planning Manager Upgrade option and change the Destination Folder to the data directory of the TM1 server that you want to upgrade.

Upgrading Planning Manager for Multiple TM1 Databases


To upgrade multiple TM1 Planning Manager databases, install the Planning Manager Upgrade to the default destination folder or to another empty folder.After the installation, you can then

Installation Guide 63

Chapter 8: Installing TM1 Workflow manually copy the database component files into each of the TM1 data directories that you want to upgrade. Repeat these steps on all other TM1 servers that require upgrading.

Steps
1. On the Custom Setup screen, click Next and complete the installation. 2. Re-start the TM1 server. 3. Open TM1 Architect or Server Explorer and log in to the server. 4. Expand Processes and run the TI process, sm_upgrade_v2.pro, to upgrade the database.

Configuring Workflow for Excel


If you selected the Excel Addin options when installing Workflow, the installation automatically configures your system to add Workflow to Microsoft Excel. Excel Components on the Custom Setup screen

Workflow Excel Addin options

After installing Workflow, run Microsoft Excel. TM1 Perspectives should load, followed by TM1 Workflow. The Workflow toolbar appears in Excel as follows.

Workflow toolbar

64 TM1

Chapter 8: Installing TM1 Workflow

Troubleshooting the Workflow Excel Add-in


If the Workflow add-in does not load properly in Excel, try the following:

Steps
1. Unload the Workflow add-in by choosing Tools, Add-ins from the Excel menu and unselecting the TM1Workflow entry. 2. Click OK and close Excel. 3. Restart Excel and make sure that the TM1 Perspectives add-in loads properly. 4. Choose Tools, Add-ins from the Excel menu. 5. Reload the Workflow add-in by clicking Browse and manually selecting the Workflow add-in, TM1 Planning Manager.xla, located in the <TM1 install directory>\bin directory.

Using Workflow with TM1 Web


You can run Workflow as an application in TM1 Web. All of the user functions described in the IBM Cognos TM1 Workflow Administrators Guide are available through the TM1 Web.

Workflow On The Web


Workflow in TM1 Web is enabled by editing several parameters in the Web.config file that governs your TM1 Web installation. The Workflow installation automatically installs these parameters into the TM1 Web Web.config file. A full description of these parameters and an explanation of the Web.config file can be found in the IBM Cognos TM1 Operations Guide. The Workflow toolbar appears the next time you log in to TM1 Web.

Workflow Features in TM1 Web


Many of the user features of Workflow are available from TM1 Web. For example, if you choose a task, the worksheet mapped to that task appears in TM1 Web. After working on the task, you should be able to use the toolbar to submit the task. For a complete description of these features, see the IBM Cognos TM1 Workflow Administrators Guide. Note: The Workflow administration console is not supported through TM1 Web. Administration functions for Workflow, such as setting up mapping and security for Workflow tasks, must be done through Excel.

Localizing TM1 Web Toolbar Captions


The Toolbar captions in TM1 Web Workflow are set by user-defined parameters in the web.config file. When running a localized version of TM1 Web Workflow, be sure to edit the caption config parameters into the localized language and save the config file as a UTF-8 file. Depending on the language, you may also need to adjust the widths of captions in those config parameters. See

Installation Guide 65

Chapter 8: Installing TM1 Workflow "Configuring TM1 Workflow Parameters" in the IBM Cognos TM1 Operations Guide for more information on these parameters.

66 TM1

Chapter 9: Using IBM Cognos 8 Security with TM1


This chapter describes how to use IBM Cognos 8 security with TM1. The following topics are covered: IBM Cognos 8 Security Overview Configuring the TM1 Server Configuring the TM1 Client Defining a Cognos User to Function as a TM1 Administrator Importing Cognos Groups into TM1

For complete details on IBM Cognos 8 security concepts, terminology, and implementation, see the IBM Cognos 8 Administration and Security Guide. Note: Integrating TM1 security with IBM Cognos security requires at least TM1 9.4 and IBM Cognos 8.4.

IBM Cognos 8 Security Overview


The TM1 server can authenticate users using IBM Cognos 8 security. IBM Cognos 8 security is a component of the IBM Cognos 8 framework that manages user access to data. IBM Cognos 8 security manages authorization and authentication through third-party security providers, such as LDAP or Active Directory. When a user is authenticated through IBM Cognos 8 security, they are provided with a Cognos security passport. This passport is then used by IBM Cognos/TM1 applications to determine the user's permissions (role and group membership) and identity. When using IBM Cognos 8 security, a Cognos passport is required to connect to TM1. A user is presented with a logon screen requiring a namespace, a user name, and a password when first logging in to TM1 or any other IBM Cognos 8 security-enabled components. Once authenticated by IBM Cognos 8 security, a passport is issued to the user. This passport automatically provides the user's credentials when accessing any other IBM Cognos 8 security-enabled application (including TM1). Once a user connects to a TM1 server via a specific IBM Cognos 8 server that has been configured for common logon, no direct user input is required to access additional TM1 servers (or other IBM Cognos 8 applications) that are configured to reference the same IBM Cognos 8 server. When a user attempts to access a TM1 server, the server validates the passport to authenticate the user. This is done by querying an IBM Cognos 8 server for the identity of the passport. If the passport is valid, the query returns a collection of security and authentication information for the user. This information contains the roles and groups that the user has membership to, as well as the account (user name) associated with the passport. If the user name already exists in TM1, their existing membership will be validated against the existing TM1 groups. If the user does not exist, they are added and assigned to the appropriate user groups on the TM1 server.

Installation Guide 67

Chapter 9: Using IBM Cognos 8 Security with TM1

Setting Up a TM1 Server to Use IBM Cognos 8 Security


The following sections describe the configuration settings and procedures required to enable IBM Cognos 8 security authentication on a TM1 server. Note: To successfully complete these procedures, your IBM Cognos 8 server must not be configured to allow anonymous access. If anonymous access is enabled on the IBM Cognos 8 server, you cannot logon to a namespace from TM1 when importing Cognos groups into TM1.

Configuring the TM1 Server


Before enabling IBM Cognos 8 security on a TM1 server, you must add or modify several configuration parameters to the server's Tm1s.cfg file

Steps
1. Open the Tm1s.cfg configuration file in a text editor. Tm1s.cfg is located in the TM1 server's data directory. 2. Add the following parameters to the configuration file.

Parameter Name
ServerCAMURI

Description
The URI for the internal dispatcher that the TM1 server should use to connect to IBM Cognos 8 security. The URI is specified in the form http[s]://<host IP address>: <port>/p2pd/servlet/dispatch. For example, http://10.121.25.121:9300/p2pd/
servlet/dispatch or https://10.121.25.121:9300/ p2pd/servlet/dispatch

Note: To find the URI, ask your IBM Cognos 8 administrator to perform the following steps. 1. Open the IBM Cognos Configuration. 2. Click Environment. 3. In the Gateway section, go to Dispatcher URI to locate the URI.

68 TM1

Chapter 9: Using IBM Cognos 8 Security with TM1

Parameter Name
ClientCAMURI

Description
The URI for the IBM Cognos 8 Server IBM Cognos Connection used to authenticate TM1 clients. The URI is specified in the form:
http[s]://host/cognos8/cgi-bin/cognos.cgi.

Note: Both cognos8 and cognos.cgi are variables and depend on the exact settings that have been used. Contact your IBM Cognos 8 administrator for more information about these settings. For example:
http://10.121.25.121/cognos8/cgi-bin/cognos. cgi.

If you are using Microsoft Internet Information Services (IIS):


http://10.121.25.121/cognos8/cgi-bin/ cognosisapi.dll

CAMSSLCertificate

The full path and name of the SSL certificate to be used when connecting to the internal dispatcher. For example,
C:\AxTM1\Install_Dir\ssl\CognosCert.cer.

This parameter is required only if the IBM Cognos 8 server is configured to use SSL. SkipSSLCAMHostCheck Indicates whether the SSL certificate ID confirmation process can be skipped. The default is FALSE. Important: This parameter should be set to TRUE only if using a generic certificate for demonstration purposes. ClientPingCAMPassport Indicates the interval, in seconds, that a client should ping the IBM Cognos 8 server to keep their passport alive. If an error occurs or the passport expires the user will be disconnected from the TM1 server.

Installation Guide 69

Chapter 9: Using IBM Cognos 8 Security with TM1

Parameter Name
CAMPortalVariableFile

Description
The path to the variables_TM1.xml file in your C8 installation. In most cases, the path will be:
CAMPortalVariableFile = portal\variables_TM1.xml

The variables_TM1.xml file is included as part of the TM1 Viewer Portlets installation. For details on installing and configuring Viewer Portlets, see the IBM Cognos TM1 Installation Guide. The CAMPortalVariableFile parameter is required only when running TM1 Web. The Tm1s.cfg file should contain parameters similar to the following:
ServerCAMURI=http://10.111.25.121:9300/p2pd/servlet/dispatch ClientCAMURI=http://10.111.25.121/cognos8/cgi-bin/cognos.cgi ClientPingCAMPassport=900 CAMPortalVariableFile=templates\ps\portal\variables_TM1.xml

3. Set the IntegratedSecurityMode parameter to 2.


IntegratedSecurityMode=2

4. Save and close Tm1s.cfg. 5. Restart the TM1 server.

Configuring the TM1 Client


You must add two parameters to your Tm1p.ini file to allow you to perform IBM Cognos 8 security-related administrative tasks from your TM1 client.

Steps
1. Open the Tm1p.ini configuration file in a text editor. Tm1s.cfg is located in the C:\Documents and Settings\<user name>\Application Data\Applix\TM1 directory. 2. Add the following parameters to the Tm1p.ini file.

Parameter Name
CognosGatewayURI

Description
The URI for the IBM Cognos 8 Server IBM Cognos Connection used to authenticate TM1 clients. The URI is specified in the form http[s]://host/cognos8/cgi-bin/cognos.cgi For example: http://10.121.25.121/cognos8/cgi-bin/
cognos.cgi

70 TM1

Chapter 9: Using IBM Cognos 8 Security with TM1

Parameter Name

Description

AllowImportCAMClients Determines if Cognos clients can be imported into TM1. This parameter must be set to T when setting up IBM Cognos 8 security in TM1. Your Tm1p.ini file should include parameters similar to the following:
AllowImportCAMClients = T CognosGatewayURI = http://10.111.25.121/cognos8/cgi-bin/cognos.cgi

3. Save and close Tm1p.ini. 4. Restart your TM1 client.

Defining a Cognos User to Function as a TM1 Administrator


To successfully administer TM1 while using IBM Cognos 8 authentication, an existing Cognos user must be added to the TM1 ADMIN group. This Cognos user will be used to import Cognos groups into TM1.

Steps
1. Log in to your TM1 server as an administrator. 2. From the Server Explorer, click Server, then Security, then Clients/Groups. 3. From the Clients/Groups dialog box, click Clients, then Add New Client. The Cognos logon dialog box appears. 4. Enter your Cognos user ID and password, then click OK. The Select Entries dialog box appears. 5. In the Name box, click the namespace to which you are currently logged in. Note: Only users from the namespace to which you are logged in can be imported into TM1. Other namespaces may appear in the Name box, but you cannot import users from them. The contents of the Name box update to display the directories available on the selected namespace. 6. Enable the Show users in the list option. 7. Navigate to the directory containing the Cognos user you want to define as a TM1 administrator. In most circumstances, you will define your own Cognos user as a TM1 administrator, as you must know the Cognos user's ID and password to complete administrative tasks. 8. Select the user. 9. Click the green arrow button to move the selected user to the Selected Entries list.

10. Click OK to import the Cognos user into TM1.

Installation Guide 71

Chapter 9: Using IBM Cognos 8 Security with TM1 The user appears as a new client in the Client/Groups window, but is not assigned to any TM1 groups. 11. Assign the new user to the ADMIN group and click OK. 12. Shut down the TM1 server. 13. Open the Tm1s.cfg configuration file in a text editor. 14. Set the IntegratedSecurityMode parameter to 4, indicating that the server should use IBM Cognos 8 authentication.
IntegratedSecurityMode=4.

15. Save and close Tm1s.cfg. 16. Restart the TM1 server.

Importing Cognos Groups into TM1


Once a Cognos user is defined as a TM1 administrator, that user can import Cognos groups into TM1. You should import only the Cognos groups that you want to allow to access the TM1 server.

Steps
1. In the Server Explorer, double-click your TM1 server. The Cognos logon dialog box appears. 2. Log on as the Cognos user that you have defined as a TM1 administrator. 3. From the Server Explorer, click Server, then Security, then Clients/Groups. 4. From the Clients/Groups window, click Groups, then Add New Groups. The Select Entries dialog box appears. 5. In the Names box, click the namespace to which you are currently connected. Note: Only groups from the namespace to which you are connected can be imported into TM1. Other namespaces may appear in the Name box, but you cannot import groups from them. 6. Navigate through the directory structure and select the Cognos groups you want to import into TM1. 7. Click the green arrow button to move the selected user to the Selected Entries list.

8. Click OK to import the Cognos groups into TM1. If you review the User Group Assignment section of the Clients/Groups window, you should see the Cognos groups added to your server.

Creating Users
When a TM1 server is configured to use IBM Cognos 8 authentication, you cannot create new clients directly on the TM1 server. Instead, all client administration is performed in IBM Cognos 8.

72 TM1

Chapter 9: Using IBM Cognos 8 Security with TM1 When a Cognos user accesses TM1, the user is validated and automatically assigned to the appropriate TM1 groups. There is no need to manually assign users to groups in TM1.

Administering TM1 Object Security


While IBM Cognos 8 authentication automatically manages users on the TM1 server, the TM1 administrator must still manage object security to allow Cognos users to view and use TM1 objects. For details on administering TM1 object security, see the IBM Cognos TM1 Developers Guide.

Configuring TM1 Web to Use IBM Cognos 8 Security


To allow users to successfully log in to TM1 Web when a TM1 server uses IBM Cognos 8 authentication, a variables_TM1.xml file must be present in the c8_location\templates\ps\portal directory. The variables_TM1.xml file must be configured to include the URL of the web server used to deliver TM1 Web. The variables_TM1.xml file is included as part of the TM1 Viewer Portlets installation. For details on installing and configuring Viewer Portlets, see the IBM Cognos TM1 Installation Guide.

Logging in to TM1 Top


The TM1 Top utility allows you to log into the current TM1 Top session by executing the TM1 Top command V. To successfully log in to TM1 Top, you must provide the IBM Cognos 8 Namespace ID of the namespace (not the descriptive name), along with a valid Cognos user name and password.

User Considerations When Using IBM Cognos 8 Authentication


TM1 users should be aware of the following issues when accessing a TM1 server configured to use IBM Cognos 8 authentication.

Authentication Behavior
The following rules govern authentication behavior when logging on to a TM1 server that uses IBM Cognos 8 authentication. If common logon is enabled in IBM Cognos 8 and you have previously logged in to an IBM Cognos application and maintain an active session, you are not prompted for credentials when logging on to the TM1 server. If common logon is enabled in IBM Cognos 8 and you have not previously logged in to an IBM Cognos application, you are prompted for credentials when logging on to the TM1 server. If common logon is not enabled in IBM Cognos 8, you are prompted for credentials when logging on to the TM1 server, even if the TM1 server is configured to use IBM Cognos 8 authentication.

Private IBM Cognos 8 Security Sessions


When an IBM Cognos 8 server is configured to use common logon, you will only be challenged once for credentials. Any subsequent connections to other IBM Cognos 8 security-enabled applica-

Installation Guide 73

Chapter 9: Using IBM Cognos 8 Security with TM1 tions (including TM1) which are configured to reference the same IBM Cognos 8 server will automatically occur, provided your Cognos security passport is valid. For example, if you have three available TM1 servers, all configured to use the same IBM Cognos 8 server, once you connect to the first TM1 server as user X in namespace Y, all connections to the other TM1 servers will automatically occur using the passport of user X from namespace Y. In some circumstances, you might want to log on to a TM1 server as a user other than the one identified by your Cognos security passport. To accommodate this, the Logon As option lets you override the automatic authentication that usually occurs with a passport, while maintaining the validity of the passport for later use. When you log on to a TM1 server using the Logon As option, a private session is established. The credentials used to establish the private session are not stored in a passport and are not shared with any other application. Any existing passport remains valid and can be used to access other IBM Cognos 8 security-enabled applications.

Steps
1. From the Server Explorer, click Server, then Logon As. 2. In the Cognos Logon window, enter the User ID and Password you want to use to log on to the TM1 server. 3. Click OK.

Establishing a Replication with IBM Cognos 8 Security


When establishing a replication connection to a TM1 server that uses IBM Cognos 8 authentication, you must provide the IBM Cognos 8 Namespace ID of the namespace, not the descriptive name of the namespace.

74 TM1

Chapter 10: Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services
Before you can use the TM1 Viewer Portlets to view existing TM1 cube views and websheets, you must install them and, if the TM1 data servers are secured against IBM Cognos 8, configure access to IBM Cognos 8 from the TM1 Viewer Portlets. If you no longer use TM1 data sources or plan to upgrade, you can uninstall the TM1 Viewer Portlets.

Configure TM1 to use IBM Cognos 8 Security


If you want to use IBM Cognos 8 to show TM1 cubes or TM1 Websheets without having to log in to TM1, you must configure TM1 to use IBM Cognos 8 security. For more information, see the IBM Cognos 8 security section in this guide.

Install the TM1 Viewer Portlets


Install the TM1 Viewer Portlets by using the installation wizard that is provided on the CD containing the main TM1 installer. You must install the TM1 Viewer Portlets in the same directory as the Gateway component for IBM Cognos 8, on a computer that is running a supported Windows server. In addition, the TM1 Web server must be on the same computer.

Steps
1. Stop the IBM Cognos 8 service. 2. Insert the TM1 Viewer Portlets installation CD. 3. If the installation wizard does not start automatically, start the wizard by double-clicking issetup.exe. 4. On the Welcome page, select the language to use for the installation and click Next. Note: Regardless of the language that you select for the installation wizard, all languages for the product are installed. 5. Accept the license agreement and click Next. 6. On the Installation Location page, select the directory where the IBM Cognos 8 Gateway component is installed and click Next. You are prompted for the location of a directory in which to store backup copies of the files that will be overwritten.

Installation Guide 75

Chapter 10: Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services 7. On the Shortcut Folder page, type the name that you want the shortcut to use and then click Next. 8. Review the installation summary and then click Next. 9. On the Finish page, view the log files if required and then click Finish.

Configure Access to IBM Cognos 8 From the TM1 Viewer Portlets


If you secured your TM1 data servers against IBM Cognos 8, you must specify the location of the computers that are running TM1 Web so that users can access IBM Cognos 8 from the TM1 Viewer Portlets.

Steps
1. In the c8_location\templates\ps\portal directory, open the variables_TM1.xml file in a text editor. 2. In the line with <url></url>, specify the location for TM1WebLoginHandler.aspx and TM1WebMain.aspx files. For example, <url>http://TM1Webserver/TM1Web/TM1WebLoginHandler.aspx</url><url>http:// TM1Webserver/TM1Web/TM1WebMain.aspx</url> where TM1Webserver is the name of the computer where TM1 Web is running. 3. Add more URL specifications until you have listed every server that is running TM1 Web. 4. Save the file.

Uninstall the TM1 Viewer Portlets


If you no longer require the TM1 Viewer Portlets or you are planning to upgrade to a newer release, uninstall the TM1 Viewer Portlets.

Steps
1. From the Start menu, click Programs, IBM Cognos 8, Uninstall IBM Cognos 8, Uninstall IBM Cognos 8. 2. On the Uninstall Language Selection page, select the language for the uninstallation wizard and then click Next. 3. Select IBM Cognos 8 TM1 Viewer Portlets and click Next. 4. When the uninstallation is complete, click Finish. Some files and folders remain on the computer until you remove them manually. If you plan to upgrade, do not delete the files and folders.

76 TM1

Chapter 11: Maintaining and Upgrading Your TM1 Installation


This chapter describes tasks you should perform after you install TM1. It also provides information about upgrading to a newer version of TM1. After successfully installing TM1, you can return to the TM1 Installation Wizard to perform various tasks. Topics include: "Maintaining TM1 Components" (p. 77) "Repair the TM1 Installation" (p. 78) "Remove TM1" (p. 79) "Upgrading TM1" (p. 79)

Maintaining TM1 Components


If you try to reinstall the same version of TM1 that is already installed, the following screen opens:

You can use these options to "Modify Components" (p. 77), "Repair the TM1 Installation" (p. 78) or "Remove TM1" (p. 79) the TM1 installation.

Modify Components
Follow these steps to modify your current installation, remove or add components, or change installation parameters.

Steps
1. Insert the TM1 installation CD in your CD drive.

Installation Guide 77

Chapter 11: Maintaining and Upgrading Your TM1 Installation If autorun is enabled on your CD drive, the TM1 Installation Wizard displays. If autorun is not enabled, run setup.exe in the installation CD root directory to start the TM1 Installation Wizard. 2. Click Next. 3. Select Modify on the Program Maintenance screen and click Next. 4. Select the TM1 installation package you want to modify. 5. Select the Custom installation type and click Next. The Component Selection screen displays, showing the current state of your TM1 installation. Items currently installed display with a disk drive icon next to the component name. Items not currently installed display with an X next to the name.

Program maintenance does not include changing the location of the TM1 installation directory. To change the location of the installation directory, remove all TM1 files and reinstall TM1 in another location. 6. Click Finish to complete the modifications.

Repair the TM1 Installation


If files necessary to a TM1 installation are inadvertently deleted or corrupted, you can repair your installation.

Steps
1. Insert the TM1 installation CD in your CD drive. If autorun is enabled on your CD drive, the TM1 Installation Wizard displays. If autorun is not enabled, run setup.exe in the installation CD root directory to start the TM1 Installation Wizard. 2. Click Next. 3. Select Repair on the Program Maintenance screen. 4. Click Next and answer all subsequent prompts to complete the repair process. The installation program reinstalls your current configuration. It fixes missing or corrupt files, program groups, shortcuts, and registry entries.

78 TM1

Chapter 11: Maintaining and Upgrading Your TM1 Installation

Remove TM1
To uninstall all components of TM1, follow these steps.

Steps
1. Create a backup copy of your custom data by coping the contents of the <TM1_Home>\Custom\ directory to a safe place on your hard disk. This directory contains TM1 configuration files that will be re-generated by the TM1 installation. 2. Delete the <TM1_Home>\custom\ directory. 3. From the Control Panel on your computer, choose Add/Remove Programs. 4. In the list of currently installed programs, select IBM Cognos TM1.

Upgrading TM1
TM1 9.4 does not support automatic upgrading from a previous version of TM1. If you are upgrading to TM1 9.4, you must back up your previous TM1 database, uninstall the previous version, install TM1 9.4, then restore your database.

Backing Up Your TM1 Data


If you are currently using any previous version of TM1, you must backup your TM1 data directory and configuration files before running the TM1 Installation Wizard for TM1 9.4. Save a copy of your existing <TM1_Install>\Custom\ data directory and sub-directories to a secure location. Save a copy of any TM1 configuration files you may want to retain, such as the Tm1admsrv.ini file located in the <TM1_Install>\bin\ directory. If installing TM1 Web, backup any custom TM1 Web server pages to a secure location. The default location of the directory containing TM1 Web server pages is C:\inetpub\wwwroot\ TM1Web.

Restoring Your TM1 Database


After installing TM1 9.4, complete these steps to restore your TM1 database.

Steps
1. Copy your existing TM1 server data directory to the new <TM1_Install>\Custom\ that is available after you install TM1 9.4. 2. Restore your existing TM1 configuration files to the <TM1_Install>\bin\ directory. 3. Restore your existing custom TM1 Web server pages to the directory containing TM1 Web server pages, usually C:\inetpub\wwwroot\TM1Web.

Installation Guide 79

Chapter 11: Maintaining and Upgrading Your TM1 Installation

80 TM1

Index
Symbols
/etc/services, 51 .NET API, 31, 35 .username, 23 + plus sign, 18 64-bit Windows, 43 x86, 47 TM1 Web, 35, 40 Cognos 8 authentication, 67 defining an administrator, 71 importing groups into TM1, 72 Cognos 8 security, 67 CognosGatewayURI, 70 Cognos security passport, 67 components exclude, 18 Perspectives, 32 TM1, 19 TM1 Web, 35, 40 console installation, 57 corrupted installation files, 78

A
Active Server Pages (ASP), 40 Admin Host, 21 Admin Server, 31, 35 Host Machine Name, 25, 26, 39, 44 host name, 28, 32, 40 port #, 28, 32, 40, 44 AllowImportCAMClients, 70 ASP.NET, 40 authentication, 23, 67 for user access to IBM Cognos 8 from TM1 Viewer Portlets, 76 authentication error TM1 Viewer Portlets, 76 autoload, 26

D
default values Perspectives, 32 TM1, 28, 44 TM1 Web, 40 Developer Environment Perspectives, 31 TM1, 19 TM1 Web, 35, 40 Disabled in Windows Services, 48 domains account, 16, 43 installing without, 23 Dundas Charts (c), 40

B
background mode, 58

C
CAMID, 67 CAMPortalVariableFile, 68 CAMSSLCertificate, 68 change button, 18 Choose a Product to Install, 17 Choose Database, 25, 39 ClientCAMURI, 68 ClientPingCAMPassport, 68 Clients Configuration, 26 Perspectives, 31 TM1, 19

E
Edit Directly in Cell, 26 Excel application, 65 exclude components, 18

H
HP/UX, 12, 51

I
IBM Cognos Resource Center, 8

Installation Guide 81

Index IIS web server, 12 installation checklist, 10 checklist for UNIX, 51 console, 57 directory, 18 location screen, 18 options screen, 17 order in 64-bit, 48 silent, 57 troubleshooting, 65 installation prerequisites, 59 installing TM1 Viewer Portlets, 75 Integrated Login, 23, 24, 26 TM1 Web, 38 password, 22 permissions, 40 Perspectives, 31 components list, 31 default values, 32 Planning Sample Data x64, 49 privileges Service Account, 12

R
regional setting, 16 repair installation, 78 ROOT, 12

S
sample data directory, 28, 32, 40, 44 Search Base LDAP, 23 security configuring user access to IBM Cognos 8 from TM1 Viewer Portlets, 76 mode, 28, 40, 44 settings TM1 Web, 38 server name, 39 Perspectives, 31, 35 TM1, 19 TM1 Web, 39, 40 UNIX, 53 ServerCAMURI, 68 Service Account TM1, 12 setup.exe, 16 silent installation, 57 SkipSSLCAMHostCheck, 68 Solaris, 12, 51 SSL, 21 port #, 28, 40, 44 startup property, 12 type, 48 subfeatures, 18

L
language, 16 LDAP authentication, 23 host, 23 port, 23 search base, 23 search field, 23 License Agreement, 16, 54 locale setting, 16 local machine syntax, 23 logging in to TM1 Viewer Portlets authentication error, 76

M
manuals, 31, 35, 40 Microsoft Excel 2000, 59 mixed mode, 24

N
naming conventions x86 and x64, 49

O
ODBC Gateway, 15 Oracle, 10, 51

T
TCP/IP port number, 21, 38, 43 TEMP, 15

P
passport, 67 82 TM1

Index TM1, 26 Admin Server, 15 API, 31, 35 Architect, 35 authentication, 23 Client, 26, 32 Client Configuration, 26 components list, 28, 44 default values, 28, 44 Java API, 31, 35 Perspectives, 31 Perspectives/Architect, 44 Perspectives Client, 31, 35 server, 15, 28, 31, 32, 35, 39, 40, 44, 58 Service Account, 12 Top, 19, 31, 35 Web, 40 TM1 Client, 59 TM1Install.log, 15 Tm1p.ini, 32, 40 Tm1p.xla, 26 TM1 Perspectives, 59 tm1s_start_example, 58 Tm1s.cfg, 39, 44, 49 TM1 Viewer Portlets authentication error, 76 installing, 75 uninstalling, 76

X
XHOST, 51

U
uninstall, 79 uninstalling TM1 Viewer Portlets, 76 UNIX, 10, 51, 58 use integrated login, 26 username, 22, 44

W
Web components, 31, 35, 40 Windows permissions, 40 XP Professional, 47 Workflow installation prerequisites, 59

Installation Guide 83

You might also like