IBM Cognos TM1

Version 9.5.2

Installation Guide

Product Information
This document applies to IBM Cognos TM1 Version 9.5.2 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Information Centers (http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp).

Copyright
Licensed Materials - Property of IBM Copyright IBM Corp. 2007, 2011. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, the IBM logo, ibm.com, TM1, and Cognos are trademarks or registered trademarks of International Business Machines Corp., in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml. Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Microsoft product screen shot(s) used with permission from Microsoft.

Table of Contents
Introduction

9 11

Chapter 1: TM1 Installation Overview

Upgrading TM1 11 Upgrading TM1, TM1 Perspectives, or TM1 Web 12 Upgrading TM1 Contributor 12 Installation Checklist 13 Planning Your TM1 Installation 13 TM1 Service Account 13 Microsoft .NET Framework Requirements 14 TM1 Web Requires Microsoft Chart Controls Component 16 Logging Installation Messages 17 Display resolution 18 Installing Components on Different Machines 18 Running the TM1 Installation Wizard 18 Starting the Installation Wizard 19 Choose a Product to Install 19 Custom or Standard Installation Options 20 Chapter 2: Installing TM1

23

Custom TM1 Installation 23 Custom TM1 Components 23 Configuring TCP/IP Ports for TM1 25 Username and Password for TM1 Services 26 Installing TM1 on Networks without Domains 27 Security Settings 27 Integrated Login Modes 28 Configuring the TM1 Server 29 Configuring TM1 Clients 30 Begin the Installation 31 Post-Installation Tasks 31 Standard TM1 Installation 32 Components for Standard TM1 Installation 32 Default Values for Standard TM1 Installation 33 Configuring Interoperability Between IBM Cognos 8 BI, Version 8.4.1 and IBM Cognos TM1 9.4 or 9.5 34 Chapter 3: Installing TM1 Perspectives

37

Custom TM1 Perspectives Installation 37 Configuring TM1 Perspectives 38 Standard TM1 Perspectives Installation 38 Components for Standard TM1 Perspectives Installation 38 Default Values for Standard TM1 Perspectives Installation 39

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

Table of Contents Chapter 4: Installing TM1 Web

41

Custom TM1 Web Installation 41 Configuring TM1 Web Components 41 Configuring TCP/IP Ports for TM1 Web 44 Username and Password for TM1 Services 44 Security Settings 44 Configuring the TM1 Server 45 Configuring TM1 Clients 45 Configuring Web Components 46 Standard TM1 Web Installation 46 Components for Standard TM1 Web installation 46 Default Values for Standard TM1 Web Installation 47 Chapter 5: Installing TM1 Contributor

49

TM1 Contributor Installation Checklist 50 Using TM1 Contributor with x64 Windows 51 IBM Cognos TM1 Contributor Administration and IBM Cognos Planning Contributor Web Clients on the same machine 51 TM1 Contributor Architecture and Deployment 52 Architecture 52 Deployment 54 Using the TM1 Installation Wizard to Install TM1 Contributor 55 Custom TM1 Contributor Installation 56 Standard TM1 Contributor Installation 58 Components for Standard TM1 Contributor Installation 58 Default Values for Standard TM1 Contributor Installation 59 Configuring Security Authentication for TM1 Contributor 59 Deploying TM1 Contributor on a Web Application Server 60 Deploying TM1 Contributor with IBM WebSphere Application Server 60 Deploying TM1 Contributor with Apache Tomcat 62 Configuring TM1 Contributor with Microsoft IIS 63 Starting TM1 Contributor 64 Determining the Startup Link for TM1 Contributor 64 Running TM1 Contributor for the First Time 65 Logging On to TM1 Contributor 66 Installing the TM1 Contributor Administration Tool 66 Install the TM1 Contributor Administration Tool Using a Web Link 67 Install the TM1 Contributor Administration Tool Using a Command Line 69 Uninstalling the TM1 Contributor Administration Tool 70 Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security 71 Configuring TM1 Contributor to use Multiple TM1 Servers 72 Font for TM1 Contributor Export to PDF 73 Uninstalling and Reinstalling TM1 Contributor 73 Chapter 6: Installing TM1 for 64-bit Windows

77

TM1 Components Not Included in the 64-bit TM1 Installation 77 Custom 64-bit TM1 Installation 78 Configuring TCP/IP Ports for 64-bit TM1 79 Username and Password 80

4 IBM Cognos TM1

Table of Contents Security Settings 80 Configuring the 64-bit TM1 Server 80 Standard 64-bit Installation 81 TM1 Components 81 Default Parameter Values 81 Chapter 7: Installing TM1 x86 on an x64 Windows System

83

WOW64 (32-bit) Application Space 83 Installation Notes about x86 and x64 TM1 Components 83 Location of Installed TM1 Program Files on an x64 System 84 Running TM1 x86 Server and Admin Server on Windows x64 84 Running TM1 Databases with Both x86 and x64 TM1 Servers 85 Chapter 8: Installing TM1 on UNIX

87

Pre-Installation Tasks 87 UNIX Installation Checklist 88 TM1 Components Supported on UNIX 88 Starting the Installation Wizard 89 Selecting a Language 89 Selecting TM1 Components for UNIX 89 Accept the License Agreement 90 Set the Installation Location 90 Configure TCP/IP Ports 90 TM1 Server Configuration 91 Installation Summary 91 After You Complete the Installation 92 TM1 Object Names and Character Encoding for TM1 Servers on UNIX and Windows Systems 92 Moving TM1 Databases Between Windows and UNIX Systems When Your TM1 Object Names Contain Non-ASCII Characters 92 Starting a TM1 Server in the Same Locale on a UNIX System When TM1 Object Names Contain Non-ASCII Characters 93 Uninstalling TM1 on UNIX 93 Silent TM1 Installation on UNIX 93 Console Installation on UNIX 94 Starting a TM1 Server on UNIX 95 Running the TM1 Server on UNIX in Background Mode 95 Running TM1 on IBM AIX 95 Setting IBM AIX Memory Resource Limits for TM1 95 Using IBM AIX Commands that Do Not Support File Names for TM1 Control Objects 95 Chapter 9: Installing TM1 Workflow

97

Workflow Prerequisites 97 Prerequisites 97 Workflow Installation Notes 97 TM1 Workflow Requires Manual Uninstall and Re-install when Upgrading TM1 Web 98 TM1 Workflow x64 installation procedure 98 Sophos Anti-virus may Prevent TM1 Workflow from Loading Properly 99 Running the TM1 Workflow Installation Wizard 99 Selecting TM1 Workflow Installation Components 100

Installation Guide 5

Table of Contents TM1 Workflow Components 100 Destination Folder for TM1 Workflow Components 101 Installing TM1 Workflow for the First Time 101 Installing TM1 Workflow for One Existing TM1 Database 102 Installing TM1 Workflow for Multiple TM1 Databases 102 Upgrading to TM1 Workflow from Planning Manager 1.3 102 Upgrading Planning Manager for One Existing TM1 Database 103 Upgrading Planning Manager for Multiple TM1 Databases 103 Configuring TM1 Workflow for Microsoft Excel 103 Troubleshooting the TM1 Workflow Excel Add-in 104 Using TM1 Workflow in Excel 2007 104 Using TM1 Workflow with TM1 Web 105 TM1 Workflow On The Web 105 TM1 Workflow Features in TM1 Web 105 Localizing TM1 Web Toolbar Captions 105 Chapter 10: Silent Windows Installation for IBM Cognos TM1 Clients Installing 107 Setup.exe Command Line Options 107 TM1 Installation Command Line Options 108 Example 111 Troubleshooting the Installation Script 111 Uninstall 111 Chapter 11: Using IBM Cognos 8 Security with TM1

107

113

IBM Cognos 8 Security Overview 113 Setting Up the TM1 Server to Use IBM Cognos 8 Security 114 Configuring the TM1 Server 114 Configuring the TM1 Client 116 Defining a Cognos User to Function as a TM1 Administrator 117 Importing Cognos Groups into TM1 118 Creating Users 119 Administering TM1 Object Security 119 Configuring TM1 Web to Use IBM Cognos 8 Security 119 Logging in to TM1 Top 119 Administrator Considerations When Using IBM Cognos 8 Authentication 119 User Considerations When Using IBM Cognos 8 Authentication 120 Chapter 12: Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services Configure TM1 to use IBM Cognos 8 Security 123 Install the TM1 Viewer Portlets 123 Configure Access to IBM Cognos 8 From the TM1 Viewer Portlets 124 Uninstall the TM1 Viewer Portlets 124 Chapter 13: Installing the IBM Cognos TM1 Package Connector

123

125

TM1 Package Connector requirements 125 Installing the TM1 Package Connector 125 Installing the TM1 Package Connector on Windows 7 or Vista 126 Enabling connectivity to SAP from TM1 126 Configuring the TM1 Package Connector 126

6 IBM Cognos TM1

Table of Contents Setting the environment variable 127 Setting the TM1 server configuration parameter 127 Installing on the client machine 128 Running the TM1 Package Connector 128 Installing the TM1 Package Connector on UNIX 128 Chapter 14: Maintaining Your TM1 Installation

131

Maintaining TM1 Components 131 Modifying TM1 Installed Components 131 Uninstalling IBM Cognos TM1 132 Backing Up Your TM1 Data 132 Restoring Your TM1 Databases 133 Index

135

Installation Guide 7

Table of Contents

8 IBM Cognos TM1

Introduction
This document is intended for use with IBM Cognos TM1. This document describes how to install TM1 software components on Microsoft Windows, UNIX and Linux 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 have a basic understanding of programming and installation concepts.

Finding information
To find IBM Cognos product documentation on the web, including all translated documentation, access one of the IBM Cognos Information Centers at http://publib.boulder.ibm.com/infocenter/ cogic/v1r0m0/index.jsp. Updates to Release Notes are published directly to Information Centers. You can also read PDF versions of the product release notes and installation guides directly from IBM Cognos product disks.

Samples disclaimer
The Great Outdoors Company, GO Sales, any variation of the Great Outdoors name, and Planning Sample depict fictitious business operations with sample data used to develop sample applications for IBM and IBM customers. These fictitious records include sample data for sales transactions, product distribution, finance, and human resources. Any resemblance to actual names, addresses, contact numbers, or transaction values is coincidental. Other sample files may contain fictional data manually or machine generated, factual data compiled from academic or public sources, or data used with permission of the copyright holder, for use as sample data to develop sample appli-

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

Introduction cations. Product names referenced may be the trademarks of their respective owners. Unauthorized duplication is prohibited.

Accessibility features
This product does not currently support accessibility features that help users with a physical disability, such as restricted mobility or limited vision, to use this product.

Forward-looking statements
This documentation describes the current functionality of the product. References to items that are not currently available may be included. No implication of any future availability should be inferred. Any such references are not a commitment, promise, or legal obligation to deliver any material, code, or functionality. The development, release, and timing of features or functionality remain at the sole discretion of IBM.

10 IBM Cognos TM1

Chapter 1: TM1 Installation Overview

The IBM Cognos TM1 Installation Wizard is designed to help you install TM1 software into the hardware environment you have configured for your TM1 applications.

TM1 Installation Components

TM1 is organized into the following 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. 23). TM1 Perspectives - TM1's add-in client for Microsoft Excel. 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. 37). 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. 41). TM1 Contributor - This option installs TM1 Web, plus all of the components for TM1 Contributor, allowing you to deploy and run managed planning applications based on TM1 data. For more information, see Installing TM1 Contributor.

Viewing Help Documentation during Installation

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.

Upgrading TM1
The steps to upgrade an existing TM1 installation depend on which TM1 components and which version you are currently using. Additional steps are required if you are also upgrading a previous version of TM1 Contributor.

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

11

Chapter 1: TM1 Installation Overview

Upgrading TM1, TM1 Perspectives, or TM1 Web

The following table summarizes the required actions to upgrade TM1 depending on which version you are currently using.

Upgrading from ...

TM1 9.5.x

Required Actions
Back up your data and then run the install to automatically upgrade an existing installation of TM1 version 9.5.x. Follow these steps to upgrade from TM1 9.4.x: "Backing Up Your TM1 Data" (p. 132). "Uninstalling IBM Cognos TM1" (p. 132). Install the newer version of TM1. "Restoring Your TM1 Databases" (p. 133).

TM1 9.4.x

TM1 9.0.x or 9.1.x

Upgrading to TM1 9.5.2 from version 9.0.x or 9.1.x requires a full manual uninstall, and then a full installation of 9.5.2. Note: TM1 9.0.x and 9.1.x databases are automatically converted to Unicode when they are opened (started) with a TM1 server version 9.4 or higher. Once a an older TM1 database is converted to Unicode, it can no longer be opened in the earlier versions of TM1. Follow these steps to upgrade from TM1 9.0.x or 9.1.x: "Backing Up Your TM1 Data" (p. 132). "Uninstalling IBM Cognos TM1" (p. 132). Install the newer version of TM1. "Restoring Your TM1 Databases" (p. 133).

Upgrading TM1 Contributor

Upgrading TM1 Contributor 9.5.x to TM1 Contributor 9.5.2 requires the following series of steps: Stopping and starting the related services. Backing up and restoring your TM1 Contributor application files. Uninstalling and reinstalling the IBM Cognos Rich Client Framework. Undeploying and redeploying the TM1 Contributor Web application.

For details, see the following topics: "Uninstalling and Reinstalling TM1 Contributor" (p. 73).

12 IBM Cognos TM1

Chapter 1: TM1 Installation Overview "Uninstalling the TM1 Contributor Administration Tool" (p. 70).

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 User Guide and the IBM Cognos TM1 Developer 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 Operation Guide for details on how to design the optimal TM1 environment. Determine your software requirements. For a complete list of supported platforms and software, refer to the TM1 Software Environments page available on the IBM Cognos TM1 Information Center website at http://publib.boulder.ibm.com/infocenter/ctm1/v9r5m0/index.jsp. Adobe Reader is required on client computers for viewing PDF versions of the documentation and for exports from TM1. See the Information Center Software Environments link for current requirements. 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, create a single domain account for all your TM1 Services running on Microsoft Windows. For details, see "TM1 Service Account" (p. 13).

Planning Your TM1 Installation

Before installing TM1, you should review the pre-installation and configuration topics in this section.

TM1 Service Account

Before you install TM1, create a single domain account for all your TM1 Serves running on Microsoft Windows, such as the TM1 Server, TM1 Admin Server, and TM1 Excel Service. The account should be a member of the Local Administrator group and also be included in the database owner group to access SQL tables and views. The account must have the following privileges on the local machine: Act as part of the operating system Bypass traverse checking

Installation Guide 13

Chapter 1: TM1 Installation Overview Increase quotas Replace a process level token Log on as a service Have read and write privileges on the Windows Registry item

The Installation Wizard will enable and use these privileges during the installation process. This account applies only to services and agents running on Windows. TM1 installed on UNIX or Linux systems needs to run as a user with appropriate permissions for TM1 binaries and TM1 databases. For more details, see "Installing TM1 on UNIX" (p. 87).

Microsoft .NET Framework Requirements

The TM1 Rules Editor requires the installation of the Microsoft.NET Framework Version 3.5 SP1. You can download it from the Microsoft website. When you install a message appears to remind you of this requirement. Microsoft Internet Information Services (IIS) must be installed before installing the .NET 3.5 framework that is required for TM1 Web. If you install the .NET 3.5 framework before installing IIS, the TM1 Web installation will fail with an ASPNET error. For a complete list of supported platforms and software, refer to the TM1 Software Environments listing available on the IBM Cognos Information Center. To ensure that the .NET Framework 3.5 SP1 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

For an x64 Windows system, use the following directory:

C:\WINDOWS\Microsoft.NET\Framework64\v2.0.50727

Note: IBM Cognos TM1 Web requires the Microsoft .NET Framework 3.5 SP1, however, .NET 2.0 remains on your system after upgrading .NET and is required for this step. 2. Execute the following command: aspnet_regiis.exe -i

Registering Microsoft ASP .NET Framework

If you do not perform the previous steps, or for some reason the Microsoft ASP.NET Framework 3.5 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.

14 IBM Cognos TM1

Chapter 1: TM1 Installation Overview 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 "Microsoft .NET Framework Requirements" (p. 14). 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. Additionally, if you plan to run TM1 Web you must install a currently supported version of Microsoft Excel on the same machine where the IIS web server is installed. If a currently-supported version of Excel 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. Refer to the TM1 Software Environments page available on the IBM Cognos TM1 Information Center website at http://publib.boulder.ibm.com/infocenter/ctm1/v9r5m0/index.jsp for the supported versions.

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.

Installation Guide 15

Chapter 1: TM1 Installation Overview 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.

TM1 Web Requires Microsoft Chart Controls Component

As of TM1 version 9.5.2, TM1 Web requires the following third-party chart component software on the Web server where TM1 Web is running: Microsoft Chart Controls for Microsoft .NET Framework 3.5. This component supports the charting of data in the TM1 Web and TM1 Contributor user interfaces. For more details about the Microsoft Chart Controls component, search the Microsoft web site for this topic.

Installing the Microsoft Chart Controls Component

When you perform a TM1 Web or TM1 Contributor installation, this component is automatically installed for you on the same computer where you have chosen to install the TM1 Web components.

16 IBM Cognos TM1

Chapter 1: TM1 Installation Overview The Microsoft Chart Controls component requires the Microsoft .NET 3.5 SP1 Framework. If the chart component installation does not find the .NET Framework on the targeted computer, then it installs the .NET 3.5 SP1 Framework along with the chart component. Cancelling the TM1 or chart component installation has the following behavior: If you cancel during the installation of the chart component, the TM1 installation is also cancelled. If you cancel the TM1 Installation Wizard after the chart component has been installed, the TM1 installation stops and backs out any changes, but the chart component does not uninstall. If you need to remove the chart component, use the Microsoft Windows Add or Remove Programs feature.

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 name of the log file depends on which version of TM1 you are installing: For the 32-bit (x86) version of TM1, the log file is named IBM_TM1Install.log. For the 64-bit version of TM1, the log file is named IBM_TM1x64Install.log.

Earlier versions used a slightly different name. The file 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 on a Windows system.

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 IBM_TM1Install.log.

Installation Guide 17

Chapter 1: TM1 Installation Overview

Display resolution
Installing on a system with a high screen resolution may distort the font or image display in the Installation Wizard. When installing on a system with a high screen resolution of 1920 X 1200 with normal font size (96 DPI) or 1280 X 720 with large font size (120 DPI) distortion can occur. The installation will still function, but as a workaround, you can set your resolution to 1280 X 720 with normal font size (96 DPI) or lower.

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.

TM1 Admin Server

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. 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 Microsoft WindowsStart Menu, Regional and Local Settings.

Running the TM1 Installation Wizard

The TM1 installation wizard installs TM1 components on Microsoft Windows systems. Note: Installation Wizard error messages are displayed in English. For details about installing TM1 on UNIX or Linux, see "Installing TM1 on UNIX" (p. 87).

18 IBM Cognos TM1

Chapter 1: TM1 Installation Overview

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 Your TM1 Installation" (p. 131) 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. 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 TM1 Contributor - includes TM1 Web plus components for building and running managed planning applications based on TM1 data

Installation Guide 19

Chapter 1: TM1 Installation Overview

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.5. See "Microsoft .NET Framework Requirements" (p. 14) 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. 32), 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. 26) for the next step in the Standard installation process. A Custom installation, see "Custom TM1 Components" (p. 23), 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 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. Note that you will be unable to start the server if there is a hyphen in the install directory path.

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. 37), "Installing TM1" (p. 23), or "Installing TM1 Web" (p. 41) for details. See "Installing TM1 for 64-bit Windows" (p. 77), "Installing TM1 x86 on an x64 Windows System" (p. 83), or "Installing TM1 on UNIX" (p. 87) for details on installing in those environments. See "Installing TM1 Workflow" (p. 97) for information about installing the TM1 Workflow component.

20 IBM Cognos TM1

Chapter 1: TM1 Installation Overview 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.

Installation Guide 21

Chapter 1: TM1 Installation Overview

22 IBM Cognos TM1

Chapter 2: Installing TM1

This section describes how to install IBM Cognos TM1 components using either the Standard or Custom installation options. Follow these steps to install TM1 components.

Steps
1. Run the TM1 Installation Wizard, answer the introductory prompts, and advance to the Choose a Product to Install screen. For details, see "Starting the Installation Wizard" (p. 19). 2. Select TM1 and click Next. 3. Choose the installation type. "Custom TM1 Installation" (p. 23). "Standard TM1 Installation" (p. 32).

4. Advance through the Installation Wizard screens to complete the installation.

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.

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.

Clients

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

23

Chapter 2: Installing TM1

Component

Installed Description by default

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 or TM1 Contributor installation.

Developer's 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.

24 IBM Cognos 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. 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 TM1 server running on UNIX, 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 Operation Guide for details on configuring the TM1Top.ini file.

TM1 Contributor

No

TM1 Contributor enables you to design, deploy and run managed planning applications based on TM1 data. This option installs the required files for deploying and running TM1 Contributor.

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 25

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. 26) for more information. TM1 Client Message port number 12345 This is a sample default. The system chooses the next available port number. 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.

26 IBM Cognos TM1

Chapter 2: Installing TM1

Account
Re-enter password

Description
Re-enter your password to confirm correct entry.

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. 27).

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 Microsoft Windows domain, you cannot use Integrated Login. For more information, see "Security Settings" (p. 27).

Using Local Machine Syntax

Do not use dot, as in "." 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.

Installation Guide 27

Chapter 2: Installing TM1

Authentication Mode
TM1 Authentication

Description
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. 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 Authentication

LDAP Port

The port on which the LDAP server is running. If a port is not specified, 636 is used. TM1 attempts to bind to an LDAP server on the specified secure port. If you do not enter an LDAPPort value, TM1 uses the default value of port 636 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.

28 IBM Cognos TM1

Chapter 2: Installing TM1

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.

Integrated Login Only

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 Operation 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 Operation 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 Data. 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.

Installation Guide 29

Chapter 2: Installing TM1

Server Settings
Server Name

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

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 as the default since it prevents users from accidently overwritting formulas in slice worksheets. For best results keep this option selected. Checking this option triggers a custom action that initializes the registered COM object named Excel.Application. This service is found in the Component Services panel.

30 IBM Cognos TM1

Chapter 2: Installing TM1

Client Parameters
Set TM1 to Autoload in Excel

Description
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. 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.

Use Integrated Login

Begin the Installation

When all the settings 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.

Installation Guide 31

Chapter 2: Installing TM1

Service
TM1 Server

Description
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.

Start a TM1 Server Installed as a Service or Application

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 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. To start a remote server that has been set up as a Windows application, perform the following step.

Step
Double-click the shortcut icon for the server you want to start.

Standard TM1 Installation

This section describes the components and default values that are installed when you choose the Standard TM1 installation.

Components for Standard TM1 Installation

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

32 IBM Cognos TM1

Chapter 2: Installing TM1

Component

Installed by default
Yes

Description

Clients

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

Developer's Environment Yes Yes Yes Servers Yes Yes

Default Values for Standard TM1 Installation

A Standard TM1 installation uses the following default values:

Item
Admin Server port number SSL port number TM1 server port number TM1 Client Message port number

Default Value
5495 (unsecured) 5498 (secured) 12345 12345 This is a sample default. The system chooses the next available port number. This port number establishes a secondary port for progress messages to use when a lengthy operation is waiting to be cancelled.

TM1 server name Admin Server host name Sample data directory for TM1 server

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

Installation Guide 33

Chapter 2: Installing TM1

Item
Security mode

Default Value
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. 27).

Configuring Interoperability Between IBM Cognos 8 BI, Version 8.4.1 and IBM Cognos TM1 9.4 or 9.5
To ensure that access to version 9.4 or 9.5 of IBM Cognos TM1 and IBM Cognos TM1 Executive Viewer works with dashboards in IBM Cognos 8 BI version 8.4.1, you must install the BI and TM1 portlets products in separate locations. Then you must carefully copy some of the TM1 files and Executive Viewer files from the TM1 installation locations, and some of the Executive Viewer files from the Executive Viewer installation locations, to the BI server locations. The following installation options are supported: IBM Cognos 8 BI version 8.4 and IBM Cognos TM1 products are installed in separate locations, and you upgrade to IBM Cognos 8 BI version 8.4.1. IBM Cognos 8 BI (version 8.4.1 or version 8.4 which was upgraded to version 8.4.1) is installed, and now you are installing IBM Cognos TM1 products in a separate location.

Steps
1. Follow the instructions in the IBM Cognos 8 BI Installation and Configuration Guide to install or upgrade to IBM Cognos 8 BI, version 8.4.1 in a separate location from IBM Cognos TM1, version 9.x. 2. If you are adding IBM Cognos TM1 for the first time, install IBM Cognos TM1 in a separate location and then install IBM Cognos TM1 Executive Viewer either in the same location as IBM Cognos TM1 or in a different location. Tip: Ensure that you configure the variables_TM1.xml file before you copy files in the following steps. For more information, see the IBM Cognos TM1 Fragments Installation and Configuration Guide. 3. Stop the services on the BI computers. 4. In the TM1 installation location, copy the following files from the TM1_location to the BI_location on the BI gateway computer: ...\webcontent\fragments\tm1viewers\fdom.js ...\webcontent\fragments\tm1viewers\tm1skin.js 34 IBM Cognos TM1

Chapter 2: Installing TM1 5. In the TM1 installation location, copy the following files from TM1_location to the BI_location on the BI Application Tier Components computers where the BI presentation service is enabled: ...\templates\ps\portal\variables.xsd ...\templates\ps\portal\variables_TM1.xml ...\templates\ps\tm1\messages\tm1_*.xml ...\templates\ps\tm1\* ...\webapps\p2pd\WEB-INF\fragments\producers\messages\tm1*.xml ...\webapps\p2pd\WEB-INF\fragments\producers\tm1viewers\* ...\webapps\p2pd\WEB-INF\lib\tm1f_javastage.jar 6. In the TM1 Executive Viewer installation location, copy the following Executive Viewer contents from TM1EV_location to the BI_location on the BI gateway computers: ...\webcontent\documentation\en\ev_*.html ...\webcontent\documentation\en\images\ev_* ...\webcontent\fragments\executiveviewer\* 7. In the TM1 Executive Viewer installation location, copy the following Executive Viewer contents from TM1EV_location to BI_location on the BI Application Tier Components computers where the BI presentation service is enabled: ...\webapps\p2pd\WEB-INF\fragments\producers\executiveviewer\* ...\webapps\p2pd\WEB-INF\fragments\producers\messages\executiveviewer_* ...\webapps\p2pd\WEB-INF\lib\evwebservice.jar ...\webapps\p2pd\WEB-INF\lib\executiveviewer.jar ...\webcontent\documentation\en\ev_*.html 8. Start the BI services.

Installation Guide 35

Chapter 2: Installing TM1

36 IBM Cognos TM1

Chapter 3: Installing TM1 Perspectives

This section describes how to install IBM Cognos TM1 Perspectives, the TM1 Excel Add-in, using the Standard or Custom installation. Follow these steps to install TM1 Perspectives.

Steps
1. Run the TM1 Installation Wizard, answer the introductory prompts, and advance to the Choose a Product to Install screen. For details, see "Starting the Installation Wizard" (p. 19). 2. Select TM1 Perspectives and click Next. 3. Choose the installation type. "Custom TM1 Perspectives Installation" (p. 37). "Standard TM1 Perspectives Installation" (p. 38).

4. Advance through the Installation Wizard screens to complete the 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. 38) 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. 23).

Component

Installed Description by default

No Yes TM1 Client TM1 Perspectives TM1 Architect

Clients

Developer's Environ- No ment Yes

TM1 API

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

37

Chapter 3: Installing TM1 Perspectives

Component

Installed Description by default

Yes Yes TM1Java API TM1 .NET API TM1 Admin Server TM1 Server TM1 Web Components TM1 Top Files for deploying and running TM1 Contributor

Servers

No No No No

TM1 Contributor

No

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. 30). These values are written to the Tm1p.ini file. Disable Excel Edit Directly in Cell Set TM1 to Autoload in Excel Use Integrated Login

Standard TM1 Perspectives Installation

This section describes the components and default values that are installed when you choose the Standard TM1 Perspectives installation.

Components for Standard TM1 Perspectives Installation

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

Component

Installed by default
Yes Yes Yes

Description

Clients Developer's Environment

TM1 Perspectives TM1 API TM1 Java API

38 IBM Cognos TM1

Chapter 3: Installing TM1 Perspectives

Component

Installed by default
Yes

Description

TM1 .NET API TM1 Admin Server TM1 server (local) port number

Servers

Yes Yes

Default Values for Standard TM1 Perspectives Installation

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

Item
Admin Server port number SSL port number TM1 server (local) port number 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

Disabel Excel Edit Directly in Cell

Installation Guide 39

Chapter 3: Installing TM1 Perspectives

40 IBM Cognos TM1

Chapter 4: Installing TM1 Web

IBM Cognos TM1 Web includes all components of TM1, plus additional functionality to browse and update TM1 data using a standard web browser. This section describes how to install IBM Cognos TM1 Web on a network using either the Standard or Custom installation options. Follow these steps to install TM1 Web.

Steps
1. Run the TM1 Installation Wizard, answer the introductory prompts, and advance to the Choose a Product to Install screen. For details, see "Starting the Installation Wizard" (p. 19). 2. Select TM1 Web and click Next. 3. Choose the installation type. "Custom TM1 Web Installation" (p. 41). "Standard TM1 Web Installation" (p. 46).

4. Advance through the Installation Wizard screens to complete the installation. If your system does not have Microsoft Chart Controls for Microsoft .NET Framework 3.5, the TM1 installation will install it for you. TM1 Web requires this component to support the charting of data. For details, see "TM1 Web Requires Microsoft Chart Controls Component" (p. 16).

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. 46) for the defaults set when you choose a Standard Web installation.

Configuring TM1 Web Components

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

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

41

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

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.

Developer's 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.

42 IBM Cognos 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.

Yes

TM1 Top A TM1 utility that enables you to dynamically monitor threads running in an instance of a Microsoft 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.

Installation Guide 43

Chapter 4: Installing TM1 Web

Component

Installed by default
No

Description

TM1 Contributor

TM1 Contributor enables you to design, deploy and run managed planning applications based on TM1 data. This option installs the required files for deploying and running TM1 Contributor.

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 number

Username and Password for TM1 Services

On Microsoft Windows, all TM1 services must run under a single domain account that you specify. For details, see "Username and Password for TM1 Services" (p. 26). 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. 27).

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 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. 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 Authentication

44 IBM Cognos TM1

Chapter 4: Installing TM1 Web

Authentication Mode Description

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 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. 29) 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

See "Configuring the TM1 Server" (p. 45) 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.

Installation Guide 45

Chapter 4: Installing TM1 Web Admin Server Host Name Disabel Excel Edit in Cell 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. If you use a directory other than the default directory, be sure the Administrator; Authenticated Users; IIS_WPG; and System have full control and that Internet Guest Account and Users have read/execute permissions. If the Windows permissions on this directory are restricted, the TM1 Web client may not be accessible to all users. 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

This section describes the components and default values that are installed when you choose the Standard TM1 Web installation.

Components for 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. 23).

Component
Clients

Installed by default
Yes Yes Yes

Description
TM1 Client TM1 Perspectives TM1 Web Components TM1 Architect TM1 API

Developer's Environment

Yes Yes

46 IBM Cognos TM1

Chapter 4: Installing TM1 Web

Component

Installed by default
Yes Yes

Description
TM1 Java API TM1 .NET API TM1 Admin Server TM1 Server (local) TM1 Top

Servers

Yes Yes Yes

Default Values for Standard TM1 Web Installation

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

Item
Admin Server port number SSL port number TM1 server port number 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 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

Disabel Excel edit in cell

Selected

Installation Guide 47

Chapter 4: Installing TM1 Web

48 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor

This section describes how to install IBM Cognos TM1 Contributor on a single computer or a network using either the Standard or Custom installation options. TM1 Contributor includes all the components of TM1 Web, plus additional functionality to design, deploy and run managed planning applications based on TM1 data. Note: Installing TM1 Contributor requires a number of steps. You must run the TM1 Installation Wizard and also perform additional manual steps to deploy, configure and run the application on a Java-based Web server. For an overview of all the steps, see "TM1 Contributor Installation Checklist" (p. 50). For additional TM1 Contributor documentation, see the following: IBM Cognos TM1 Contributor Administration Guide IBM Cognos TM1 Contributor User Guide

Steps to install, deploy, configure and run TM1 Contributor

1. Review the system requirements and make sure the required components are installed. For details see, http://www-01.ibm.com/support/docview.wss?uid=swg27018895#contributor. 2. Review the installation checklist. For details see, "TM1 Contributor Installation Checklist" (p. 50). 3. Install TM1 Contributor using the TM1 Installation Wizard. For details see, "Using the TM1 Installation Wizard to Install TM1 Contributor" (p. 55). 4. Determine the security authentication mode you want your TM1 servers to use with TM1 Contributor. For details, see Configuring Security Authentication for TM1 Contributor. 5. Deploy the TM1 Contributor Web application. For details see, "Deploying TM1 Contributor on a Web Application Server" (p. 60) If you want to use TM1 Contributor with IBM Cognos 8 Security, see the section "Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security" (p. 71). 6. Start and configure TM1 Contributor. For details see, "Starting TM1 Contributor" (p. 64) 7. Install the TM1 Contributor Administration Tool. For details see, "Installing the TM1 Contributor Administration Tool" (p. 66).

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

49

Chapter 5: Installing TM1 Contributor

TM1 Contributor Installation Checklist

To install, deploy, configure and run TM1 Contributor: Review architecture and deployment information. For details, see TM1 Contributor Architecture and Deployment. Install required software components. Install Microsoft .NET 3.5 SP1 Framework. Install Microsoft Internet Information Services (IIS) (ASP). You can use either the 32-bit and 64-bit. Install Java SE Runtime Environment (JRE) version 6 for Windows

Install required Java-based Web application server. Download and install one of the following Java-based Web application servers to host TM1 Contributor: IBM WebSphere Application Server Download the IBM WebSphere Application Server from the related IBM web site. After installing, adjust the JAVA_OPTS parameter in the WebSphere setenv.bat, if necessary. For details see, Troubleshooting Deployment with IBM WebSphere. Apache Tomcat Download and install Apache Tomcat version 6.0.x from the tomcat.apache.org Web site. On the Download page, look under the Binary Distributions section, Core sub-section for the Windows Service Installer in .exe format. Make sure the Apache Tomcat encoding is set to utf-8. For details see, Deploying TM1 Contributor with Apache Tomcat. If you are using TM1 Contributor with IBM Cognos 8 Security, you can optionally use the instance of Apache Tomcat provided with IBM Cognos 8. For details see, Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security.

Note: Make sure that Web server you install is not using the same TCP port as any other application on that same computer. For example, if you are running Apache Tomcat and IIS on the same machine, make sure they are each using a different TCP port. Install TM1 Contributor. For details see, Using the TM1 Installation Wizard to Install TM1 Contributor. Determine security authentication mode to use. You can use either TM1 standard authentication security or IBM Cognos 8 security with TM1 Contributor. Do not use both security modes.

50 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor For best practice, determine the security mode before configuring TM1 Contributor to use a TM1 server. Use the same security mode with any additional servers you add. For more details, see Configuring Security Authentication for TM1 Contributor. Deploy TM1 Contributor on a Java-based Web server. If you are not using TM1 Contributor with IBM Cognos 8 Security, deploy TM1 Contributor with either Apache Tomcat or IBM WebSphere. For details, see one of the following topics: Deploying TM1 Contributor with IBM WebSphere Application Server. Deploying TM1 Contributor with Apache Tomcat.

If you are using TM1 Contributor with IBM Cognos 8 Security, deploy TM1 Contributor with either the instance of Apache Tomcat provided with IBM Cognos 8 or the version of Tomcat you downloaded and installed. For details, see Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security. Start up and configure TM1 Contributor. For details see, Configure TM1 Contributor to use a TM1 Server and Web Client If you are using TM1 Contributor with IBM Cognos 8 Security, you will also need to configure the IBM Cognos 8 Gateway and Dispatcher URI parameters. For details see, Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security. Install the TM1 Contributor Administration tool. This tool enables TM1 Contributor administrators and developer to design and deploy TM1 Contributor planning applications. For details see, Installing the TM1 Contributor Administration Tool. Configure additional TM1 servers. If necessary, you can configure TM1 Contributor to use additional TM1 servers after the application is up and running. Note: If you want to use multiple TM1 servers with TM1 Contributor, they must all use the same security authentication (either TM1 standard authentication or IBM Cognos 8 security). For details see, Configuring TM1 Contributor to use Multiple TM1 Servers.

Using TM1 Contributor with x64 Windows

When running TM1 Contributor on an x64 Microsoft Windows system, use the same 32-bit or 64-bit versions of the Java Runtime Environment (JRE) and Apache Tomcat web server. Do not mix platform versions. For example, if you are using the 64-bit version of JRE, then you should also use the 64-bit version of Apache Tomcat.

IBM Cognos TM1 Contributor Administration and IBM Cognos Planning Contributor Web Clients on the same machine
When IBM Cognos TM1 Contributor Administration Client and IBM Cognos 8.4 Planning Contributor Web Client are installed on the same machine, the TM1 Contributor Administration

Installation Guide 51

Chapter 5: Installing TM1 Contributor must be installed first to properly set the provisioning scenario. If you are installing TM1 Contributor Administration onto a machine that previously ran IBM Cognos Planning Web Client, use the ModelingADT.msi to install.

TM1 Contributor Architecture and Deployment

This section provides architecture and deployment information to help you plan your installation and configuration of IBM Cognos TM1 Contributor.

Architecture
IBM Cognos TM1 Contributor has a multi-tiered architecture that consists of three tiers: Web clients, Web application servers, and data.
Tier 1: Web Clients (IBM Cognos TM1 Contributor user interfaces) IBM Cognos Rich Client Framework Portal Workflow Administration TM1 Contributor Web client

Tier 2: Web Application Servers Java Web Application Server IBM WebSphere - or Apache Tomcat Microsoft IIS Web Server

Tier 3: Data TM1 Admin Server

TM1 Server

TM1 Server

TM1 Server

Tier 1: Web Clients

The Web clients tier contains all the Web-based user interfaces for IBM Cognos TM1 Contributor. These user interfaces are used by TM1 Contributor end-users, administrators and planning application developers. The Portal, Workflow and Administration clients are supported by a Java-based Web application server, such as IBM WebSphere. The TM1 Contributor client is supported by a Web server running Microsoft Internet Information Services (IIS).

Portal Client
The TM1 Contributor Portal client is the main starting point for both administrator and nonadministrator users. This client provides a list of available planning applications that is filtered for the current user. Clicking on an application in the Portal client opens the Workflow client.

52 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor

Workflow Client
The TM1 Contributor Workflow client is used to manage tasks within a plan. This client displays each node that a user is responsible for contributing to and/or reviewing in a specific plan. The user can open the TM1 Contributor client for any accessible node in this client.

Administration Client
The TM1 Contributor Administration client provides the user interface used by administrators and developers to design and deploy TM1 Contributor planning applications. This user interface requires the IBM Cognos Rich Client Framework to be installed on the user's computer. The framework can be installed by the user the first time they open the Administration client or system administrators can distribute and install the framework remotely using a Windows Installer command line and other software management tools. For details, see "Installing the TM1 Contributor Administration Tool" (p. 66).

TM1 Contributor Client

The TM1 Contributor client enables users to view and edit planning application data in a grid format. This client can also display data in chart format.

Tier 2: Web Application Servers

The Web application servers tier contains two Web servers; a Java-based Web application server and a Microsoft Internet Information Services (IIS) Web server. TM1 Contributor requires both of these web servers in tier 2 to support the different Web client user interfaces contained in tier 1.

Java Web Application Server

For the Java-based Web application server, you can use either IBM WebSphere Application Server or Apache Tomcat. For details, see "Deploying TM1 Contributor on a Web Application Server" (p. 60). If you configure TM1 Contributor to use IBM Cognos 8 security, you can deploy TM1 Contributor with the Apache Tomcat Web server that is supplied with IBM Cognos 8. For details, see "Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security" (p. 71)

Microsoft IIS Web Server

TM1 Contributor requires Microsoft Internet Information Services (IIS) to support the TM1 Contributor client. The TM1 Contributor client is the tool used for viewing and editing planning application data. For more details, see "Configuring TM1 Contributor with Microsoft IIS" (p. 63).

Tier 3: Data
The data tier represents a TM1 Admin Server and one or more TM1 servers running on either a Microsoft Windows or UNIX-based system.

TM1 Admin Server

The TM1 Admin Server is a process that keeps track of all TM1 servers running on a network. TM1 Contributor communicates with the Admin Server to determine which TM1 servers are

Installation Guide 53

Chapter 5: Installing TM1 Contributor available on the network. For more details about the Admin Server, see the IBM Cognos TM1 Operations Guide.

TM1 Server
The TM1 server contains the data for the planning applications that you build and deploy with TM1 Contributor.

Deployment
Depending on your specific network environment and business requirements, you can install TM1 Contributor on a single stand-alone computer or on several different computers across a network.

Installing all TM1 Contributor Components on a Single Computer

For development, testing or demonstration purposes, you can install all of the required components for TM1 Contributor onto a single computer. In this configuration, you run both the Java Web application server and Microsoft Internet Information Services (IIS) on the same computer. To install all of the TM1 Contributor components on a single computer, use the TM1 Installation Wizard. For details, see "Using the TM1 Installation Wizard to Install TM1 Contributor" (p. 55). After completing the installation, deploy TM1 Contributor using the Java application server on the same computer. For details, see "Deploying TM1 Contributor on a Web Application Server" (p. 60).

Installing TM1 Contributor Components on Separate Computers

Installing some or all of the TM1 Contributor components on separate dedicated computers can improve performance, availability, and capacity. For example, you may: Install the Web application servers tier and the data tier on separate computers. This configuration combines the Java Web application server and Microsoft Internet Information Services (IIS) on the same computer but locates the data tier (TM1 server) on a separate computer. Install the Web application servers on separate computers. This configuration places the Java Web application server and Microsoft IIS on their own computers. The data tier could also be installed on its own dedicated computer. Install all TM1 Contributor components on separate computers. This configuration places the Java Web application server, Microsoft IIS, TM1 Admin Server and the TM1 server(s) all on separate computers.

Checklist for Installing TM1 Contributor Components on Separate Computers

Use the following checklist to help you install TM1 Contributor components on separate computers. If you are running Microsoft IIS on a separate computer, use the TM1 Installation Wizard to install TM1 Contributor on that system. The Wizard installs the required files for the TM1 Contributor client - the tool used for viewing and editing planning application data. For details, see "Configuring TM1 Contributor with Microsoft IIS" (p. 63). If you are running your Java application server on a separate computer, use the TM1 Installation Wizard to install TM1 Contributor on that computer or another computer and then manually

54 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor copy and deploy the TM1 Contributor Web application archive file, pmpsvc.war on the computer running the Java application server. For details, see "Deploying TM1 Contributor on a Web Application Server" (p. 60). If you are running the data tier on a separate computer, use the TM1 Installation Wizard to perform a custom TM1 installation of the TM1 Admin Server and TM1 server on that computer. For more information, see "Installing Components on Different Machines" (p. 18)

Using the TM1 Installation Wizard to Install TM1 Contributor

Use the Installation Wizard to install the required components and files for TM1 Contributor. Note: The Installation Wizard installs, but does not deploy, the TM1 Contributor Web application archive file, pmpsvc.war. After running the Installation Wizard, you must perform additional steps to deploy and configure TM1 Contributor on a Java-based Web application server. For an overview of all the steps, see the "TM1 Contributor Installation Checklist" (p. 50).

Steps
1. Run the TM1 Installation Wizard, answer the introductory prompts, and advance to the Choose a Product to Install screen. For details, see "Starting the Installation Wizard" (p. 19). 2. Select TM1 Contributor and click Next. 3. Choose the installation type. "Custom TM1 Contributor Installation" (p. 56). "Standard TM1 Contributor Installation" (p. 58).

4. Advance through the Installation Wizard screens to complete the installation. If your system does not have Microsoft Chart Controls for Microsoft .NET Framework 3.5, the TM1 installation will install it for you. TM1 Contributor requires this component to support the charting of data. For details, see "TM1 Web Requires Microsoft Chart Controls Component" (p. 16). To complete the deployment and configuration of TM1 Contributor, perform the remaining steps: "Configuring Security Authentication for TM1 Contributor" (p. 59). "Deploying TM1 Contributor on a Web Application Server" (p. 60). "Starting TM1 Contributor" (p. 64). "Installing the TM1 Contributor Administration Tool" (p. 66).

Installation Guide 55

Chapter 5: Installing TM1 Contributor

Custom TM1 Contributor Installation

Use the Custom TM1 Contributor installation to select the exact TM1 components to install. By default, a Custom TM1 Contributor installation includes all of the same components as a custom TM1 Web installation plus the required files to deploy TM1 Contributor.

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

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.

Developer's 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 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.

56 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor

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.

Yes

TM1 Top A TM1 utility that enables you to dynamically monitor threads running in an instance of a Microsoft 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.

Installation Guide 57

Chapter 5: Installing TM1 Contributor

Component

Installed by default
Yes

Description

TM1 Contributor

TM1 Contributor enables you to design, deploy and run managed planning applications based on TM1 data. This option installs the required files for deploying and running TM1 Contributor.

Standard TM1 Contributor Installation

This section describes the components and default values that are installed when you choose the Standard TM1 Contributor installation.

Components for Standard TM1 Contributor Installation

A Standard IBM Cognos TM1 Contributor installation installs all of the same components as a Standard TM1 Web installation plus the required files to deploy and run TM1 Contributor. For a full description of these components, see "Custom TM1 Contributor Installation" (p. 56).

Component
Clients

Installed by default
Yes Yes Yes

Description
TM1 Client TM1 Perspectives TM1 Web Components TM1 Architect TM1 API TM1 Java API TM1 .NET API TM1 Admin Server TM1 Server (local) TM1 Top Files for deploying and running TM1 Contributor

Developer's Environment

Yes Yes Yes Yes

Servers

Yes Yes Yes

TM1 Contributor

Yes

58 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor

Default Values for Standard TM1 Contributor Installation

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

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

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 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 Perspectives/TM1 Architect Security mode

Disable Excel edit in cell

Selected

Configuring Security Authentication for TM1 Contributor

You can use either TM1 standard security authentication or IBM Cognos 8 security for the TM1 servers you use with TM1 Contributor. Do not use a combination of different security authentication modes for the same TM1 Contributor web application. For best practice, determine the security mode before you configure TM1 Contributor to use a TM1 server and use that same security mode with any additional servers you add. For details about using IBM Cognos 8 security, see:"Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security" (p. 71).

Using the IntegratedSecurityMode Parameter with TM1 Contributor

You set the TM1 security authentication mode using the IntegratedSecurityMode parameter in the Tm1s.cfg file of each TM1 server you want to use. TM1 Contributor is compatible only with TM1 security authentication modes 1 and 5.

Installation Guide 59

Chapter 5: Installing TM1 Contributor For example, to use TM1 standard security authentication, set the IntegratedSecurityMode parameter to 1 for each server.
IntegratedSecurityMode=1

To use IBM Cognos 8 security, set the IntegratedSecurityMode parameter to 5.

IntegratedSecurityMode=5

For more details about the IntegratedSecurityMode parameter, see the "TM1 System Configuration" section in the IBM Cognos TM1 Operations Guide.

Configuring TM1 Contributor Security for Multiple TM1 Servers

If you want to use multiple TM1 servers with TM1 Contributor, they must all be configured to use the same security authentication (either TM1 standard authentication or IBM Cognos 8 security) and include the same administrator user name and password. For more details, see "Configuring TM1 Contributor to use Multiple TM1 Servers" (p. 72).

Deploying TM1 Contributor on a Web Application Server

After installing TM1 Contributor, you must manually deploy the application to one of the following Java-based Web application servers. IBM WebSphere Application Server Apache Tomcat

To deploy TM1 Contributor on a Java-based Web server, use the TM1 Contributor Web application archive file, pmpsvc.war. This file is located in the Cadmin folder in the TM1 installation directory, typically:
C:\Program Files\Cognos\TM1\Cadmin

Note: In additional to requiring a Java-based Web server, TM1 Contributor also requires Microsoft Internet Information Services (IIS) to support the TM1 Contributor client. For more details, see "Configuring TM1 Contributor with Microsoft IIS" (p. 63).

Deploying TM1 Contributor with IBM WebSphere Application Server

Use the WebSphere Administrative Console to deploy and run the TM1 Contributor application with IBM WebSphere Application Server.

Steps
1. Start IBM WebSphere Application Server. In Windows, click Start, Programs, IBM WebSphere, Application Server, Start the server. A command window opens and displays the startup progress. After the startup process has completed, the command window will display the message, Server started. Note: You can minimize this command window, but do not close it. This window must remain open while WebSphere is running. 2. Open the WebSphere Administrative Console. 60 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor In Windows, click Start, Programs, IBM WebSphere, Application Server, Administrative console. Enter your WebSphere user name and password, or use the WebSphere default user name, system, and password, manager. After a successful login, the WebSphere Administrative Console page opens. 3. In the Console Navigation pane, locate the Applications section and click Deploy New. The Install New Applications page opens. 4. Click the Browse button next to the Archive text box to locate and select the TM1 Contributor Web application archive file, pmpsvc.war. The typical location of this file is:
C:\Program Files\Cognos\TM1\Cadmin

5. Click Open after selecting the pmpsvc.war file. 6. Keep the other deployment options set to their default values as follows: The Plan field should be blank. The Start app after install check box should be selected. The Redeploy application check box should not be selected.

7. Click Install. WebSphere installs the TM1 Contributor Web application. This process may take a few minutes to complete. When complete, the following messages are displayed: The application was successfully deployed. The application was successfully started. 8. To confirm the installation, click Web App WARs in the Applications section of the Console Navigation pane. The Installed Web Applications page opens. TM1 Contributor is listed with a link in the URL column as /pmpsvc. This link provides the full URL to launch the application. For example:
https://localhost:8443/pmpsvc

9. To open TM1 Contributor, click the /pmpsvc link. 10. To manage the TM1 Contributor Web application, use the WebSphere links for Stop, Restart and Uninstall.

Troubleshooting Deployment with IBM WebSphere

If the TM1 Contributor deployment fails with a Java heap space error message, try adjusting the
JAVA_OPTS parameter in the WebSpheresetenv.bat file.

Steps
1. Open the WebSphere setenv.bat file.

Installation Guide 61

Chapter 5: Installing TM1 Contributor The typical location for this file is:
C:\Program Files\IBM\WebSphere\AppServer\bin

2. Add or edit the following line as follows:

set JAVA_OPTS=-Xmx512M

3. Restart WebSphere. In Windows, click Start, Programs, IBM WebSphere, Application Server and then do the following: To stop WebSphere, click Stop the server. To start WebSphere - click Start the server

Note: You may have to reapply this change if you upgrade or modify your installation of WebSphere at a later date.

Deploying TM1 Contributor with Apache Tomcat

Use the Apache Tomcat Manager to deploy and run TM1 Contributor with Apache Tomcat.

Steps
1. Stop the Apache Tomcat Web server. In Windows, click Start, Programs, Apache Tomcat 6.0, Configure Tomcat. The Apache Tomcat Properties dialog box opens. On the General tab, click Stop. 2. Using a text editor, open the Apache Tomcat tomcat-users.xml file to make sure the encoding is set to utf-8. This file is typically located here:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf

Locate and edit the following line as follows:

<?xml version='1.0' encoding='utf-8'?>

3. Start the Apache Tomcat Web server. In Windows, click Start, Programs, Apache Tomcat 6.0, Configure Tomcat. On the General tab, click Start. 4. Open the Tomcat Manager. In Windows, click Start, Programs, Apache Tomcat 6.0, Tomcat Manager. If prompted, enter a valid user name and password that exists in the tomcat-users.xml file. This file is typically located in:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf

62 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor Note: If you edit the tomcat-users.xml file, you must stop and restart the Tomcat Web server to apply the changes. After a successful login, the Tomcat Web Application Manager page opens. 5. In Tomcat Manager, scroll down to the Deploy section and locate the WAR file to deploy subsection. Note: If an earlier version of the TM1 Contributor Web application has already been deployed, use the Tomcat Manager to undeploy the application. For details, see the steps for undeploying in "Uninstalling and Reinstalling TM1 Contributor" (p. 73). 6. Click Browse and then locate and select the TM1 Contributor Web application archive file, pmpsvc.war. The typical location of this file is:
C:\Program Files\Cognos\TM1\Cadmin

7. Click Open after selecting the pmpsvc.war file. 8. In Tomcat Manager, click Deploy. Tomcat extracts, installs and starts the TM1 Contributor Web application. This process may take a few minutes to complete. Note: During the deployment process, do not stop the Tomcat Web server or try to log in to TM1 Contributor. These actions might disrupt the extraction process and require you to redo these steps from the beginning. When complete, TM1 Contributor is listed as /pmpsvc in the Applications section of Tomcat Manager. After you have deployed the TM1 Contributor Web application with the Tomcat Web server, you can then log in to TM1 Contributor. For details, see "Starting TM1 Contributor" (p. 64).

Configuring TM1 Contributor with Microsoft IIS

TM1 Contributor uses Microsoft Internet Information Services (IIS) to support the TM1 Contributor client, contributor.aspx. You use the TM1 Contributor client to view and edit planning application data in grid format. When you install TM1 Contributor, the required files for the TM1 Contributor client are copied to the TM1 Web installation location. Typically, this location is: C:\Inetpub\wwwroot\TM1Web You must configure the TM1 Web Client URL parameter in TM1 Contributor to point to the contributor.aspx file in this location. For example:
http://WebServer/TM1Web/contributor.aspx

Steps
1. Use the TM1 Contributor Configuration page to set the TM1 Web Client URL parameter: If you are running TM1 Contributor for the first time, use the Configuration page that opens when you start the program.

Installation Guide 63

Chapter 5: Installing TM1 Contributor For more details, see "Running TM1 Contributor for the First Time" (p. 65). If you are already using TM1 Contributor, you can re-open the Configuration page by clicking the Administer IBM Cognos TM1 Contributor button on the toolbar of the TM1 Contributor Portal page.

2. In the TM1 Web Client URL field, enter the URL location of the contributor.aspx file.

Starting TM1 Contributor

Starting TM1 Contributor involves the following steps: 1. Start the TM1 services for the TM1 Admin Server, TM1 Excel service and at least one TM1 server. For details, see "Start Services" (p. 31). 2. "Determining the Startup Link for TM1 Contributor " (p. 64). 3. "Running TM1 Contributor for the First Time" (p. 65). 4. "Logging On to TM1 Contributor" (p. 66).

Determining the Startup Link for TM1 Contributor

The exact link to start and log on to TM1 Contributor depends on which Web server you are running and how it is configured.

IBM WebSphere Application Server

The typical link for TM1 Contributor running on IBM WebSphere Application Server is:
https://WebServer:PortNumber/pmpsvc

For example:
https://localhost:8443/pmpsvc

Apache Tomcat
The typical link for TM1 Contributor with Apache Tomcat is:
http://WebServer:PortNumber/pmpsvc

For example:
http://localhost:8085/pmpsvc

Link Parameters
The WebServer parameter in the link can be one of the following: The keyword localhost if you are currently logged on to the Web server that is running TM1 Contributor. The machine name or domain name of the Web server hosting the TM1 Contributor Web application. The IP address of the Web server hosting the TM1 Contributor Web application.

64 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor The PortNumber depends on the actual port number you configured with IBM WebSphere or Apache Tomcat. IBM WebSphere - Click the Web Server link in the WebSphere Administrative Console to view and edit port settings. Apache Tomcat - Open the Apache Tomcat server.xml file in the following location to view and edit the port settings:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\conf\server.xml.

Running TM1 Contributor for the First Time

A TM1 server must be specified to run TM1 Contributor. The very first time TM1 Contributor is started, the program prompts you for the following configuration information: TM1 Admin Host Server Name TM1 Web Client URL

Configure TM1 Contributor to use a TM1 Server and Web Client

Perform the following steps to configure TM1 Contributor.

Steps
1. Start TM1 Contributor for the first time. The Configuration page opens. 2. Enter the required configuration information into the following fields:

Parameter
TM1 Admin Host

Description
Specifies the computer name or IP address of the Admin Host on which the TM1 Admin Server is running. Note: The TM1 Admin Host and Server Name fields appear blank if you have not started the TM1 Admin Server and at least one TM1 server.

Server Name

Sets the name of the TM1 server to use with TM1 Contributor. For example: planning sample Click the Refresh button to refresh the list of available servers.

Installation Guide 65

Chapter 5: Installing TM1 Contributor

Parameter
TM1 Web Client URL

Description
Specifies the URL location of the contributor.aspx file. TM1 Contributor uses this file, along with Microsoft Internet Information Services (IIS), to display data in grid and chart format. This URL points to the TM1 Web server. For example:
http://WebServer/TM1Web/contributor.aspx

IBM Cognos 8 Gateway URI

These parameters are only displayed if you are using TM1 Contributor with IBM Cognos 8 security.

IBM Cognos 8 Dispatcher For details on configuring these parameters, see "Configuring and Deploying TM1 Contributor to use IBM Cognos URI 8 Security" (p. 71).

3. Click OK to proceed. The configuration information is saved and you will not be prompted again for it. After entering the configuration information, log on with your user name and password. For details, see "Logging On to TM1 Contributor" (p. 66). Note: If you need to edit these settings in the future, click the Administer IBM Cognos TM1 Contributor button on the toolbar of the TM1 Contributor Portal page. For more details, see the IBM Cognos TM1 Contributor Administration Guide.

Logging On to TM1 Contributor

At the TM1 Contributor log on screen, enter your user ID and password for authentication. If TM1 Contributor is using TM1 authentication, enter a valid TM1 user ID and password. The default user name and password for the TM1 Planning Sample database is admin, apple. If TM1 Contributor is using Cognos 8 Security, enter a valid Cognos user ID and password.

After logging on and starting to use TM1 Contributor, the application may require the installation of the IBM Cognos Rich Client Framework. This framework provides the foundation and support files for the TM1 Contributor Administration tool. For details, see the section "Installing the TM1 Contributor Administration Tool" (p. 66).

Installing the TM1 Contributor Administration Tool

If you are a TM1 Contributor administrator or developer and need to design and deploy TM1 Contributor planning applications, you will need to install and use the TM1 Contributor Administration tool.

66 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor Note: The TM1 Contributor Administration tool is accessible only to TM1 Contributor users that belong to the TM1 ADMIN group. Typical, non-administrator users do not have access to this tool and do not need to perform these additional installation steps. The TM1 Contributor Administration tool requires the IBM Cognos Rich Client Framework. The installation for this framework is provided with the .msi installation package files that are included in the TM1 Contributor Web application. As a TM1 Contributor administrator, you can choose to provide the Administration tool and client framework as follows: TM1 Contributor users that have administrator rights can automatically install the TM1 Contributor Administration tool and required framework on their computer the first time they click the Design an Application button on the TM1 Contributor Portal page. For details, see "Install the TM1 Contributor Administration Tool Using a Web Link" (p. 67). A system administrator can install the TM1 Contributor Administration tool and required framework for a single user or group of users, by using a command line. For details, see "Install the TM1 Contributor Administration Tool Using a Command Line " (p. 69).

Install the TM1 Contributor Administration Tool Using a Web Link

TM1 Contributor users with administrator rights can automatically download and install the TM1 Contributor Administration tool on their own computer using the following steps, depending on which Web browser they are using.

Steps for Microsoft Internet Explorer

1. Start and log on to IBM Cognos TM1 Contributor using Microsoft Internet Explorer. The TM1 Contributor Portal page opens. 2. Click the Design an Application button .

The Provisioning - IBM Cognos TM1 Contributor page appears, and you are prompted to install the IBM Cognos Rich Client Framework. 3. Click Install Now. A File Download dialog box appears for the CognosRCP.msi file. 4. Click Run to install the CognosRCP.msi file. 5. If a security dialog box appears, click Run to verify and continue the installation. 6. After the installation has finished, close and then restart your Web browser. 7. Log back on to TM1 Contributor. 8. Click the Design an Application button .

A Progress dialog box appears and automatically downloads and installs the required components for the TM1 Contributor Administration tool.

Installation Guide 67

Chapter 5: Installing TM1 Contributor When this process has finished, the TM1 Contributor Administration window opens. The IBM Cognos Rich Client Framework and the IBM Cognos TM1 Contributor Administration tool are now installed.

Steps for Mozilla Firefox

1. Start and log on to IBM Cognos TM1 Contributor using Mozilla Firefox. The TM1 Contributor Portal page opens. 2. Click the Design an Application button .

The Provisioning - IBM Cognos TM1 Contributor page appears, and you are prompted to install the IBM Cognos Rich Client Framework. 3. Click Install Now. The Opening CognosRCP.msi dialog box appears. 4. Click Save File. The Firefox Downloads dialog box appears. 5. In the Downloads dialog box, click the entry for the CognosRCP.msi file and then click Open. The Open Executable File? dialog box appears. 6. Click OK to run the CognosRCP.msi installation. When the installation is finished, the Open Executable File? dialog box closes. 7. After the installation has finished, close the Firefox Downloads dialog box and then close and restart the Firefox Web browser. 8. Log back on to TM1 Contributor. 9. Click the Design an Application button .

10. If the Opening CogrcpServlet dialog box appears, perform the following steps: Click the Open with option. Confirm that the Open with drop-down list is set to cognosrcp Application Launcher (default) Note: Do not select the Do this automatically for files like this from now on check box. Selecting this option may cause problems when you try to update or reinstall the IBM Cognos Rich Client Framework. Click OK.

11. A Progress dialog box appears and automatically downloads and installs the required components for the TM1 Contributor Administration tool. When this process has finished, the TM1 Contributor Administration window opens. 12. Close the Firefox Downloads dialog box.

68 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor The IBM Cognos Rich Client Framework and the IBM Cognos TM1 Contributor Administration tool are now installed.

Install the TM1 Contributor Administration Tool Using a Command Line

System administrators can install the TM1 Contributor Administration tool using a Windows Installer command line. This also allows the Administration tool and framework to be distributed using Active Directory or other software management tools. Use the command line to install the following MSI files:
CognosRCP.msi - Installs the IBM Cognos Rich Client Framework. ModelingADT.msi - Installs the IBM Cognos TM1 Contributor Administration tool. This

installation does not require any command line parameters.

MSI File Location

The required MSI files are initially contained in the pmpsvc.war file and get extracted when the TM1 Contributor Web application is deployed on the Web server. After deployment on the Web server, the extracted MSI files are located in the rcp_installs subfolder under the TM1 Contributor location on the Web server: Web server program files\TM1 Contributor files\rcp_installs For example, the typical location for the MSI files on Apache Tomcat is:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc\rcp_ installs

Command Line Options

The commands that administrators can use to install CognosRCP.msi are described in the following table.

Command
ALLUSERS=2

Description
Installs the MSI for all TM1 Contributor users. This command ensures that the registry entries for the IBM Cognos Rich Client Framework are located in HKEY_LOCAL_MACHINE. Note: You must use this command with the TARGETDIR command.

TARGETDIR="CognosRCP_ install_location"

Specifies the install location for the MSI. For example,

TARGETDIR="C:\Program Files"

Installation Guide 69

Chapter 5: Installing TM1 Contributor

Command
NOUPDATE=Yes

Description
Prevents TM1 Contributor users from receiving automatic updates for the IBM Cognos Rich Client Framework.

Steps to Install the IBM Cognos Rich Client Framework

1. Open a command prompt, and navigate to the location of the CognosRCP.msi file. By default, the MSI files are located in the following sub-folder on the Web server: Web server program files\TM1 Contributor files\rcp_installs 2. Install CognosRCP.msi by doing one of the following: To install the MSI for a single user, type the following command
CognosRCP.msi TARGETDIR="install_location"

Note: To prevent automatic updates for TM1 Contributor users add NOUPDATE=Yes before you execute the command. To install the MSI for all users, type the following command
CognosRCP.msi TARGETDIR="install_location" ALLUSERS=2

Note: To prevent automatic updates for TM1 Contributor users add NOUPDATE=Yes before you execute the command. After you install the CognosRCP.msi, IBM Cognos Rich Client Framework appears on the Windows Add or Remove Programs list. In addition, a folder called CognosRCP is created in the installation location that you specified in the TARGETDIR command.

Steps to Install IBM Cognos TM1 Contributor Administration Tool

1. Open a command prompt, and navigate to the location of the ModelingADT.msi file. By default, the MSI files are located in the following sub-folder on the Web server: Web server program files\TM1 Contributor files\rcp_installs 2. 2. Type the following command:
ModelingADT.msi

When the installation completes, it may require a system restart. After the installation is successfully installed, IBM Cognos TM1 Contributor Administration tool appears on the Windows Add or Remove Programs list.

Uninstalling the TM1 Contributor Administration Tool

The steps to uninstall the TM1 Contributor Administration tool depend on how the tool was installed.

Steps
1. Determine how the TM1 Contributor Administration tool was installed: 70 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor If a user installed the TM1 Contributor Administration tool by clicking the Design an Application button on the TM1 Contributor Portal page, then onlyIBM Cognos Rich Client Framework appears on the Add or Remove Programs list. If a system administrator used the command line to install the TM1 Contributor Administration tool, then both IBM Cognos Rich Client Framework and IBM Cognos TM1 Contributor Administration appear on the Add or Remove Programs list. In this case, you must first remove IBM Cognos TM1 Contributor Administration and then remove the IBM Cognos Rich Client Framework. 2. Use Add or Remove Programs in the Windows Control Panel to uninstall the IBM Cognos Rich Client Framework and/or the IBM Cognos TM1 Contributor Administration tool.

Configuring and Deploying TM1 Contributor to use IBM Cognos 8 Security

You can configure TM1 Contributor to use IBM Cognos 8 security. Optionally, you can also deploy TM1 Contributor with the Apache Tomcat Web server that is supplied with IBM Cognos 8.

Steps to Configure TM1 Contributor to use IBM Cognos 8 Security

1. Configure TM1 to use IBM Cognos 8 security. For details, see the section about using IBM Cognos 8 security with TM1 in this guide. 2. Shut down the TM1 server. 3. Open the Tm1s.cfg configuration file in a text editor. 4. Set the IntegratedSecurityMode parameter to 5 as follows:
IntegratedSecurityMode=5

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

Steps to Deploy TM1 Contributor on the IBM Cognos 8 Web Server

1. If you want to use TM1 Contributor with the Apache Tomcat Web server that was supplied with IBM Cognos 8, deploy the following TM1 Contributor files to the IBM Cognos 8 Web server.

Copy from TM1 Install Dir

\Cadmin\pmpsvc.war \Cadmin\gateway\planning.html \Cadmin\gateway\variables_plan.html

To C8 Install Dir
\webapps \webcontent \templates\ps\portal

Installation Guide 71

Chapter 5: Installing TM1 Contributor

Copy from TM1 Install Dir

\Cadmin\gateway\icon_active_ application.gif

To C8 Install Dir
\webcontent\ps\portal\images

2. Restart the IBM Cognos 8 server. 3. Open TM1 Contributor using the format of the following link:
http://Cognos8_ServerName:9300/pmpsvc

4. Log in and open the TM1 Contributor Configuration page: If you are running TM1 Contributor for the first time, the Configuration page opens after you log in. If you have already configured TM1 Contributor, you can re-open the Configuration page by clicking the Administer IBM Cognos TM1 Contributor button on the toolbar of the TM1 Contributor Portal page.

5. On the TM1 Contributor Configuration page, enter values for the following TM1 and Cognos 8 parameters: Enter values in the TM1 Admin Host, Server Name and TM1 Web Client URL fields. For details, see "Configure TM1 Contributor to use a TM1 Server and Web Client" (p. 65). Set the IBM Cognos 8 Gateway URI parameter to:
http://Cognos8_ServerName/cognos8/cgi-bin/cognos.cgi

Set the IBM Cognos 8 Dispatcher URI parameter to:

http://Cognos8_ServerName:9300/p2pd/servlet/dispatch

Replace Cognos8_ServerName with the name of the system where the IBM Cognos 8 Web server is running. TM1 Contributor is now configured to use both IBM Cognos 8 security and the instance of Apache Tomcat Web server that is supplied with IBM Cognos 8.

Configuring TM1 Contributor to use Multiple TM1 Servers

When you start TM1 Contributor for the first time, you can enter only one TM1 server with which you want to work. To enter additional servers, use the IBM Cognos TM1 Contributor Configuration page available from the TM1 Contributor Portal page. Important: In order to use multiple TM1 servers in TM1 Contributor, they must all use the same security authentication (either TM1 standard authentication or IBM Cognos 8 security) and include the same administrator user name and password. For details, see "Configuring Security Authentication for TM1 Contributor" (p. 59). After adding multiple TM1 servers, they are available when you use the TM1 Contributor Administration tool to design your planning applications.

72 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor For more details, see the IBM Cognos TM1 Contributor Administration Guide.

Steps
1. Log in to TM1 Contributor. 2. On the toolbar of the TM1 Contributor Portal page, click the Administer IBM Cognos TM1 Contributor button . The IBM Cognos TM1 Contributor Configuration page opens 3. In the Server Names section, click Add. The Add Server dialog box opens. 4. Enter values for the following: Admin Host - Specifies the computer name or IP address of the Admin Host on which the TM1 Admin Server is running. Server Name - Sets the name of the TM1 server to use with TM1 Contributor. For example: planning sample. Click the Refresh button to update the Server Name list with the available servers for the Admin Host you entered. 5. After entering the server information, click OK. The Admin Host and TM1 server name you entered are added to the Server Names section. 6. To add more servers, click Add and repeat the steps. 7. When you are finished adding TM1 servers, click OK on the IBM Cognos TM1 Contributor Configuration page. The TM1 servers you added can now be used to design your planning applications.

Font for TM1 Contributor Export to PDF

The font to use for the PDF export in TM1 Contributor can be specified using the SyncfusionPDFExportFont web.config parameter. If this parameter is not specified, the system detects the locale the user is in and select an appropriate font. If the locale is not Chinese or Japanese, Arial is used. Use this setting to override the language used when exporting in TM1 Contributor.

Uninstalling and Reinstalling TM1 Contributor

Important: Before uninstalling TM1 Contributor, follow the steps in this section to backup any planning applications you have created. The overall steps to uninstall and reinstall TM1 Contributor include the following: Stop related services. Backup your TM1 Contributor application files.

Installation Guide 73

Chapter 5: Installing TM1 Contributor Uninstall TM1 and the IBM Cognos Rich Client Framework. Undeploy the TM1 Contributor Web application. Reinstall and redeploy TM1 Contributor. Restore your TM1 Contributor application files. Start related services.

Steps to stop related services

1. Use Windows Services to stop all TM1 services. This includes the TM1 Admin Server, TM1 Excel service and any TM1 servers. 2. If you are using IBM Cognos 8 security with TM1 Contributor, stop the IBM Cognos 8 service.

Steps to backup your TM1 Contributor applications

Save a backup copy of the TM1 Contributor applications folder and the pmpsvc_config.xml file. The typical locations for these items are:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc\ WEB-INF\applications

C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc\ WEB-INF\configuration\pmpsvc_config.xml

If you are using IBM Cognos 8 security with TM1 Contributor, these items are located in the following location:
C:\Program Files\cognos\c8\webapps\pmpsvc

Steps to uninstall TM1 and IBM Cognos Rich Client Framework

1. Use the Add or Remove Programs feature in the Windows Control Panel to remove IBM Cognos TM1. For details, see "Uninstalling IBM Cognos TM1" (p. 132). 2. Use the Add or Remove Programs feature to uninstall the IBM Cognos Rich Client Framework and the IBM Cognos TM1 Contributor Administration tool if they appear in the list. For details, see "Uninstalling the TM1 Contributor Administration Tool" (p. 70).

Steps to undeploy TM1 Contributor in Apache Tomcat

1. Open the Tomcat Manager. 2. Click Undeploy for the /pmpsvc entry in the Applications list. 3. Click OK to confirm. The application is undeployed and removed from the Tomcat Manager Applications list. Note: If the /pmpsvc entry is still shown in the Applications list after undeploying, stop and restart Tomcat and then click Undeploy for a second time.

74 IBM Cognos TM1

Chapter 5: Installing TM1 Contributor 4. Verify that the following TM1 Contributor Web application folders and files have been deleted. Stop Tomcat and delete these files if they still exist. Folders:
C:\Program Files\Apache Software Foundation\webapps\pmpsvc C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc C:\Program Files\Apache Software Foundation\Tomcat 6.0\work\Catalina\ localhost\pmpsvc

Files:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc. war

If you are using IBM Cognos 8 security with TM1 Contributor, these items are located in the following locations:
C:\Program Files\cognos\c8\webapps\pmpsvc C:\Program Files\cognos\c8\tomcat4.1.27\work\Standalone\localhost\pmpsvc

Steps to undeploy TM1 Contributor in IBM WebSphere

1. Open the WebSphere Administrative Console. 2. In the Console Navigation pane, locate the Applications section and click Web App WARs. The Installed Web Applications page opens. 3. Locate the entry for /pmpsvc in the URL column and click Uninstall. 4. Click OK to confirm the uninstall. WebSphere displays the following message when complete: Uninstalled application default/pmpsvc

Steps to reinstall and redeploy TM1 Contributor

Reinstall and redeploy TM1 Contributor as described in the following sections: "Installing TM1 Contributor" (p. 49). "Deploying TM1 Contributor on a Web Application Server" (p. 60).

Steps to restore your TM1 Contributor applications

Restore the backup copies of your TM1 Contributor applications folder and
pmpsvc_config.xml file.

The typical locations for these items are:

C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc\ WEB-INF\applications

Installation Guide 75

Chapter 5: Installing TM1 Contributor

C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\pmpsvc\ WEB-INF\configuration\pmpsvc_config.xml

If you are using IBM Cognos 8 security with TM1 Contributor, these items are located in the following location:
C:\Program Files\cognos\c8\webapps\pmpsvc

Steps to start related services

Start all of the related services. TM1 services (TM1 Admin Server, TM1 Excel service and any TM1 servers) IBM WebSphere or Apache Tomcat Web server. IBM Cognos 8 service (If you are using IBM Cognos 8 security with TM1 Contributor)

76 IBM Cognos TM1

Chapter 6: Installing TM1 for 64-bit Windows

This section describes how to install IBM Cognos TM1 for 64-bit Microsoft Windows using either the Standard or Custom installation options.

Steps
1. Run the TM1 Installation Wizard, answer the introductory prompts, and advance to the Choose a Product to Install screen. For details, see "Starting the Installation Wizard" (p. 19). 2. Select the TM1 product that you want to install. TM1 TM1 Web TM1 Contributor

3. Choose the installation type. "Custom 64-bit TM1 Installation" (p. 78). "Standard 64-bit Installation" (p. 81).

4. Advance through the Installation Wizard screens to complete the installation.

TM1 Components Not Included in the 64-bit TM1 Installation

The following TM1 components are not part of the 64-bit TM1 installation and are available only with the TM1 x86 installation:

Component
Developer's Environment

Description
TM1 Architect TM1 Java API TM1 .NET API

Clients

TM1 Perspectives

To install any of these TM1 x86 (32-bit) components on a 64-bit Windows system, you must use the TM1 x86 Installation Wizard. For details, see "Installing TM1 x86 on an x64 Windows System" (p. 83). For a list of TM1 components that are included in the 64-bit TM1 installation, see "Custom 64bit TM1 Installation" (p. 78). Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

77

Chapter 6: Installing TM1 for 64-bit Windows

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

Installed by default
Yes

Description

Clients

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 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.

Developer's Environment

Yes

TM1 API Application programming interface that developers use to create C++ and VB 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.

78 IBM Cognos TM1

Chapter 6: Installing TM1 for 64-bit Windows

Component

Installed by default
Yes

Description

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.

Yes

TM1 Top A TM1 utility that enables you to dynamically monitor threads running in an instance of a Microsoft 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.

TM1 Contributor

Yes

TM1 Contributor enables you to design, deploy and run managed planning applications based on TM1 data. This option installs the required files for deploying and running TM1 Contributor. This component is selected for installation by default only as part of the TM1 Contributor installation.

Configuring TCP/IP Ports for 64-bit TM1

Specify TCP/IP port numbers for the following: TM1 Admin Host port number TM1 Admin server SSL port number TM1 Client Message port number Installation Guide 79

Chapter 6: Installing TM1 for 64-bit Windows For more information, see "Configuring TCP/IP Ports for TM1" (p. 25).

Username and Password

On Microsoft Windows, all TM1 services must run under a single domain account. The TM1 Installation Wizard will configure the services to run under the account for the username and password that you enter. For more information, see "Username and Password for TM1 Services" (p. 26).

Security Settings
You can select one of the following three authentication modes for TM1: Integrated Login TM1 Authentication LDAP Authentication

For more information about authentication modes for TM1, see "Security Settings" (p. 27). Once you've installed you cannot change your TM1 authentication mode by re-running the Installation Wizard. For more information, see "Changing Security Parameters" (p. 29). See also the IBM Cognos TM1 Operations Guide.

Configuring the 64-bit TM1 Server

When you install a TM1 server you must specify values for the following server parameters. TM1 sample database Server Name Admin Server Host Machine Name Port Number Data Directory

These values are written to the Tm1p.ini file, which resides in the TM1 data directory. For more information about these parameters, see "Configuring the TM1 Server" (p. 29).

Sample Databases
TM1 sample databases are installed to the TM1 data directory. For example, the default path for the TM1 data directory and Planning Sample database on a 64-bit Windows system is:
C:\Program Files\Cognos\TM1\Custom\TM1Data\PlanSamp.

Running Multiple TM1 Servers

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.

80 IBM Cognos TM1

Chapter 6: Installing TM1 for 64-bit Windows

Standard 64-bit Installation

A Standard 64-bit TM1 installation installs the following components and parameter values.

TM1 Components
A Standard 64-bit installation installs the following components. For a description of each component, see "Custom 64-bit TM1 Installation" (p. 78).

Component

Installed by default
Yes

Description

Clients

TM1 Web Components This component is installed by default only as part of the TM1 Web installation.

Yes Developer's Environment Servers Yes Yes Yes TM1 Contributor Yes Yes

TM1 OLEDB Provider TM1 API

TM1 Admin Server TM1 Server TM1 Top TM1 Contributor This component is installed by default only as part of the TM1 Contributor installation.

Default Parameter Values

A Standard 64-bit TM1 installation uses the following default values:

Item
Admin Server port number SSL port number TM1 server port number

Default Value
5495 (unsecured) 5498 (secured) 12345

TM1 Client Message port number 12356 TM1 server name SData

Installation Guide 81

Chapter 6: Installing TM1 for 64-bit Windows

Item
Admin Server host name Sample data directory for TM1 server Security mode

Default Value
Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\TM1Data\PlanSamp

A Standard installation uses TM1 Authentication.

82 IBM Cognos TM1

Chapter 7: Installing TM1 x86 on an x64 Windows System

This section describes how to install the x86 version of IBM Cognos TM1 on a single, 64-bit Microsoft Windows system, such as Windows Server 2003 x64 or Windows XP Professional x64. This type of installation is primarily intended for installing the TM1 clients on an x64 system. The TM1 x86 installation does not create Windows services for the x86 TM1 server or x86 Admin Server on an x64 system. Note: Microsoft 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.

Steps
1. Run the TM1 Installation Wizard and answer the introductory prompts. For details, see "Starting the Installation Wizard" (p. 19). 2. Choose Standard or Custom installation type. No special steps are required to install the x86, 32-bit version of TM1 in a Microsoft 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.

WOW64 (32-bit) Application Space

When you can install TM1 x86 (32-bit) components on an X64 machine, they are automatically installed into the Microsoft WOW64 space.

Installation Notes about x86 and x64 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
Install and run only the x64 version. If needed, you can install both the x86 and x64 versions of the TM1 Admin Server, but only one of them can be active.

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

83

Chapter 7: Installing TM1 x86 on an x64 Windows System

Component
TM1 Server

Considerations
Install and run only the x64 version. If needed, 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 TM1 Databases with Both x86 and x64 TM1 Servers" (p. 85).

TM1 Top utility

The TM1 Top utility is available as a 64-bit application and can be installed using the TM1 x64 installation. There are currently no 64-bit TM1 client applications available. Use the TM1 x86 installation to install the TM1 clients on an x64 system.

TM1 Clients

TM1 .NET API

The TM1 .NET API ia a 32-bit application and can be installed only into the WOW64 space using the TM1 x86 installation.

Location of Installed TM1 Program Files on an x64 System

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 TM1 x86 default directory: C:\Program Files(x86)\Cognos\TM1

Running TM1 x86 Server and Admin Server on Windows x64

When you install the x86 version of TM1 in a Windows x64 environment, the necessary executable files for the x86 TM1 server and x86 Admin Server are installed in the <TM1_install_dir>\bin directory, but the corresponding Windows services are not created by the installation program. This avoids possible conflicts if the x64 TM1 server and/or x64 Admin Server are installed on the same system. Typically, you would run only the x64 version of the TM1 server and Admin Server on an x64 system. If necessary, you can run the x86 server or Admin Server on an x64 system as follows: Manually start the x86 server or Admin Server as an application.

84 IBM Cognos TM1

Chapter 7: Installing TM1 x86 on an x64 Windows System Use command line options to configure these components as Windows services.

For details, see the sections about running the TM1 Admin Server and TM1 server as an application or Windows service in the IBM Cognos TM1 Operations Guide.

Running TM1 Databases 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. To run multiple TM1 servers on a single computer, each server must use a unique port number. For example, if you want to run the Planning Sample database with both the x86 and x64 versions of TM1 server, you have to edit the PortNumber parameter in one of the Tm1s.cfg files to use 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, the default locations for the Planning Sample database are: 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 Microsoft 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.
PortNumber=12345

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.

Installation Guide 85

Chapter 7: Installing TM1 x86 on an x64 Windows System

86 IBM Cognos TM1

Chapter 8: Installing TM1 on UNIX

This section describes how to install IBM Cognos TM1 on UNIX and Linux operating systems. For a complete list of supported operating systems and platforms, click the IBM Cognos TM1 software environments link available on the IBM Cognos TM1 Information Center website at http://publib.boulder.ibm.com/infocenter/ctm1/v9r5m0/index.jsp.

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 one of the following directories depending on which platform you are using:
/etc/rc2.d directory (Solaris) /etc/rc.d/rc2.d directory (AIX) /etc/rc2.d directory (Linux).

If you are running TM1 on the IBM AIX operating system, check the AIX memory resource limits that are available to TM1. For details, see the following topics: "Running TM1 on IBM AIX" (p. 95). "Setting IBM AIX Memory Resource Limits for TM1" (p. 95).

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. The GUI-based TM1 Installer to install TM1 on UNIX (Solaris and AIX) and Linux needs a minimal screen resolution of 1024x768.

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

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

87

Chapter 8: Installing TM1 on UNIX

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. 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 IBM Cognos TM1 Information Center 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 on UNIX" (p. 94).

TM1 Components Supported on UNIX

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. 18).

Supported on UNIX and Win- Supported only on Windows dows

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

88 IBM Cognos TM1

Chapter 8: Installing TM1 on UNIX

Starting the Installation Wizard

Before you start the Installation Wizard, be sure to read "Pre-Installation Tasks" (p. 87), which lists account requirements that you must fulfill to successfully install this software. 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 IBM AIX Red Hat Enterprise Linux HP/UX

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

./install_linux.bin

Not supported in TM1 9.4 MR1 and later

The IBM Cognos TM1 Installation Wizard starts.

Selecting 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.

Selecting TM1 Components for UNIX

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

Installation Guide 89

Chapter 8: Installing TM1 on UNIX

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.

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.

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.

90 IBM Cognos TM1

Chapter 8: Installing TM1 on UNIX

TCP/IP Port

Default Value
5498

Description

Admin Server SSL Port

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

TM1 Server Configuration

Enter the following information to configure your TM1 server.

Item
Server Name Server Port Number

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.

TM1 Admin Host

Do you want to install the sample Select this option if you want to install the TM1 sample data, 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 server's 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:

Installation Guide 91

Chapter 8: Installing TM1 on UNIX 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:

Task

For more information see

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

TM1 Object Names and Character Encoding for TM1 Servers on UNIX and Windows Systems
The following recommendations are related to ensuring correct and consistent character encoding in your TM1 object names for objects such as cubes, views, dimensions and subsets.

Moving TM1 Databases Between Windows and UNIX Systems When Your TM1 Object Names Contain Non-ASCII Characters
Do not move and use TM1 database files from a Microsoft Windows system to a UNIX system (or from UNIX to Windows) when your TM1 object names contain non-ASCII characters (characters beyond the original 128 ASCII character set). This scenario is an issue because of the possible incompatible character encoding or mapping between these two platforms. The Windows operating system stores directory and file names in UTF-16 character encoding, while the UNIX operating system can store names using different character encodings, depending on which locale is currently being used. For example, TM1 object names for cubes and dimensions that include non-ASCII characters would not display correctly in TM1 client applications if the TM1 database files were copied from one platform and run on another where different character encoding is used.

92 IBM Cognos TM1

Chapter 8: Installing TM1 on UNIX

Starting a TM1 Server in the Same Locale on a UNIX System When TM1 Object Names Contain Non-ASCII Characters
If your TM1 object names (for cubes, views, dimensions, subsets, etc.) include non-ASCII characters, use the same locale when starting up a TM1 server on a UNIX system. This ensures that TM1 object names and the related TM1 directory and file names on the UNIX system always use the same character encoding. Starting the TM1 server under a different locale than previously used could cause TM1 object names to display incorrectly if the names were originally created and stored in a different locale. For example, TM1 object names for cubes and dimensions that are saved when the server is running under the en_US locale might not display correctly if the server is re-started using the ja_JP locale.

Uninstalling TM1 on UNIX

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 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 TM1 Installation on UNIX

To run a silent TM1 installation on UNIX, type the following line at a command prompt: <path_to_directory_containing_install.bin_executable>./install_<OS>.bin -silent

Installation Guide 93

Chapter 8: Installing TM1 on UNIX 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 Path to TM1 Database Administrative username Administrative password

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)

Console Installation on UNIX

To run a console-type TM1 server installation on UNIX, 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.

94 IBM Cognos TM1

Chapter 8: Installing TM1 on UNIX

Starting a TM1 Server on UNIX

When you install a TM1 server on UNIX, 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 TM1 server.

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

Running the TM1 Server on UNIX 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.

Running TM1 on IBM AIX

This section contains technical considerations about running TM1 on the IBM AIX operating system.

Setting IBM AIX Memory Resource Limits for TM1

If you are running TM1 on IBM AIX, you should check the AIX memory resource limits to see how much memory is available for TM1. TM1 is configured to make use of the maximum amount of memory available to the IBM AIX operating system as allowed by the AIX hard limit memory resource setting. To check the current hard limit on AIX, use the AIX ulimit command as follows:
ulimit -d -H

If you have root user authority, you can use this command to change the hard limit. For more information about using the ulimit command, see the AIX documentation.

Using IBM AIX Commands that Do Not Support File Names for TM1 Control Objects
Some commands in the IBM AIX operating system, such as sysck, do not work with TM1 control object file names because these file names start with the } character. For example, TM1 control objects typically have file names like }Clients.dim, }Groups.dim or }ClientsGroups.cub. This issue applies for all standard IBM AIX commands that read file names from stdin, including AIX commands and tools that backup data. These AIX commands fail and produce an error when the command is used with these TM1 files.

Installation Guide 95

Chapter 8: Installing TM1 on UNIX

96 IBM Cognos TM1

Chapter 9: Installing TM1 Workflow

TM1 Workflow allows you to create and manage a workflow structure for your planning and budgeting activities. This section describes how to install Workflow on your TM1 server, and how to set up your TM1 users to access the TM1 Workflow clients.

Workflow Prerequisites
Before you install TM1 Workflow, you must have the following software installed and configured: IBM Cognos TM1 Server 9.4 or later. TM1 Client or TM1 Perspectives. If you want to run TM1 Workflow through TM1 Web, you must have TM1 Web installed. Each TM1 Workflow user must be running Excel 2003 or later If you are installing TM1 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 TM1 Workflow.You should back up the existing database and store the copy in a safe place before running the TM1 Workflow installation.

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

Workflow Installation Notes

This section provides details you should be aware of when installing TM1 Workflow in any of the following scenarios: Installing with other TM1 components such as TM1 Web Installing on x64 systems Installing on systems running anti-virus applications

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

97

Chapter 9: Installing TM1 Workflow

TM1 Workflow Requires Manual Uninstall and Re-install when Upgrading TM1 Web
Upgrading to TM1 Web can cause the existing web files for TM1 Workflow to be overwritten. If you are using TM1 Workflow and upgrading TM1 Web, you will need to manually uninstall and then re-install Workflow as described in the following steps, depending on your platform.

Back Up Existing Data

You should back up any existing TM1 databases before performing this procedure. Save a copy of your existing TM1_Install\Custom data directory and sub-directories to a secure location.

Steps for x86

1. Uninstall the TM1 Workflow, x86 version using the Add or Remove Programs feature available in the Microsoft Windows Control Panel. 2. Install the TM1 9.5.1, x86 version. 3. Re-install the TM1 Workflow, x86 version.

Steps for x64

1. Uninstall the TM1 Workflow, x64 version using the Add or Remove Programs feature available in the Microsoft Windows Control Panel. 2. Install the TM1 9.5.1, x64 version. 3. Install TM1 x86 version, Perspectives only. 4. Re-install the TM1 Workflow, x64 version. Make sure you install the Workflow Web server component to your TM1 Web installation directory, usually C:\Inetpub\wwwroot\TM1Web. 5. On the Custom Setup screen of the TM1 Workflow installation wizard, expand the Server Components group. 6. Select WebServer Component. 7. Click the Change button and set the path to your TM1 Web installation directory. 8. Complete the Workflow installation wizard.

TM1 Workflow x64 installation procedure

You must adhere to the following installation order when installing the x64 version of TM1 Workflow.

Installing Web components only

If you want to implement only the web components of TM1 Workflow, install the x64 version of TM1 first, followed by the x64 version of TM1 Workflow.

98 IBM Cognos TM1

Chapter 9: Installing TM1 Workflow

Installing both Web and Excel components

If you want to perform a complete TM1 Workflow installation on x64, including both web components and the Microsoft Excel add-in, install the following items in order.

Steps
1. TM1 x64 version, full install 2. TM1 x86 version, Perspectives only 3. TM1 Workflow, x64 version

Sophos Anti-virus may Prevent TM1 Workflow from Loading Properly

The Sophos Ant-Virus package may prevent TM1 Workflow from loading properly. To work around this problem, add the TM1_install\bin folder to the list of on-demand exclusions in Sophos.

Running the TM1 Workflow Installation Wizard

You can use the TM1 Workflow Installation Wizard to: Install TM1 Workflow for the first time Upgrade Planning Manager 1.3 to TM1 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 support website.

Steps
1. Run the TM1 Workflow setup.exe file on the TM1 Workflow installation CD or from the TM1 Workflow installation package that you downloaded. The TM1 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 TM1 Workflow components that you want to install, depending on your specific installation scenario. For more information, see these sections: "Selecting TM1 Workflow Installation Components" (p. 100) "Installing TM1 Workflow for the First Time" (p. 101) "Upgrading to TM1 Workflow from Planning Manager 1.3" (p. 102) 4. Click Next.

Installation Guide 99

Chapter 9: Installing TM1 Workflow 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 TM1 Workflow appear in the Add-Ins dialog box that appears when you select Tools, Add-Ins in Excel. Automatically load the TM1 Workflow Addin when Microsoft Excel starts - This option starts and displays the TM1 Workflow toolbar when you start Excel.

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

Selecting TM1 Workflow Installation Components

Use the Custom Setup screen to select the TM1 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.

TM1 Workflow Components

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

Component

Description

Web Server Component Enables the TM1 Workflow toolbar and functionality in TM1 Web. 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 TM1 Workflow yet. Default installation location is: C:\Program Files\Cognos\TM1\Custom\TM1Data\TM1 Planning Manager V2\

100 IBM Cognos TM1

Chapter 9: Installing TM1 Workflow

Component
Planning Manager Upgrade

Description
Includes the TM1 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 TM1 Workflow toolbar and functionality in Excel. Default installation location is: C:\Program Files\Cognos\TM1\bin\

Destination Folder for TM1 Workflow Components

Each TM1 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 TM1 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 TM1 Workflow component.

Installing TM1 Workflow for the First Time

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

Steps
1. Run the TM1 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

Installation Guide 101

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

Installing TM1 Workflow for One Existing TM1 Database

To install TM1 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 TM1 Workflow. Warning: Make sure the existing database has not been used with TM1 Workflow or you will overwrite previous TM1 Workflow files.

Installing TM1 Workflow for Multiple TM1 Databases

To apply TM1 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 copy the database component files into the other TM1 data directories that you want to use with TM1 Workflow.

Steps
1. On the Custom Setup screen, click Next and complete the installation. 2. Restart any of the TM1 servers where you installed TM1 Workflow to allow the TM1 Workflow options to be loaded.

Upgrading to TM1 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 TM1 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 TM1 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.

102 IBM Cognos TM1

Chapter 9: Installing TM1 Workflow

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 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 TM1 Workflow for Microsoft Excel

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

TM1 Workflow Excel Addin options

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

Installation Guide 103

Chapter 9: Installing TM1 Workflow

Workflow toolbar

Troubleshooting the TM1 Workflow Excel Add-in

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

Steps
1. Unload the TM1 Workflow add-in by choosing Tools, Add-ins from the Excel menu and unselecting the TM1 Workflow 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 TM1 Workflow add-in by clicking Browse and manually selecting the TM1 Workflow add-in, TM1 Planning Manager.xla, located in the <TM1 install directory>\bin directory.

Using TM1 Workflow in Excel 2007

If you are running TM1 Workflow with Excel 2007, IBM Cognos TM1 Perspectives (Tm1p.xla) must not be configured to autoload as an Excel add-in. If IBM Cognos TM1 Perspectives is autoloaded in Excel, TM1 Workflow always loads the English version of the TM1 Workflow toolbar, even when TM1 Workflow is configured for a different language. To configure Excel 2007 to run TM1 Workflow: 1. Open the Excel Add-Ins dialog box. 2. Clear the check box next to IBM Cognos TM1 Perspectives. 3. Fill the check box next to TM1 Workflow. 4. Click OK. 5. Restart Excel.

104 IBM Cognos TM1

Chapter 9: Installing TM1 Workflow

Using TM1 Workflow with TM1 Web

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

TM1 Workflow On The Web

TM1 Workflow in TM1 Web is enabled by editing several parameters in the Web.config file that governs your TM1 Web installation. The TM1 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 TM1 Workflow toolbar appears the next time you log in to TM1 Web.

TM1 Workflow Features in TM1 Web

Many of the user features of TM1 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 Administrator's Guide. Note: The TM1 Workflow administration console is not supported through TM1 Web. Administration functions for TM1 Workflow, such as setting up mapping and security for TM1 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 configuration parameters into the localized language and save the configuration file as a UTF-8 file. Depending on the language, you may also need to adjust the widths of captions in those configuration parameters. See "Configuring TM1 Workflow Parameters" in the IBM Cognos TM1 Operations Guide for more information on these parameters.

Installation Guide 105

Chapter 9: Installing TM1 Workflow

106 IBM Cognos TM1

Chapter 10: Silent Windows Installation for IBM Cognos TM1 Clients
You can use command line options to perform a silent installation of IBM Cognos TM1 client applications, such as TM1 Perspectives and TM1 Architect, on Microsoft Windows-based systems. A silent installation does not display installation dialog boxes or require user interaction. This type of installation enables administrators to perform unattended installations of IBM Cognos TM1 client applications on multiple remote computers over a network. A number of general and TM1-specific command line options are available that control the installation. You can use these options to create an install script that runs from a command prompt, in a batch file (.bat) or with a third-party installation management program. These options work in combination with the IBM Cognos TM1 installation file (setup.exe) and the Microsoft Windows Installer program (msiexec.exe). For detailed information about Microsoft Windows Installer command line options, see the Microsoft web site.

Installing
Use the following format to install IBM Cognos TM1 with command line options.
setup.exe /S /L<language ID> /V"<TM1 options> /Q<user interface option>"

Setup.exe Command Line Options

The following table lists the typical command line options for performing a silent installation with the IBM Cognos TM1 setup.exe file.

Command Line Option

/S

Description
Runs the installation in silent mode.

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

107

Chapter 10: Silent Windows Installation for IBM Cognos TM1 Clients

Command Line Option

/L

Description
Sets the language for the installation using a language ID. For example: /L1033 Languages for IBM Cognos TM1 9.0, 9.1 and later: English - 1033 German - 1031 French (France) - 1036

Additional languages for IBM Cognos TM1 9.4 and later: Chinese (Simplified) - 2052 Japanese - 1041

Additional languages for IBM Cognos TM1 9.4 MR1 and later:
/V

Italian - 1040 Spanish - 1034

Passes arguments to the Microsoft Windows Installer program (msiexe.exe). The entire argument string must be enclosed in quotation marks and must not include a space after the /V option. For example:
/V"INSTALLLEVEL=0 /QN"

If a parameter value includes spaces, then it must be enclosed in quotation marks. For example:
/V"INSTALLLEVEL=0 INSTALLDIR=\"c:\program files\Cognos\" /QN" /Q<user interface option>

Sets the amount of interaction and confirmation dialog boxes that the installation will use.
/QR - Displays a reduced user interface during the installation. /QN - Displays no user interface during the installation.

TM1 Installation Command Line Options

The following table lists the command line options that are specific to IBM Cognos TM1. Note: Use quotation marks around any parameters that include spaces.

108 IBM Cognos TM1

Chapter 10: Silent Windows Installation for IBM Cognos TM1 Clients

Option
INSTALLLEVEL

Description
Sets the installation level. Use 0 for a new install.
INSTALLLEVEL=0

INSTALLDIR

Installation location for IBM Cognos TM1. The default is:

"C:\Program Files\Cognos\"

This option is only necessary when you want to change the installation location to something other than the default location. For example:
INSTALLDIR=\"c:\cognos\tm1\ ADDLOCAL

Sets the product features that you want to install. The available options include:
Perspectives- Installs the IBM Cognos TM1 Perspectives

client application.
Architect- Installs the IBM Cognos TM1 Architect client

application.
PDFCamp - Installs files for exporting to Adobe PDF files

from IBM Cognos TM1. This option applies to IBM Cognos TM1 series 9.1.x and 9.4.x. For PDF support with the 9.0.x series, use the INSTALLGHOSTSCRIPT and ADOBEPRINTER options.
DocLibrary - Installs the IBM Cognos TM1 Help files. Registry - Creates the Windows registry keys for the

TM1 clients you choose to install. While not required in all circumstances, the registry keys must be present when running TM1 clients in an integrated system that includes Cognos BI. You can include any of the options you want to install. For example:
ADDLOCAL=Perspectives,Architect,PDFCamp,DocLibrary, Registry PRODUCTCHOOSEN

Use this to specifically set the installation to install IBM Cognos TM1 Perspectives. This option is equivalent to the Product option in the user interface of the TM1 Installation Wizard. For example:
PRODUCTCHOOSEN=TM1P

EXCELEDITINCELL

Enables/disables the edit-in-cell option for Microsoft Excel.

EXCELEDITINCELL=True

Installation Guide 109

Chapter 10: Silent Windows Installation for IBM Cognos TM1 Clients

Option
TM1AUTOLOAD

Description
Enables/disables IBM Cognos TM1 Perspectives as an add-in for Microsoft Excel.
TM1AUTOLOAD=True

TM1LANGSTRING

Sets the language for IBM Cognos TM1 using a three-letter language code. For example:
TM1LANGSTRING=ENG

Languages for IBM Cognos TM1 9.0, 9.1 and later: English - ENG German - DEU French (France) - FRA

Additional languages for IBM Cognos TM1 9.4 and later: Chinese (Simplified) - SCH Japanese - JPN

Additional languages for IBM Cognos TM1 9.4 MR1 and later:
CLIENTLOGIN

Italian - ITA Spanish - ESP

Indicates if integrated login will be used. If you do not want to use integrated login, set this option to F.
CLIENTLOGIN=F

If you want to use integrated login, set this option to T.

CLIENTLOGIN=T TM1CLIENTADMHOST

System name of the IBM Cognos TM1 Admin server host.

TM1CLIENTADMHOST=boston

INSTALLGHOSTSCRIPT

Required setting for printing to Adobe PDF files (.pdf).

INSTALLGHOSTSCRIPT=True

Note: This option applies to IBM Cognos TM1 series 9.0.x only. For PDF support with IBM Cognos TM1 series 9.1 and later, use the ADDLOCAL option.

110 IBM Cognos TM1

Chapter 10: Silent Windows Installation for IBM Cognos TM1 Clients

Option
ADOBEPRINTER

Description
Name of the printer that the TM1 client should use.
ADOBEPRINTER=\"\\prtsrv\printer001\"

Note: This option applies to IBM Cognos TM1 series 9.0.x only.

Example
The following example performs a silent installation of IBM Cognos TM1 with no dialog boxes (/QN) and the language set to English (L1033).
setup.exe /S /L1033 /V"INSTALLLEVEL=0 INSTALLDIR=\"c:\program files\Cognos\" ADDLOCAL=Perspectives,PDFCamp PRODUCTCHOOSEN=TM1P EXCELEDITINCELL=True TM1AUTOLOAD=True TM1LANGSTRING=ENG CLIENTLOGIN=F TM1CLIENTADMHOST=boston /QN"

Troubleshooting the Installation Script

In some cases, the following error message can appear when using command line options to install IBM Cognos TM1: Error 2753. The file 'setup.exe' is not marked for installation. Resolve this issue by editing the ADDLOCAL option to include PDFCamp with Perspectives. For example:
ADDLOCAL=Perspectives,PDFCamp

Note that Perspectives and PDFCamp must appear exactly as shown in the example, using mixed case.

Uninstall
To uninstall IBM Cognos TM1 using the command line options, change the /S parameter to
/X while keeping the other parts of the script the same. For example: setup.exe" /X /L1033 /V"INSTALLLEVEL=0 INSTALLDIR=\"C:\Program Files\Cognos\" ADDLOCAL=Architect,Perspectives EXCELEDITINCELL=True /QN"

Installation Guide 111

Chapter 10: Silent Windows Installation for IBM Cognos TM1 Clients

112 IBM Cognos TM1

Chapter 11: Using IBM Cognos 8 Security with TM1

This section describes how to use IBM Cognos 8 security with IBM Cognos 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 IBM Cognos 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 the 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 the 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. After connecting to CAM two new folders are created in the installdir directory:configuration directory has epC8ITK.ini file and the Logs directory has multiple epC8ITK_2008-03-13.log. the configuration directory has epC8ITK.ini Logs directory has multiple epC8ITK_<datestamp>.log.

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

113

Chapter 11: Using IBM Cognos 8 Security with TM1

Setting Up the 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 the 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

If you are re-configuring the TM1 server to use IBM Cognos 8 security for authentication with another instance of IBM Cognos 8 (C8), you must remove any existing C8 users and groups that were imported from the first C8 instance and then re-import users and groups from the new C8 instance. Before enabling IBM Cognos 8 security on the 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 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.

114 IBM Cognos TM1

Chapter 11: 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 115

Chapter 11: 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 securityrelated administrative tasks from your TM1 client.

Steps
1. Open the Tm1p.ini configuration file in a text editor. Tm1p.ini 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

116 IBM Cognos TM1

Chapter 11: Using IBM Cognos 8 Security with TM1

Parameter Name
AllowImportCAMClients

Description
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 TM1 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 icon to move the selected user to the Selected Entries list.

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

Installation Guide 117

Chapter 11: 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 indicate that the server should use IBM Cognos 8 authentication. The exact parameter value depends on the specific TM1 components you are using: If you are not using the IBM Cognos TM1 Contributor component, set the parameter to 4.
IntegratedSecurityMode=4

If you are using IBM Cognos TM1 Contributor with IBM Cognos 8 security, set the parameter to 5 to support user groups from both TM1 and Cognos 8.
IntegratedSecurityMode=5

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

Importing Cognos Groups into TM1

Once a Cognos user is defined as the 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 the 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 icon to move the selected user to the Selected Entries list.

118 IBM Cognos TM1

Chapter 11: Using IBM Cognos 8 Security with TM1 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 the 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. 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 8 security with IBM CognosTM1 Developer Guide.

Configuring TM1 Web to Use IBM Cognos 8 Security

To allow users to successfully log in to TM1 Web when the 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 8 security with 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.

Administrator Considerations When Using IBM Cognos 8 Authentication

TM1 administrators should be aware of the following issues when configuring the TM1 server to use IBM Cognos 8 authentication. Review the description of TM1 security modes 4 and 5 for the IntegratedSecurityMode parameter. You should understand how these different modes control whether or not Cognos 8 users can belong to TM1 user groups. For details, see the description of the IntegratedSecurityMode parameter in the IBM Cognos 8 security with IBM Cognos TM1 Operation Guide.

Installation Guide 119

Chapter 11: Using IBM Cognos 8 Security with TM1 You can not use TM1 to permanently assign a Cognos 8 user to another Cognos 8 group. Any user assignment you make in TM1 to a Cognos 8 group is not saved back to Cognos 8. When a Cognos 8 user logs in to TM1, the group assignments in Cognos 8 override any Cognos 8 group assignments made in TM1. If you rename a Cognos 8 user after importing that user to TM1, you must then delete the user in TM1 in order to update TM1 with the new user name. After deleting the user in TM1, the new name will appear the next time the user logs in.

User Considerations When Using IBM Cognos 8 Authentication

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

Authentication Behavior
The following rules govern authentication behavior when logging on to the 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 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 applications (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 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 the 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 the 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. 120 IBM Cognos TM1

Chapter 11: Using IBM Cognos 8 Security with TM1 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 the 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.

Installation Guide 121

Chapter 11: Using IBM Cognos 8 Security with TM1

122 IBM Cognos TM1

Chapter 12: 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 using the installation wizard provided on the CD containing the main TM1 installer. The TM1 Portlets need to be installed on all Cognos 8 machines in a reporting environment. They should also be installed in the directory in which the Cognos 8 components were installed. For example, if the Cognos 8 components are installed on a certain machine in c:/program files/cognos8, then the portlets should be installed in /cognos8, as well.

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 components are 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. Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

123

Chapter 12: 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.

124 IBM Cognos TM1

Chapter 13: Installing the IBM Cognos TM1 Package Connector

IBM Cognos TM1 supports connectivity to IBM Cognos BI packages with SAP Business Warehouse data sources. See the "Importing Data Using the IBM Cognos TM1 Package Connector" chapter in the IBM Cognos TM1 TurboIntegrator Guide for more information about using the TM1 Package Connector. The IBM Cognos TM1 Package Connector is an optional component available as a separate CD or download from the main TM1 installation.

TM1 Package Connector requirements

Refer to the IBM Cognos BI and TM1 Info Centers for more details on the supported platforms, versions, and requirements. The IBM Cognos TM1 Package Connector requires the following components: TM1: TM1 9.5.1 or later. The TM1 Package Connector must be installed on both the TM1 server and the administrative client machines where TurboIntegrator processes are being created against a BW package.

IBM Cognos BI Server. See the Info Center for specific versions supported. Framework Manager for package creation.

SAP Business Warehouse. See the Info Center for specific versions supported. 32-bit database client software is required or SAP RFCSDK library files and DLLs. See Enabling connectivity to SAP from TM1

Installing the TM1 Package Connector

To install the IBM Cognos TM1 Package Connector:

Steps
1. Insert the TM1 Package Connector disk into the TM1 server machine. 2. Run tm1pkgctor.exe. This launches the IBM Cognos Installer. 3. Complete the installation prompts as appropriate for your installation. Click Next to move to the next screen:

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

125

Chapter 13: Installing the IBM Cognos TM1 Package Connector Select the language to use. Indicate that you agree to the license. Indicate the installation location, for example C:\Program Files\Cognos\c8. If the folder you enter does not yet exist, the installer will ask if you want to create it. This location can be an existing C8 folder. You do not need to create a separate C8 location for the TM1 Package Connector. Specify shortcuts to use for this program. Review the summarization of the installation parameters.

4. Click Next on the summary screen to launch the installation. The Installation Progress bar indicates how many files are left to install. There are a larger number of files to install if this is the first time you have installed C8. 5. An informational message reminds you that the Supplementary Languages Documentation Component can be installed from the Supplementary Languages Documentation CD if you want to set the language for documentation. Click OK to acknowledge this information. 6. On the Finish screen, you can view the transfer log or view the summary-error log. Check the Start IBM Cognos Configuration checkbox to launch the configuration window automatically. If you prefer, you can leave this box unchecked and launch the Cognos Configuration manually after you have installed.

Installing the TM1 Package Connector on Windows 7 or Vista

By default the temp directory for the TM1 Package Connector in IBM Cognos Configuration is
../temp which is in the Program Files location. Microsoft Vista or Windows 7 applications are

not allowed to write in the Program Files location. This can result in an error when choosing the TM1 Package Connector from Perspectives on Windows 7 and Vista. To avoid this problem, choose 'Run as Administrator' when running Excel, or in the IBM Cognos Configuration for TM1 Package Connector you can change the Temporary files location setting to a directory that is writable by the user.

Enabling connectivity to SAP from TM1

To enable connectivity to the SAP server requires the 32-bit SAP RFCSDK library files and DLLs on both the TM1 Admin Client and the TM1 server. To obtain these files on Windows, install the SAP GUI. For UNIX see Installing the TM1 Package Connector on UNIX.

Configuring the TM1 Package Connector

Once you have installed the IBM Cognos 8 TM1 Package Connector, you have access to the IBM Configuration tool. If the Configuration tool did not launch automatically, you can use the Start Menu, IBM Cognos, IBM Cognos Configuration option to launch it manually. 126 IBM Cognos TM1

Chapter 13: Installing the IBM Cognos TM1 Package Connector To configure the TM1 Package Connector, specify the Cognos BI Server Gateway and Dispatcher URIs:

Steps
1. Launch or open IBM Cognos Configuration. 2. Select the Environment node on the Local Configuration Explorer window. The current settings for URI display. 3. Set the Gateway URI to point to the BI server where packages are deployed. The Gateway URI is in the form of
http[s]://<host IP address>:<port>/<BI_SERVER_virtual_dir>/cgi/cognos.cgi.

See the IBM Cognos TM1 Operations Guide or the Cognos 8 documentation for more information on URIs. 4. Enter the URI in the Value column of the Other URI settings node. The Dispatch URI is in the form of
http[s]://<host IP address>:<port>/p2pd/servlet/dispatch.

5. Once the URI is set, Save the configuration. The configuration progress window checks the status of your entries. When it is complete, click Close. If you encountered an error, check your settings and re-enter the values. 6. Close the configuration window.

Setting the environment variable

On Microsoft Windows, after you have installed the TM1 Package Connector, the TM1_ PACKAGE_CONNECTOR user environment variable is set to the installation directory specified in the installation, for example C:\Program Files\cognos\c8\bin. You can change this location if necessary by editing the variable or create a system environment variable. The CognosTM1InterfacePath variable is required only when using the TM1 Package Connector on UNIX.

Setting the TM1 server configuration parameter

For the TI process to run on the TM1 server, add the CognosTM1InterfacePath parameter to the TM1 server configuration file for the TM1 server where your data will reside after the import from the C8 package. The value of this parameter tells the TM1 Server where to find the TM1 Package Connector. This is not needed if the TM1_PACKAGE_CONNECTOR environment variable is defined. If this parameter is defined, it overrides the TM1_PACKAGE_CONNECTOR environment variable.

Installation Guide 127

Chapter 13: Installing the IBM Cognos TM1 Package Connector Enter the Package Connector location into the TM1 server tm1s.cfg file where the TM1 Package Connector is installed, for example:
CognosTM1InterfacePath=C:\Program Files\cognos\c8\bin

Installing on the client machine

After you have installed and configured the TM1 Package Connector on the TM1 server, install and configure another copy on the admin client machine. Use the same settings for both installations.

Running the TM1 Package Connector

See "Importing Data Using the IBM Cognos TM1 Package Connector" chapter of the TM1 TurboIntegrator Guide for details on how to run the TM1 Package Connector.

Installing the TM1 Package Connector on UNIX

To install the IBM Cognos TM1 Package Connector on UNIX follow the same instructions as for the Windows installation making the following adjustments:

Steps
1. Use Java 1.6 2. Set the environment variable JAVA_HOME=<java_location> where <java_location> is the Java installation location. 3. Copy the files at
c8/bin/jre/1.5.0/lib/ext*

to JAVA_HOME/jre/lib/ext 4. Start cogconfig.sh from the c8/bin. 5. Place the 32-bit SAP RFCSDK library files and DLLs on the UNIX machine. 6. Configure your environment to use the SAP DLLs and the TM1 Package Connector: Add the path to the RFCSDK, lib, and bin folders to the environment PATH variable. Add the path to the RFCSDK lib and bin folders, and the path to the IBM Cognos Package Connector bin folder to the environment variables. Where the libraries are found is different on various UNIX platforms: Solaris and Linux: LD_LIBRARY_PATH IBM AIX: LIBPATH Create an environment variable: TM1_PACKAGE_CONNECTOR=/C8_CONNECTOR_PATH/bin

7. Set a locale that uses the UTF-8 code page page to handle Unicode data.

128 IBM Cognos TM1

Chapter 13: Installing the IBM Cognos TM1 Package Connector 8. Configure the TM1 server by adding the parameter:
CognosTM1InterfacePath=/C8_CONNECTOR_PATH/bin

This is not needed if the TM1_PACKAGE_CONNECTOR environment variable is defined. If this parameter is defined, it overrides the TM1_PACKAGE_CONNECTOR environment variable.

Installation Guide 129

Chapter 13: Installing the IBM Cognos TM1 Package Connector

130 IBM Cognos TM1

Chapter 14: Maintaining Your TM1 Installation

This section describes the typical tasks you can perform after you install IBM Cognos TM1. After successfully installing TM1, you can return to the TM1 Installation Wizard to modify or uninstall TM1 components. When upgrading to a new version of TM1, you can manually back up and restore your existing TM1 data.

Maintaining TM1 Components

If you try to reinstall the same version of IBM Cognos TM1 that is already installed, the Program Maintenance screen opens with the following options: Modify - Use this to change which TM1 components are installed. For details, see "Modifying TM1 Installed Components" (p. 131). Remove - Use this option to uninstall TM1 from your computer. For details, see "Uninstalling IBM Cognos TM1" (p. 132).

Modifying TM1 Installed 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. If autorun is enabled on your CD drive, the IBM Cognos 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. The Component Selection screen appears, 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. Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

131

Chapter 14: Maintaining Your TM1 Installation 4. Select the TM1 components you want to modify and click Next. 5. Click Install to start the modifications. 6. Click Finish when the modifications are completed.

Uninstalling IBM Cognos TM1

To remove and uninstall all components of TM1, follow these steps.

Steps
1. Create a backup copy of your custom data and configuration files by copying 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. For details, see "Backing Up Your TM1 Data" (p. 132). 2. Delete the <TM1_Home>\custom\ directory. 3. From the Windows Control Panel, choose Add or Remove Programs. 4. In the list of currently installed programs, select IBM Cognos TM1. 5. Click Remove and follow the instructions to complete the process. Note: If you are uninstalling and/or reinstalling IBM Cognos TM1 Contributor, see "Uninstalling and Reinstalling TM1 Contributor" (p. 73) for additional required steps. Uninstalling also has an effect on the TM1 application pool. See the IBM Cognos TM1 Web Guide for more information.

Backing Up Your TM1 Data

If you are upgrading your existing version of TM1, you should back up your TM1 data directory and configuration files to a safe location before running the TM1 Installation Wizard. If you are using TM1 Web and/or TM1 Contributor, you should also back up the related files and data for those components.

Steps
1. Save a copy of your existing TM1 data directory and sub-directories to a secure location. The default data directory location is <TM1_Install>\Custom\. 2. 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. 3. If you are using TM1 Web, back up 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. You should also keep a back up copy of the Web.config file from this same location. 4. If you are using TM1 Contributor, follow the steps to backup your TM1 Contributor applications as described in the section, "Uninstalling and Reinstalling TM1 Contributor" (p. 73).

132 IBM Cognos TM1

Chapter 14: Maintaining Your TM1 Installation

Restoring Your TM1 Databases

After installing a newer version of TM1, complete these steps to restore your TM1 databases.

Steps
1. Copy your existing TM1 server data directory to the new <TM1_Install>\Custom\ directory that is available after you install TM1. 2. Restore your existing TM1 configuration files to the <TM1_Install>\bin\ directory. 3. If you are using TM1 Web, restore your existing custom TM1 Web server pages to the new directory containing the TM1 Web server pages, usually C:\inetpub\wwwroot\TM1Web. You may also need to selectively merge lines from your previous version of the Web.config file into the new Web.config file installed in this location by the newer version of TM1 Web. 4. If you are using TM1 Contributor, follow the steps to restore your TM1 Contributor applications as described in the section, "Uninstalling and Reinstalling TM1 Contributor" (p. 73).

Installation Guide 133

Chapter 14: Maintaining Your TM1 Installation

134 IBM Cognos TM1

Index
Symbols
/etc/services, 87 .NET API, 37, 41 .NET framework, 14 .username, 27 + plus sign, 20 64-bit Windows, 77 x86, 83 Clients Configuration, 30 Perspectives, 37 TM1, 23 TM1 Web, 41, 46 Cognos 8 authentication, 113 defining an administrator, 117 Cognos 8 security, 113 administrator considerations, 119 user considerations, 120 with TM1 Contributor, 71 with TM1 Viewer Portlets, 124 CognosGatewayURI, 116 Cognos security passport, 113 CognosTM1InterfacePath configuration parameter, 127 components exclude, 20 Perspectives, 38 TM1, 23 TM1 Web, 41, 46 console installation, 94

A
Active Server Pages (ASP), 46 Admin Host, 25 Admin Server, 37, 41 Host Machine Name, 29, 30, 45, 81 host name, 32, 38, 46 port number, 32, 38, 46, 81 AllowImportCAMClients, 116 ASP.NET, 46 authentication, 27, 113 for TM1 Viewer Portlets, 124 importing groups into TM1, 118 authentication error TM1 Viewer Portlets, 124 autoload, 30

D
default values Perspectives, 38 TM1, 32, 81 TM1 Web, 46 Developer Environment Perspectives, 37 TM1, 23 TM1 Web, 41, 46 Dispatch URI, 126 display resolution, 18 domains account, 18, 80 installing without, 27 Dundas Charts (c), 46

B
background mode, 95 backing up data, 132

C
CAMID, 113 CAMPortalVariableFile, 114 CAMSSLCertificate, 114 change button, 20 character encoding, 92 Choose a Product to Install, 19 Choose Database, 29, 45 ClientCAMURI, 114 ClientPingCAMPassport, 114

E
Edit Directly in Cell, 30 Excel application, 105

Licensed Materials Property of IBM Copyright IBM Corp. 2007, 2011.

135

Index exclude components, 20 export to PDF locale setting, 73 Linux, 87 locale setting, 18 local machine syntax, 27 logging in to TM1 Viewer Portlets authentication error, 124

F
fonts, 18

M G
Gateway URI, 126 manuals, 37, 41, 46 Microsoft Excel 2000, 97 mixed mode, 28

I
IBM AIX memory resource limits, 95 running TM1 with, 95 unsupported commands with TM1, 95 IIS, 14 IIS web server, 14 installation checklist, 13 checklist for UNIX, 88 console, 94 directory, 20 location screen, 20 options screen, 20 planning, 13 required chart controls, 16 silent, 93 troubleshooting, 104 installation prerequisites, 97 installing TM1 Viewer Portlets, 123 Integrated Login, 27, 28, 30 TM1 Web, 44 interoperability IBM Cognos BI 8.4.1 and IBM Cognos TM1 9.4 and 9.5 configuration requirements, 34

O
Oracle, 13, 88

P
Package Connector Windows 7, 126 passport, 113 password, 26 permissions, 46 Perspectives, 37 components list, 37 default values, 38 Planning Sample Data x64, 85 privileges Service Account, 13

R
regional setting, 18 restoring data after upgrading, 133 ROOT, 13

S
sample data directory, 32, 38, 46, 81 Search Base LDAP, 27 security for TM1 Viewer Portlets, 124 mode, 32, 46, 81 settings TM1 Web, 44 server name, 45 Perspectives, 37, 41 TM1, 23 TM1 Web, 45, 46 UNIX, 89 ServerCAMURI, 114

L
language, 18 LDAP authentication, 27 host, 27 port, 27 search base, 27 search field, 27 License Agreement, 19, 90 136 IBM Cognos TM1

Index Service Account TM1, 13 setup.exe, 19 silent installation, 93 SkipSSLCAMHostCheck, 114 Solaris, 13, 87 SSL, 25 port number, 32, 46, 81 startup property, 14 subfeatures, 20 installing on a single computer, 54 installing on separate computers, 54 installing with Installation Wizard, 55 link to open, 64 logging on, 66 running for the first time, 65 security authentication mode, 59 standard installation, 58 uninstalling, 70 uninstalling and reinstalling, 73 using with multiple TM1 servers, 72 using with x64 Windows, 51 with IBM Cognos 8 security, 71 with Microsoft IIS, 63 TM1Install.log, 17 TM1 object names, 92 Tm1p.ini, 38, 45 Tm1p.xla, 30 TM1 Package Connector requirements, 125 TM1 Perspectives, 97 tm1s_start_example, 95 Tm1s.cfg, 45, 80, 85 TM1 Viewer Portlets authentication error, 124 installing, 123 uninstalling, 124

T
TCP/IP port number, 25, 44, 79 TEMP, 17 TM1, 30 Admin Server, 18 API, 37, 41 Architect, 41 authentication, 27 Client, 30, 38 Client Configuration, 30 components list, 32, 81 Contributor, 49 default values, 32, 81 Java API, 37, 41 Perspectives, 37 Perspectives/Architect, 81 Perspectives Client, 37, 41 server, 18, 32, 37, 38, 41, 45, 46, 81, 95 Service Account, 13 TM1Top, 23 Top, 37, 41 Web, 46 TM1_Package_Connector environment variable, 127 TM1 Client, 97 TM1 Contributor Administration tool, 66 architecture and deployment, 52 architecture overview, 52 custom installation, 56 deploying on Apache Tomcat, 62 deploying on a Web server, 60 deploying on IBM WebSphere, 60 deployment options, 54 installation checklist, 50 installing, 49

U
uninstall, 132 uninstalling TM1 Viewer Portlets, 124 UNIX, 13, 87, 88, 95 use integrated login, 30 username, 26, 80

V
Vista, Package Connector, 126

W
Web components, 37, 41, 46 Windows permissions, 46 XP Professional, 83 Windows 7 Package Connector, 126

Installation Guide 137

Index Workflow after upgrading TM1 Web, 98 conflict with anti-virus software, 99 installation notes, 97 installation prerequisites, 97 re-install after TM1 Web upgrade, 98 x64 installation, 98

X
x64 Workflow installation, 98 XHOST, 87

138 IBM Cognos TM1