TM1 Installation Guide

TM1 Installation

Product Information

This document applies to IBM Cognos® TM1 9.4 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Global Customer Services Web site (http://support.cognos.com).

Copyright

Copyright © 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company.

Portions of Cognos ULC software products are protected by one or more of the following U.S. Patents: 6,609,123 B1; 6,611,838 B1; 6,662,188 B1; 6,728,697 B2; 6,741,982 B2; 6,763,520 B1; 6,768,995 B2; 6,782,378 B2; 6,847,973 B2; 6,853,375 B2; 6,907,428 B2; 6,986,135 B2; 6,995,768 B2; 7,062,479 B2; 7,072,822 B2; 7,111,007 B2; 7,130,822 B1; 7,155,398 B2; 7,171,425 B2; 7,185,016 B1; 7,213,199 B2; 7,243,106 B2; 7,257,612 B2; 7,275,211 B2; 7,281,047 B2; 7,293,008 B2; 7,296 040 B2; 7,318,058 B2; 7,325,003 B2.

Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries, or both. Other company, product, or service names may be trademarks or service marks of others.

While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document.

This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to the information contained in this document will be documented in subsequent editions.

U.S. Government Restricted Rights. The software and accompanying materials are provided with Restricted Rights. Use, duplication, disclosure by the Government is subject to the restrictions in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer clause at DFARS 252.227‐7013, or subparagraphs (C)(1) and (2) of the Commercial Computer Software ‐ Restricted Rights at 48CFR52.227‐ as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA 01803.

This document contains proprietary information of Cognos. All rights are reserved. No part of this document may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos.

Publication Date: July 2008

http://support.cognos.com

Table of Contents | Index

Table of Contents

Chapter 1 TM1 Installation OverviewInstallation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐3 TM1 Service Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐4Hardware and Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐5

.NET Framework Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐5Logging Installation Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐8Installing Components on Different Machines . . . . . . . . . . . . . . . . 1‐10

Important Notes on Distributed Installations . . . . . . . . . . . . . . 1‐11Starting the Installation Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐11

Choose Setup Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐11Accept the License Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐13

Choose a Product to Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐14Microsoft Framework Reminder . . . . . . . . . . . . . . . . . . . . . . . . . 1‐14

Custom or Standard Installation Options. . . . . . . . . . . . . . . . . . . . . 1‐15Installation Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐16Selecting Components to Install . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐18

Chapter 2 Installing TM1Custom TM1 Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐2

Table of Contents iii


Custom TM1 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐3Configuring TCP/IP Ports for TM1 . . . . . . . . . . . . . . . . . . . . . . . . 2‐7Username and Password for TM1 Services . . . . . . . . . . . . . . . . . 2‐9Installing TM1 on Networks without Domains . . . . . . . . . . . . . 2‐10Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐12Integrated Login Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐14Configuring the TM1 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐16Configuring TM1 Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐19Begin the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐21Post‐Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐21

Standard TM1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐23

Chapter 3 Installing TM1 Perspectives Custom TM1 Perspectives Installation. . . . . . . . . . . . . . . . . . . . . . . . 3‐1

Configuring TM1 Perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐3Standard TM1 Perspectives Installation . . . . . . . . . . . . . . . . . . . . . . . 3‐4

Chapter 4 Installing TM1 WebCustom TM1 Web Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐2

Configuring TM1 Web Components . . . . . . . . . . . . . . . . . . . . . . 4‐2Configuring TCP/IP Ports for TM1 Web . . . . . . . . . . . . . . . . . . . . 4‐3Username and Password for TM1 Services . . . . . . . . . . . . . . . . . 4‐4Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐4Configuring the TM1 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐5

iv TM1 Installation


Configuring TM1 Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐6Configuring Web Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐7

Standard TM1 Web Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4‐8

Chapter 5 Installing TM1 for 64-bit WindowsCustom 64‐bit TM1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐2

Configuring TCP/IP Ports for 64‐bit TM1 . . . . . . . . . . . . . . . . . . . 5‐2Username and Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐2Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐3Configuring the 64‐bit TM1 Server . . . . . . . . . . . . . . . . . . . . . . . . 5‐3

Standard 64‐bit Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5‐5

Chapter 6 Installing TM1 x86 on a x64 Windows SystemThe 64‐bit Application Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6‐2WOW64 (32‐bit) Application Space . . . . . . . . . . . . . . . . . . . . . . . . 6‐2Installation Notes about TM1 Components . . . . . . . . . . . . . . . . . 6‐2 Importance of Installation Order. . . . . . . . . . . . . . . . . . . . . . . . . . 6‐3Location of Installed TM1 Program Files . . . . . . . . . . . . . . . . . . . 6‐4Naming Conventions for x86 and x64 TM1 Services. . . . . . . . . . 6‐5Installing TM1 x86 in Windows x64. . . . . . . . . . . . . . . . . . . . . . . . 6‐5Running the TM1 Database with Both x86 and x64 TM1 Servers 6‐6Running TM1 Web x86 on Windows x64 . . . . . . . . . . . . . . . . . . . 6‐7

Table of Contents v


Chapter 7 Installing TM1 on UNIXPre‐Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐1

UNIX Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐2UNIX Compatible Components . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐4

Starting the Installation Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐4Accept the License Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐5Installation Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐5TM1 UNIX Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐5Configuring TCP/IP Ports in UNIX . . . . . . . . . . . . . . . . . . . . . . . . 7‐8Oracle DataSource Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 7‐8TM1 Server Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐9Setting Up a TM1 Administrative Account . . . . . . . . . . . . . . . . . 7‐9Installation Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐10

After You Complete the Installation . . . . . . . . . . . . . . . . . . . . . . . . . 7‐11S89Applix Startup Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐11Uninstalling UNIX TM1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐12Silent UNIX Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐13Console Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐14Starting a UNIX TM1 Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7‐14

Chapter 8 Installing TM1 WorkflowWorkflow Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐2

Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐2

vi TM1 Installation


Running the Workflow Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐3Selecting Workflow Installation Components . . . . . . . . . . . . . . . . . . 1‐7

Workflow Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐8Destination Folder for Workflow Components . . . . . . . . . . . . . . 1‐9

Installing Workflow for the First Time . . . . . . . . . . . . . . . . . . . . . . . 1‐11Upgrading Planning Manager 1.0 or 1.1. . . . . . . . . . . . . . . . . . . . . . 1‐13Upgrading Planning Manager 1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐15Configuring Workflow for Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐16

Troubleshooting the Workflow Excel Add‐in . . . . . . . . . . . . . . 1‐17Using Workflow with TM1 Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐19

Workflow On The Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1‐19Workflow Features in TM1 Web . . . . . . . . . . . . . . . . . . . . . . . . . 1‐19

Chapter 9 Installing TM1 Viewer Portlets for Cognos 8 Portal ServicesInstall the TM1 Viewer Portlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐1

Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐1Configure Access to IBM Cognos 8 From the TM1 Viewer Portlets2‐2

Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐3Logon Requested or Authentication Error When Accessing a TM1 Viewer Portlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐3

Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐3Uninstall the TM1 Viewer Portlets . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐4

Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2‐4

Table of Contents vii


Chapter 10 Maintaining and Upgrading Your TM1 InstallationMaintaining TM1 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐1

Modify Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐2Repair the TM1 Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐3Remove TM1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐4

Upgrading TM1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐4Backing Up Your TM1 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐6Determining the Currently Installed Version of TM1. . . . . . . . . 3‐7Determining the Current Version on UNIX . . . . . . . . . . . . . . . . . 3‐8Upgrading TM1 9.1 or Newer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐9Upgrading a Pre‐9.1 Version of TM1 . . . . . . . . . . . . . . . . . . . . . . 3‐10Cancelling an Installation When the Existing Version of TM1 Cannot be Upgraded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐11

Upgrading TM1 Web. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐11Upgrading TM1 Web from an 8.x Version of TM1 to a 9.x Version of TM1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐13Troubleshooting the TM1 Web Installation . . . . . . . . . . . . . . . . 3‐13Stopping any Windows Services or Programs Locking the TM1 Web Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3‐14Repairing a Cancelled or Incomplete Installation of TM1 Web3‐16

viii TM1 Installation


Preface

Business Performance Management with IBM Cognos TM1Business 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.

About This ManualThis manual describes how to install the IBM Cognos TM1 software components on Windows and UNIX operating systems.

iii


AudienceUsers of TM1 familar with their system and network requirements and having a basic understanding of programming and installation concepts.

Related DocumentationThe following table lists other documentation in the TM1 Documentation Library. Only those documents that are pertinent to your user‐level are available. If a link is unavailable, you may receive a “This page cannot be found” message. If necessary you can access the document on the Cognos Global Customer Services Web site (http://support.cognos.com). Logon credentials are available from your administrator or by request from [email protected].

TM1 API Describes the functions and features of the IBM Cognos TM1 API. The API is intended to give complete access to all the features and functionality of the TM1 OLAP engine.

TM1 Developers Guide Describes how to create and maintain objects on a TM1 server, administer security, and develop TM1 applications.

TM1 Operations Guide Provides a basic understanding of TM1 architecture, server operations, authentication, and component security.

iv TM1 Installation


Conventions Used in This ManualThe following typeface conventions are used throughout this guide:

TM1 Reference Guide A collection of reference materials that describes TM1 functions, variables, and other programming elements.

TM1 Rules Guide Describes how to use TM1 rules to build an application that reveals business data in sophisticated and useful ways based on simple raw data.

TM1 TurboIntegrator Guide Describes how to use TM1 TurboIntegrator to import data and metadata into TM1 from a variety of sources.

TM1 Users Guide Describes how to use the TM1 Windows clients: TM1 Architect, TM1 Perspectives, and TM1 Client. It also describes the Web‐based client, TM1 Web.

Arial Arial text indicates that this option or object appears as part of the user interface.File names and directories are also indicated by Arial text.

Arial Bold Bold Arial text indicates an option to choose or text to type. It usually appears in numbered steps.

Preface v


Finding InformationTo find the most current product documentation, including all localized documentation, access the IBM Cognos Global Customer Services Web site (http://support.cognos.com). Click the Documentation link to access documentation guides. Click the Knowledge Base link to access all documentation, technical papers, and multimedia materials.

Product documentation is also available in online help from the Help menu or button in IBM Cognos products. You can also download documentation in PDF format from the IBM Cognos Global Customer Services Web site.

Getting HelpFor more information about using IBM Cognos products or for technical assistance, visit the IBM Cognos Global Customer Services Web site (http://support.cognos.com). This site provides product information, services, user forums, and a knowledge base of documentation and multimedia materials. To

Italics Words are italicized for emphasis or to draw your attention to a new term. For example, “Do not press the RETURN key.”

Menu Name → Option Name

Whenever you see a reference to a menu option, the option is identified using the following notation:Menu Name → Option NameFor example, “Choose File →Options.”

code examples Code examples are in courier.

vi TM1 Installation


log a Service Request, go to IBM Cognos Insight! at http://support.cognos.com/en/support/insight. For general inquiries, contact your local IBM Cognos Support office. Contact information can be found at http://support.cognos.com/en/support/about/contact.html. For information about education and training, click the Training link.

Printing Copyright MaterialsYou can print selected pages, a section, or the whole book. IBM Cognos grants you a non‐exclusive, non‐transferable license to use, copy, and reproduce the copyright materials, in printed or electronic format, solely for the purpose of operating, maintaining, and providing internal training on the Cognos software.

Preface vii


viii TM1 Installation


1 TM1 Installation Overview

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

TM1 is organized into three installation packages:

TM1 – This installation package installs, by default, all major TM1 components with the exception of TM1 Web and several minor components. Typically, you would choose this installation option when you want to install various TM1 components in a distributed environment. It also enables you to install multiple TM1 servers (to a maximum of 3) on the same computer in a single installation session.

TM1 Perspectives – TM1’s Excel add‐in client. TM1 Perspectives enables you to use the familiar and powerful features of Excel to perform complex analysis on data stored in a TM1 server. Typically, you would choose this installation option if you want to install TM1 Perspectives on a single stand‐alone development machine. TM1 Perspectives installs with its own ‘local’ TM1 server or it can connect to a ‘remote’ TM1 server installed on another computer in your environment.

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.

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

TM1 Installation Overview 1-1


Contents, Index, and Search tabs to navigate the help system and locate a particular topic.

NOTE: Installation Wizard error messages are displayed in English.

Before You Install Installation ChecklistTM1 Service AccountHardware and SoftwareLogging Installation MessagesInstalling Components on Different Machines

Running the Wizard Starting the Installation WizardChoose Setup LanguageAccept the License AgreementChoose a Product to InstallInstallation LocationCustom or Standard Installation Options

Installing TM1 Products Installing TM1 PerspectivesInstalling TM1Installing TM1 WebInstalling TM1 for 64-bit WindowsInstalling TM1 x86 on a x64 Windows SystemInstalling TM1 on UNIX

Additional Topics Maintaining and Upgrading Your TM1 Installation

1-2 TM1 Installation

Installation Checklist Table of Contents | Index

If you are upgrading to a newer version of TM1, see “Upgrading TM1.” To install TM1 onto a UNIX machine, see “Installing TM1 on 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 TM1 Users Guide and the TM1 Developers Guide.

Determine which components you want to install and how they should be distributed across your hardware environment.

In a production environment, TM1 components are usually distributed across multiple computers. See “TM1 System Architecture” in the TM1 Operations Guide for details on how to design the optimal TM1 environment.

Determine your hardware and software requirements.

Refer to the TM1 platform matrix available on the Cognos Global Customer Services Web site (http://support.cognos.com) 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. See ‘’Installing TM1 on UNIX” for more information.



TM1 Service Account Table of Contents | Index

Decide what language to set as the default for the installation.

You can choose from a variety of currently available languages. Your choice of language determines the language in which the Installation Wizard runs. It also determines the language in which TM1 components will run.

Create your TM1 Service Account.

Before you install TM1, we recommend that you create a single domain account for all your Windows‐based TM1 Services.

TM1 Service Account

Before you install TM1, we recommend that you create a single domain account for all your Windows‐based TM1 services, such as the TM1 Server, TM1 Admin Server, and TM1 Excel Service. The account should be a member of the Local Administrator group and must have the following privileges on the local machine:

• Act as part of the operating system

• Bypass traverse checking

• Increase quotas

• Replace a process level token

• Log on as a service

• Have read privileges on the Windows Registry item

The Installation Wizard will enable and use these privileges during the installation process.


Hardware and Software Table of Contents | Index

This account applies only to Windows‐based services and agents. TM1 services installed on Solaris or HP/UX always run as ROOT.

Hardware and Software

For a complete list of supported platforms and software, refer to the TM1 platform matrix available on the Cognos Global Customer Services Web site (http://support.cognos.com).

.NET Framework Requirements

The TM1 Rules Editor requires the installation of the Microsoft .NET Framework Version 3.0. You can download it from the Microsoft © website. When you install a message appears to remind you of this requirment.

To ensure that the .NET Framework 3.0 is properly installed and registered on your computer, perform these steps:

1. Open a Command Prompt window and change to the following directory:

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

2. Execute the following command:

aspnet_regiis.exe -i

If you do not perform the previous steps, or for some reason the Microsoft ASP.NET Framework 3.0 is installed but not registered on your computer, you may receive the following error when you install TM1:

Error 1720: There is a problem with this Windows Installer package. A script required for this install to complete could not be run. Contact your support personnel or package vendor.




This error may also display if Microsoft Internet Information Services (IIS) is not installed on your computer.

If you experience this error, follow these steps to correct the error and successfully install TM1:

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 Compo-nents feature.

3. Manually register the Microsoft ASP.NET Framework.

4. Run the TM1 Installation Wizard again.

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:

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 Microsoft © Excel 2002 or Excel 2003 on the same machine where the IIS web server is installed. If



Excel 2002 or 2003 is not present on the machine where the IIS web server is installed, the TM1 Web installation displays a warning message, but allows you to continue the installation.

ASPNET User is not Defined

If you attempt to install TM1 Web on a system where the Microsoft .NET Framework is not yet installed, the TM1 Web installation will fail if the ASPNET user is not defined on the system.

Error 1609: An error occurred while applying security settings. ASPNET is not a valid user group. This could be a problem with the package, or a problem connecting to a domain controller on the network. Check your network connection and click Retry, or Cancel.

You must define the ASPNET user before you install TM1 Web. To create the ASPNET user:


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.


Logging Installation Messages Table of Contents | Index

7. Click Create.

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


Logging Installation Messages Table of Contents | Index

• location of all files installed by TM1

• error messages

• final installation status (successful/not successful)

The log file is named TM1Install.log. It is written to the directory identified by your TEMP user environment variable. The log file remains until the next time you run an install.

To determine the location of this directory you can issue the command echo $TEMP (UNIX) or echo %TEMP (Windows) or:



Installing Components on Different Machines Table of Contents | Index

2. Double‐click System.

3. Click the Advanced tab.

4. Click Environment Variables.

Find the TEMP variable in the list of user variables for the directory location of TM1Install.log.

Installing Components on Different Machines

You can install TM1 components on different machines in your hardware environment. For each component you want to install on a different machine, run the TM1 Installation Wizard on that machine.

If you distribute components throughout your network, you must know certain information about where your components will be installed, and the configuration of those components. The following list provides information about what you need to know to install each component.

TM1 Server To install the TM1 server, you must know the name of the machine on which the TM1 Admin Server is running.

TM1 Admin Server This can be installed without any knowledge of your network topology.

ODBC Gateway To install the ODBC Gateway on separate machines, you must know the location of the Oracle client files, the Oracle Service Name, and the Oracle database username and password.


Starting the Installation Wizard Table of Contents | Index

Important Notes on Distributed Installations

• All services must be running under a single domain account. The TM1 Installation Wizard will set the parameters of the domain account for you, but you must create the account under which the services will run before you run the installation. If services are running under different accounts, they will not be able to communicate. This will lead to many problems.

• You can run services under the local system account only if all TM1 Services are running on the same machine.

• TM1 services must run on machines set to the same locale. You cannot, for example, install some services on a machine running the US English locale, and other services on a machine running the German. local Set the locale using the Windows Start Menu → Regional and Local Settings →Standards and Formats option.

Starting the Installation Wizard

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.

Choose Setup Language

The Choose Setup Language dialog box opens to let you select the language.

1. Click on the drop‐down menu to choose one of the currently available lan‐guages. 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 “Upgrading TM1” 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 Table of Contents | Index

Choose a Product to Install

Select the installation package you want and click Next.

Microsoft Framework Reminder

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


Custom or Standard Installation Options Table of Contents | Index

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 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” for the next step in the Standard installation process.

• A Custom installation 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\IBM Cognos\TM1. If you perform a custom installation and choose to install only TM1 Web, the default installation directory is C:\Inetpub\wwwroot\TM1Web.

To change the default location where TM1 installs, click on the Change button.

The Installation Location screen displays:



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 Perspectives, TM1, or TM1 Web for details. See “Installing TM1 for 64‐bit Windows,” Installing TM1 x86 on a x64 Windows System,” or “Installing TM1 on UNIX” for details on installing in those environments.

Click the drop‐down menu next to a component name to include or exclude a component:



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.





2 Installing TM1

This chapter describes how to install TM1 components using either the Standard or Custom installation options. Topics include:

• Custom TM1 Installation

‐ Custom TM1 Components

‐ Configuring TCP/IP Ports for TM1

‐ Username and Password for TM1 Services

‐ Installing TM1 on Networks without Domains

‐ Configuring the TM1 Server

‐ Configuring TM1 Clients

‐ Begin the Installation

‐ Post‐Installation Tasks

• Standard TM1 Installation

To run the Installation Wizard and install TM1 components:

1. After you have answered the introductory prompts (see “Starting the Installation Wizard”) the Choose a Product to Install screen displays.

2. Select TM1 and click Next.

Installing TM1 2-1

Custom TM1 Installation Table of Contents | Index

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.

Installed by default

Description

Manuals Yes TM1 Documentation LibraryInstalls the TM1 Documentation Library in PDF format.NOTE: The Installation Wizard automatically installs the TM1 Documentation Library in HTML format. This is not an installation option.

Clients Yes TM1 ClientRuns as an add‐in to Microsoft Excel and provides limited access to data on remote TM1 Servers.

Yes TM1 PerspectivesRuns 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.

Installing TM1 2-3


Yes OLEDB ProviderInstalls 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’sEnvironment

Yes TM1 ArchitectA stand‐alone TM1 client used to create and maintain data and metadata on both local and remote TM1 servers.

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

Yes TM1 Java APIApplication programming interface that developers use to create Java applications that interact with TM1.

Yes TM1 .NET APIApplication programming interface that developers use to create .NET applications that interact with TM1.


Description



Servers Yes TM1 Admin ServerA 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 ServerThe 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.


Description

Installing TM1 2-5


No TM1 Web ComponentsInstalls 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 TopA TM1 utility that enables you to dynamically monitor threads running in an instance of a Windows or UNIX TM1 server.TM1 Top runs only on a Windows system and is available only with the Windows installation of TM1. NOTE: To monitor a UNIX TM1 server, use the TM1 Installation Wizard to install TM1 Top on a Windows system and then configure TM1 Top to connect to the UNIX TM1 server. When the ADMINHOST and SERVERNAME parameters are pointing to a UNIX machine, TM1 Top will monitor the UNIX environment. See “System and Performance Monitoring” in the TM1 Operations Guide for details on configuring the TM1Top.ini file.


Description



Configuring TCP/IP Ports for TM1

Specify the TCP/IP port number for the following programs:

TM1 Admin Host port number

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

TM1 SSL Admin server port number

Installing TM1 2-7


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.

5498All 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” for more information.

TM1 Client Message port number

12346This port number establishes a secondary port for progress messages to use when a lengthy operation is waiting to be cancelled. See “The Tm1s.cfg File” for more information.



Username and Password for TM1 Services

Installing TM1 2-9


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.

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.

See also “Installing TM1 on Networks without Domains.”

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

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

Password Enter the password for the domain account that logs in and starts services.

Re-enter password Re‐enter your password to confirm correct entry.



• Bypass traverse checking

• Increase quotas

• Replace a process-level token

• Log on as a service

If you set up file shares in your Windows network for use by TM1 components, be sure that each local account that you set up to run a TM1 service has access to those shares.

NOTE: If you install on a machine that does not participate in a Windows domain, you cannot use Integrated Login.

Using Local Machine Syntax

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

Installing TM1 2-11


Security Settings

You can select one of three authentication modes for TM1.

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.

LDAP Authentication

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

LDAP Port

The port on which the LDAP server is running. If a port is not specified, 389 (the standard LDAP default) is used.

LDAP Host

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.

LDAP Search Base

Installing TM1 2-13


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

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.



by modifying appropriate parameters in the Tm1s.cfg file. The two Integrated Login modes are described below.

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

Changing Security Parameters

Once you have installed and set your TM1 authentication mode, you cannot modify it using the TM1 Installation Wizard. You must completely uninstall and then reinstall TM1.

For further information about TM1 login authentication modes, including details on server and client configuration parameters, see the TM1 Operations Guide.

mixed mode

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.

Installing TM1 2-15


Configuring the TM1 Server

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.



To install a TM1 server:

Choose Database

Select the database you want to install with the TM1 server. Click Apply after you select a database to set the server name and data directory path for the selected database.• To install the Planning Sample database, select Planning

Sample from the drop‐down and click Apply. This updates the Server Name with Planning Sample.

• To install the Sample database, select Sample Database then click Apply to update Server Name with SData.

• To create an empty data directory where you can install your own custom data, select Custom. Then enter the Server Name to use. Click Change Data Directory to indicate the location of the custom data directory. Click Apply to update the fields.

Server Name

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

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.

Installing TM1 2-17


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.

Change Data Directory

Click to change the data directory for the server you are installing.

Configure Another TM1 Server

Select this option to configure another TM1 server during this installation session.



Configuring TM1 Clients

Installing TM1 2-19


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.


The name of a computer on which a TM1 Admin Server is installed. When a TM1 server is running, it registers itself on this Admin Server. TM1 clients connect to this Admin Server to obtain information about TM1 servers available on a network. This option is not offered during a Perspectives installation as the Admin Server always runs on the same machine as the TM1 Server and Client.

Disable Excel Edit in Cell Capability

The Disable Excel Edit in Cell option is selected by default as it prevents users from accidently overwriting formulas in slice worksheets. We recommend that this option remains selected.

Set TM1 to Autoload in Excel

Select this option to automatically load the TM1 add‐in (Tm1p.xla) when Excel starts. Clear this option to enable a user to manually launch TM1 after Excel starts.



Begin the Installation

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

Post-Installation Tasks

Once the installation is complete, a confirmation screen displays. Now you can perform the following tasks:

• Start Services

• Starting a TM1 Server Installed as a Service or Application

Use Integrated Login

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.

Installing TM1 2-21


Start Services

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

Starting a TM1 Server Installed as a Service or Application

To start a TM1 server that has been installed as a service:

1. Double‐click the Windows Services icon from the Start Programs → Control Panel → Administrative Tasks menu.

A list of installed services displays.

Service Description

TM1 Admin Server Service that manages the TM1 servers

TM1 Excel Service 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.

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


Standard TM1 Installation Table of Contents | Index

2. Select the entry for the TM1 server you want to start, for example TM1 Server - Planning Sample, and click the Start button.

An Admin Server must be running before a TM1 server can start. If you have specified an Admin Host in the Tm1s.cfg file, the TM1 server will attempt to connect to an Admin Server on that host. The TM1 server will fail to start if it is unable to connect to an Admin Server for any reason.

If you have not specified an Admin Host, the TM1 server attempts to connect to an Admin Server on the local machine. If an Admin Server is not currently running on the local machine, either as a service or an application, the TM1 server starts a new Admin Server application and connects to it.

To start a remote server that has been set up as a Windows application, double‐click the shortcut icon for the server you want to start.

Standard TM1 Installation

A Standard TM1 installation installs the following components:


Description

Manuals Yes TM1 Documentation Library

Clients Yes TM1 Perspectives

Developer’s

Installing TM1 2-23


A Standard TM1 installation uses the following default values:

Environment YesYesYesYes

TM1 APITM1 Java APITM1 .NET APISSL

Servers YesYes

TM1 Admin ServerTM1 Server (local)

Item Default Value

Admin Server port # 5495 (unsecured)

SSL port # 5498 (secured)

TM1 server port # 12345

TM1 Client Message port number

12356

TM1 server name SData

Admin Server host name Same as computer on which the installation is run.


Description



Sample data directory for TM1 server

C:\Program Files\IBM Cognos\TM1\Custom\TM1Data\PlanSamp

Sample data directory for TM1 Perspectives/TM1 Architect

C:\Program Files\IBM Cognos\TM1\Custom\TM1Data\Pdata

Security mode A Standard installation uses TM1 Authentication. Users must respond to a prompt for a user name and password when they login to TM1 components. A Custom installation gives you the option of using Integrated Login, which allows TM1 users to automatically login to TM1 components using their Windows login user name and password, or LDAP Authentication.

Disable Excel’s Edit Directly in Cell

Selected

Installing TM1 2-25




3 Installing TM1 Perspectives

This chapter describes how to install TM1 Perspectives, the TM1 Excel Add‐in, using the Standard or Custom installation. Topics include:

• Custom TM1 Perspectives Installation

‐ Configuring TM1 Perspectives

• Standard TM1 Perspectives Installation

To install TM1 Perspectives:


2. Select TM1 Perspectives and click Next.

3. Choose Standard or Custom installation.

Custom TM1 Perspectives Installation

Use the Custom TM1 Perspectives installation to select which TM1 components to install, and to configure Perspectives settings. See “Standard TM1 Perspectives Installation” 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.

Installing TM1 Perspectives 3-1

Custom TM1 Perspectives Installation Table of Contents | Index

The following components are available as part of a TM1 Perspectives Custom installation. Click on a component for a detailed description.


Description


Clients NoYes

TM1 ClientTM1 Perspectives


Custom TM1 Perspectives Installation Table of Contents | Index

Configuring TM1 Perspectives

When you install TM1 Perspectives you must specify values for the following parameters on the TM1 Client Configuration screen. These values are written to the Tm1p.ini file.

Developer’s

Environment NoYesYesYes

TM1 ArchitectTM1 APITM1Java APITM1 .NET API

Servers NoNoNoNo

TM1 Admin ServerTM1 ServerTM1 Web ComponentsTM1 Top





Description


Standard TM1 Perspectives Installation Table of Contents | Index

Standard TM1 Perspectives Installation

A Standard Perspectives installation installs the following components. For a brief description of all components, click on the component name.

A Standard installation uses the following default values:


Description


Clients Yes TM1 Perspectives

Developer’s


TM1 APITM1 Java APITM1 .NET APISSL

Servers YesYes

TM1 Admin ServerTM1 server (local) port #

Item Default Value





TM1 server (local) port # 12345


Sample data directory for TM1 Perspectives


Disable Excel’s Edit Directly in Cell option

Selected.





4 Installing TM1 Web

TM1 Web includes all components of TM1, plus additional functionality to browse and update TM1 data using a standard web browser.

This chapter describes how to install TM1 Web on a network using either the Standard or Custom installation options. Topics include:

• Custom TM1 Web Installation

‐ Configuring TM1 Web Components

‐ Configuring TCP/IP Ports for TM1 Web

‐ Username and Password for TM1 Services

‐ Security Settings

‐ Configuring the TM1 Server

‐ Configuring Web Components

• Standard TM1 Web Installation


2. Select TM1 Web and click Next.

3. Choose Standard or Custom installation.

Installing TM1 Web 4-1

Custom TM1 Web Installation Table of Contents | Index

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

Configuring TM1 Web Components



The following components are available for a TM1 Web Custom installation:

Configuring TCP/IP Ports for TM1 Web

Specify the TCP/IP port number for the following components:


Description


Clients YesYes

TM1 ClientTM1 Perspectives

Developer’s


TM1 ArchitectTM1 APITM1 Java APITM1 .NET API

Servers YesYesYesYes

TM1 Admin ServerTM1 ServerTM1 Web ComponentsTM1 Top


TM1 SSL Admin server Port #



Username and Password for TM1 Services

See “Username and Password for TM1 Services” for details.

If you install TM1 in a distributed environment, where some components reside on one machine and some components on another, you must enter the same user name and password each time you run the installation. See also “Installing TM1 on Networks without Domains.”

Security Settings




Once you’ve installed you cannot change your TM1 authentication mode by re‐running the Installation Wizard. See “Changing Security Parameters” for more information. See also the 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.


Integrated Login

TM1 Authentication

LDAP Authentication LDAP Host LDAP Search Base

LDAP Port LDAP Search Field

Choose Database

Server Name


Port Number



See “Configuring the TM1 Server” for information on loading sample databases.

Configuring TM1 Clients

When you install one or more TM1 clients you must specify values for the following client parameters. These parameters are written to the Tm1p.ini file.



Admin Server Host Name






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\. To install to a different directory, click Change and navigate to the new directory.


Standard TM1 Web Installation Table of Contents | Index

NOTE: The Windows permissions on the directory into which you install the Web components must be set to “Everyone.” If the Windows permissions on this directory are restricted, the TM1 Web client may not be accessible to all users.

When you install TM1 Web, TM1 installs Dundas Charts © technology. Dundas Charts © provides the charting functionality of TM1 Web. Dundas Charts © technology is delivered through two DLLs that are installed on your IIS web server:

• C:\Inetpub\wwwroot\TM1Web\bin\DundasWebChart.dll

• C:\Inetpub\wwwroot\TM1Web\DundasWinChart\DundasWinChart.dll

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

Standard TM1 Web Installation

A Standard TM1 Web installation installs the following components.


Description


Clients YesYesYes

TM1 ClientTM1 PerspectivesTM1 OLE DB Provider



A Standard TM1 Web installation uses the following default values:

Developer’s

Environment Yes TM1 ArchitectTM1 APITM1 Java APITM1 .NET APISSL

Servers YesYesYes

Yes

TM1 Admin ServerTM1 Server (local)TM1 Web Components (ASP script files and TM1ExcelService.exe)TM1 Top

Item Default Value






Description







C:\Program Files\IBM Cognos\TM1Custom\TM1Data\Pdata

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


Selected.



5 Installing TM1 for 64-bit Windows

This chapter describes how to install TM1 for 64‐bit Windows using either the Standard or Custom installation options. Topics include:

• Custom 64‐bit TM1 Installation

‐ Configuring TCP/IP Ports for 64‐bit TM1

‐ Username and Password

‐ Security Settings

‐ Configuring the 64‐bit TM1 Server

NOTE: To install TM1 x86 (32‐bit) components on a 64‐bit Windows system, you must use the TM1 x86 Installation Wizard. The TM1 x86 Installation Wizard includes 32‐bit versions of the TM1 Admin Server, TM1 Server, TM1 Clients, and other TM1 components such as the TM1 Top utility and the TM1 .NET API.

For details see “Installing TM1 x86 on a x64 Windows System.”

After you have answered the introductory prompts (see “Starting the Installation Wizard”) choose Standard or Custom installation.

Installing TM1 for 64-bit Windows 5-1

Custom 64-bit TM1 Installation Table of Contents | Index

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:

Configuring TCP/IP Ports for 64-bit TM1

Specify the TCP/IP port numbers for the following programs:

Username and Password

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


Component


Servers YesYes

TM1 Admin ServerTM1 Server


TM1 SSL Admin server Port #



Security Settings


Once you’ve installed you cannot change your TM1 authentication mode by re‐running the Installation Wizard. See “Changing Security Parameters” for more information. See also the TM1 Operations Guide.

Configuring the 64-bit TM1 Server

When you install a TM1 server you must specify values for the following server parameters. These values are written to the Tm1p,ini file, which resides in the TM1 data directory. To distinguish x64 sample databases from x86 databases of the same name which may have been installed, the sample 64‐bit database names have x64 appended to them. The default path of the TM1 data directory on a 64‐bit Windows system is C:\Program Files\IBM Cognos\TM1\Custom \TM1Data\PlanSamp.

Integrated Login

TM1 Authentication

LDAP Authentication LDAP Host LDAP Search Base

LDAP Port LDAP Search Field




When you configure the TurboIntegrator, enter these values:

Choose Database

Server Name


Port Number


Configure TurboIntegrator to Use the ODBC Gateway


Gateway Host

Username

Password


Standard 64-bit Installation Table of Contents | Index

Standard 64-bit Installation

A Standard 64‐bit installation installs the following components:

A Standard TM1 installation uses the following default values:


Description


Servers YesYes

TM1 Admin ServerTM1 Server (local)

Item Default Value









Standard 64-bit Installation Table of Contents | Index



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


Selected.



6 Installing TM1 x86 on a x64 Windows System

This chapter describes how to install both the x86 and x64 versions of TM1 on a single, 64‐bit Windows system, such as Windows Server 2003 x64 or Windows XP Professional x64. Topics include:

• The 64‐bit Application Space

• Importance of Installation Order

• Location of Installed TM1 Program Files

• Naming Conventions for x86 and x64 TM1 Services

• Installing TM1 x86 in Windows x64

• Running the TM1 Database with Both x86 and x64 TM1 Servers

• Running TM1 Web x86 on Windows x64

NOTE: Windows XP Professional x64 is not a server class operating system and is not a recommended platform for a TM1 production environment. However, in some situations, it may be used as an individual x64 development environment for TM1.

After you have answered the introductory prompts (see “Starting the Installation Wizard”) choose Standard or Custom installation.

Installing TM1 x86 on a x64 Windows System 6-1


The 64-bit Application Space

The following components can be installed and run in the Windows 64‐bit application space:

• TM1 64‐bit Admin Server

• TM1 64‐bit server

• TM1 64‐bit client applications

WOW64 (32-bit) Application Space

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

Installation Notes about TM1 Components

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

TM1 Admin Server You can install both the x86 and x64 versions of the TM1 Admin Server, but only one of them can be active. For details, see “Importance of Installation Order.”

TM1 Server You can install and run multiple copies of both the x86 and x64 versions of the TM1 server on the same machine. The only exception is that each server has to be configured to a unique port number. For details, see “Running the TM1 Database with Both x86 and x64 TM1 Servers.”



Importance of Installation Order

The order in which you install x86 and x64 versions of TM1 determines which TM1 Admin Server will take precedence:

• Both TM1 Admin Servers are installed as a Windows service and their active or non‐active status is configured automatically during installation.

• The Admin Server which is installed first (x86 or x64) takes precedence. Any TM1 servers associated with this system will depend on the first installed Admin Server.

• An Admin Server from a second installation can be installed, but it will not be active. The TM1 servers will still depend on the first Admin Server.

• If the installation of the first Admin Server is removed, then the second TM1 Admin Server becomes active and supports the TM1 servers.

The active/non‐active status of a TM1 Admin Server is determined by its Startup Type setting in Windows Services:

• The active Admin Server has its service Startup Type set to Automatic.

• The non‐active Admin Server has its service Startup Type set to Disabled.

TM1 Clients There are currently no 64‐bit TM1 client applications available.

TM1 Top utility and TM1 .NET API

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



For example, if you install TM1 x64 first and install TM1 x86 second, the x64 Admin Server is set to Automatic and the x86 version will be Disabled in Windows Services.

If you then uninstall TM1 x64, the dependencies for all the related TM1 servers are automatically redirected to the remaining x86 Admin Server.

Location of Installed TM1 Program Files

When you install applications on a x64 Windows system, the program files for 32‐bit and 64‐bit applications are installed into different directories as follows:

• 64‐bit applications are installed to C:\Program Files

• 32‐bit applications are installed to C:\Program Files(x86)

For example, if you select the default installation location when you install both versions of TM1, the TM1 program files are installed in the following directories:

• TM1 x64 default directory: C:\Program Files\IBM Cognos\TM1

• TM1 x86 default directory: C:\Program Files(x86)\IBM Cognos\TM1



Naming Conventions for x86 and x64 TM1 Services

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

Installing TM1 x86 in Windows x64

No special steps are required to install the x86, 32‐bit version of TM1 in a Windows x64 environment. The 64‐bit Windows system detects that the program being installed is a 32‐bit application and automatically installs it into the WOW64 space.

TM1 Component Windows Service Name

TM1 x86 Admin Server TM1 Admin Server

TM1 x64 Admin Server TM1 Admin Server (x64)

TM1 x86 servers TM1 Server ‐ DatabaseNameWhere DatabaseName is the name of the database you selected during the installation.For example: TM1 Server ‐ Planning Sample.

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



Running the TM1 Database with Both x86 and x64 TM1 Servers

After you install any TM1 sample databases with the x86 and x64 versions of TM1, the port numbers for the databases are set to the same port by default. For example, if you want to run the Planning Sample database with both the x86 and x64 versions of TM1 server, you have to edit the port number in one of the Tm1s.cfg files to point to a different port number.

To edit the PortNumber parameter in the Tm1s.cfg file:

1. Locate the Tm1s.cfg file for the sample database that was installed with either the x86 or x64 TM1 version.

For example, if you installed both versions of TM1 to their default locations, then the Tm1s.cfg file for the Planning Sample database is located in the following directories:

For x86 TM1: C:\Program Files(x86)\IBM Cognos\TM1\Custom\TM1Data\PlanSampFor x64 TM1: C:\Program Files\IBM Cognos\TM1\Custom\TM1Data\PlanSamp

2. Open the Tm1s.cfg file with a text editor, such as Windows Notepad.

3. Locate the line of code where the PortNumber parameter is set, as shown below, and change the value to a another valid port number.

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.



Running TM1 Web x86 on Windows x64

To run TM1 Web x86 on a Windows x64 system, you must run Microsoft Internet Information Services (IIS) in 32‐bit mode and configure IIS to run the 32‐bit version of Microsoft ASP.NET 3.0.





7 Installing TM1 on UNIX

This chapter describes how to install TM1 on UNIX.

Topics include:

• Pre‐Installation Tasks

• Starting the Installation Wizard

• After You Complete the Installation

• S89Applix Startup Script

• Uninstalling UNIX TM1

• Silent UNIX Installation

• Console Installation

• Starting a UNIX TM1 Server

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 S89Cognos to the /etc/rs2.d directory (Solaris) or the /sbin/rc3.d/ directory (HP/UX).

Installing TM1 on UNIX 7-1

Pre-Installation Tasks Table of Contents | Index

Additionally, the following requirements must be met to support the graphical user interface of the installation program:

• You must have X server software installed on the machine that will host your TM1 components.

• You must have X server client software installed on the machine from which you run the TM1 Installation Wizard.

• Your UNIX account must be able to create an X‐Windows connection. On many systems, you control this through the utility XHOST.

TM1 does provide a silent server installation and a console installation that do not require an X windows system.

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 TM1 Users Guide and the 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 “TM1 System Architecture” of the TM1 Operations Guide for details on how to design the optimal TM1 environment.


Pre-Installation Tasks Table of Contents | Index

Determine your hardware and software requirements.

Refer to the TM1 platform matrix available on the Cognos Global Customer Services Web site (http://support.cognos.com) 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.

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. In the case of a TM1 server, messages from the server display in the language you choose.




UNIX Compatible Components

Some TM1 components run only on Windows, so your TM1 system will be running in a heterogeneous environment. The following table shows each TM1 component and the operating system on which that component is supported.

See also “Installing Components on Different Machines.”

Starting the Installation Wizard

Before you start the Installation Wizard, be sure to read “Pre‐Installation Tasks,” which lists account requirements that you must fulfill to successfully install this software.

To start the Installation Wizard:

1. Change directories to your CDROM directory, for example,

cd /cdrom

2. Start the Installation Wizard by entering:

./setup.bin

Supported on UNIX and Windows Supported only on Windows

TM1 ServerTM1 Admin ServerODBC Gateway

TM1 ArchitectTM1 ClientTM1 PerspectivesTM1 Web clientTM1 Web server components



The TM1 Installation Wizard starts.

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.

Installation Location

To change the default installation directory click the Browse button and navigate to the new directory location. To accept the default location, click Next.

TM1 UNIX Components

The Component Selection screen displays.

Select the components that you want to include in this installation:


Description


Servers



Yes ODBC GatewayProvides ODBC connectivity in UNIX environments via the axnet service.axnet is a server process that launches an ODBC gateway as requested by the TM1 server.axnet starts during the operating system’s start‐up routine, on TCP/IP socket port #5492 by default. axnet is described in detail in the TM1 Operations Guide.


Description



Yes TM1 ServerThe 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 ServerA 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.


Description



Configuring TCP/IP Ports in UNIX

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

TCP/IP port for ODBC GatewayTCP/IP port for TM1 Admin Server SSL

Oracle DataSource Configuration

To configure Oracle ODBC datasources for use with TM1 and TurboIntegrator, enter the following information:

You can create up to three Oracle datasources for use with TM1 and TurboIntegrator. If you want to configure another datasource, select the Create

Datasource Name Name of a datasource configured on the machine that will host the ODBC gateways.

Oracle Service Name Name of the Oracle instance into which you want to log in. The name you enter must exist in the file TNSNames.ora.

Database Username Oracle database user name.

Database Password Password for the Oracle database user name.

Location of Oracle Client Files

Path name of the location of the Oracle client files. You can enter an absolute path name or click Browse and navigate to the location.



Another Oracle Datasource option. When you click Next, the Oracle Datasource Configuration screen displays again, so you can specify the parameters for the next datasource.

TM1 Server Configuration

Enter the following information to configure your TM1 server:

Setting Up a TM1 Administrative Account

Enter the Administrative Username and Password of a TM1 user that will have administrator privileges to your TM1 database. The default TM1 administrator is admin. The default administrator password is apple.

This information is especially important if you install TM1 against an existing TM1 database, where you may have established an administration account other than the TM1 default. In this case, you must specify the correct username and password for a TM1 administrator in the existing database. TurboIntegrator needs this information to run properly.

Server Name

TM1 Server TCP/IP Port

Admin Host Machine Name

Do you want to install the sample data?

Path to TM1 Database (Sample data or Existing Database)

If you check Do you want to install sample data, by default the sample database called Planning Sample is installed. If you clear this check box, a blank custom data directory is created.



Note that this does not add or modify any user names in your TM1 database. The information you enter here is written to a configuration file, and is used by TurboIntegrator.

To configure Turbointegrator, specify the following ODBC parameters:

Installation Summary

The installation summary provides the following information:

Configure TurboIntegrator to use ODBC Gateway

The ODBC gateway is a 32‐bit gateway that establishes ODBC connections used by TurboIntegrator option. If you select this option, the Installation Wizard prompts you to specify ODBC Gateway parameters when you click Next.

Install another TM1 Server? Select this option to configure another TM1 server during this installation session.

ODBC Host The name of the computer on which your ODBC gateway is installed.

System Username

A system login user name. This can be a UNIX user name or a name in your Windows domain, depending on what kind of machine is hosting your ODBC gateway.

System Password

A password corresponding to the system user name.


After You Complete the Installation Table of Contents | Index

• The directory for your TM1 installation.

• The TM1 components you are installing.

• The amount of disk space your installed components require.

Click Next to install TM1.

After You Complete the Installation

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

S89Applix Startup Script

As part of a Solaris installation, the TM1 creates the /etc/rc2.d/S89Applix script, which runs every time you boot your UNIX machine. This script starts

Task For more information see

Login to ensure proper connectivity. You should log in to TM1 through TM1 Architect.

TM1 Users Guide

Choose an authentication model. TM1 Operations Guide

Set up TM1 security. TM1 Operations Guide

Start TM1. “Starting a UNIX TM1 Server”


Uninstalling UNIX TM1 Table of Contents | Index

the axnet server process that launches ODBC gateways as requested by the Application Server service, as well as the TM1 server and the TM1 Admin Server.

On an HP/UX installation, the S89Applix script is created in the directory:

/sbin/rc3.d/

Uninstalling UNIX TM1

You can uninstall TM1 by running the axuninstall script, which resides in your TM1 installation directory.

To uninstall TM1, follow these steps:

1. Change directories to the <TM1_Install> directory. This is the directory where your software is installed. For example, /software/TM190.

2. Run axuninstall in the installation directory by issuing the command

./axuninstall

The TM1 Uninstaller displays.

3. Select a language for the uninstaller program and click Next.

4. Click Next on the first screen of the uninstaller.

5. Click Next on the screen that displays the components of your TM1 installa‐tion.

The Uninstaller asks you if you want to remove the S89Cognos script. This script starts the TM1 services when your server reboots. If you have customized the S89Cognos script, you may want to save this file.


Silent UNIX Installation Table of Contents | Index

6. Click Yes to delete the S89Cognos script. Click No to retain the script.

7. Click Finish after the uninstaller has removed TM1 from your system.

The Uninstaller:

• stops all TM1 services

• removes TM1 components

• removes the S89Cognos file, if you selected this option.

• removes all lines referring to TM1 software in the /etc/Services file

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

To run a silent UNIX TM1 server installation, enter the following line at a command prompt:

<path_to_directory_containing_TM1_setup.bin_executable>./setup.bin -silent

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

Install directory /opt/IBM Cognos/TM1

Components TM1 Server, Admin Server


Console Installation Table of Contents | Index

Console Installation

To run a console UNIX TM1 server installation, enter the following line at a command prompt:

<path_to_directory_containing_TM1_setup.bin_executable>./setup.bin -console

You will be prompted to enter server parameter values required to install and run the TM1 server.

Starting a UNIX TM1 Server

To assist you in starting a UNIX TM1 server, a sample script named Tm1s_start_example is installed in the <TM1_install>/bin directory. With a few minor modifications, you can use this sample script to start your UNIX TM1

Server Name Planning Sample

Server TCP/IP port 12345

Admin Host (blank, defaults to machine where TM1 server is running)

Path to TM1 Database /opt/IBM Cognos/TM1/Custom/TM1Data/PlanSamp

Administrative username Admin

Administrative password (blank)


Starting a UNIX TM1 Server Table of Contents | Index

server. When you use the script to start a server, TM1 uses the Tm1s.cfg file in the specified data directory to govern the behavior of the server.

To modify tm1s_start_example:

1. Open the file in a text editor.

2. Set the tm1_path parameter to the directory containing the tm1s.exe server executable file. In most circumstances, this directory is <TM1_install>/bin.

3. Set the tm1_data_path parameter to your server data directory.

4. Set the TM1_PATH parameter to directory containing the tm1s.exe server executable file. In most circumstances, this directory is <TM1_install>/bin.

NOTE: You must set both tm1_path and TM1_PATH to the same directory.

5. Save the script.

You can save to a new file name if desired. If you have installed multiple TM1 servers, you should create server‐specific scripts with unique file names for each server.

6. Run ./tm1s_start_example (or the new file name) to start your TM1 server.

Running the UNIX TM1 Server in Background Mode

The TM1 Installation Wizard adds the following parameter to the Tm1s.cfg file:

RunningInBackground=T

When you run the TM1 server in background mode, you must use tm1srvstop.exe to shut down the server. For details, see “Shutting Down a Remote Server” in the TM1 Operations Guide.


Starting a UNIX TM1 Server Table of Contents | Index



8 Installing TM1 Workflow

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

The following topics are described in this chapter:

• Workflow Prerequisites

• Running the Workflow Installation Wizard

• Installing Workflow for the First Time

• Upgrading to Workflow from Planning Manager 1.3

• Configuring Workflow for Excel

• Using Workflow with TM1 Web

Installing TM1 Workflow 8-1

Workflow Prerequisites Table of Contents | Index

Workflow Prerequisites

Before you install Workflow, you must have the following software installed and configured:

• IBM Cognos TM1 Server 9.4 or later.

• TM1 Client or TM1 Perspectives. (You do not need a TM1 Perspectives license on every client workstation. If users can run the TM1 Client, they can run Workflow.)

• If you want to run Workflow through TM1 Web, you must have TM1 Web installed.

• Each Workflow user must be running Excel 2003 or later

• If you are installing Workflow against an existing TM1 database:

‐ The existing TM1 database must have a dimension that holds the names of budget versions. Without an existing version dimension, you cannot run Workflow.

‐ You should back up the existing database and store the copy in a safe place before running the Workflow installation.

Licensing

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

• TM1 Server

• TurboIntegrator

• TM1 Workflow


Running the Workflow Installation Wizard Table of Contents | Index

Running the Workflow Installation Wizard

You can use the TM1 Workflow Installation Wizard to:

• Install Workflow for the first time

• Upgrade Planning Manager 1.3 to Workflow

NOTE: If you are upgrading from Planning Manager 1.2 or older, you must first upgrade to Planning Manager 1.3. For more details, visit the IBM Cognos Global Customer Services Web site (http://support.cognos.com) or contact your local IBM Cognos Support office. Contact information can be found at http://support.cognos.com/en/support/about/contact.html.

To begin installing Workflow:

1. Run the Workflow setup.exe file on the Workflow installation CD or from the Workflow installation package that you downloaded.

The Workflow Installation Wizard runs and displays the Welcome screen.

2. Click Next at the Welcome screen.

The License Agreement screen appears.

3. Accept the license agreement and click Next.

The Custom Setup screen appears.



Use the Custom Setup screen to select the Workflow components that you want to install, depending on your specific installation scenario. For details, see the following sections:

Selecting Workflow Installation Components

Installing Workflow for the First Time

Upgrading to Workflow from Planning Manager 1.3

4. Click Next.



If you selected the Excel Addin option on the Custom Setup screen, the Excel Addin screen appears.

The following Excel Addin options are available:

• Add the Addin to the list of available Addins in Microsoft Excel – This option makes Workflow appear in the Add-Ins dialog box that appears when you select Tools > Add-Ins in Excel.

• Automatically load the Workflow Addin when Microsoft Excel starts – This option starts and displays the Workflow toolbar when you start Excel.



5. Click Next.

The Ready to Install the Program screen appears.

6. Click Install to complete the installation.


Selecting Workflow Installation Components Table of Contents | Index

Selecting Workflow Installation Components

Use the Custom Setup screen to select the Workflow components that you want to install, depending on your specific installation scenario.

You can control whether a component is installed or not as follows:

• Choose to enable the installation of the selected component.



• Choose to disable the installation of the selected component.

Workflow Components

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

Component Description

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



Destination Folder for Workflow Components

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

To change the destination folder for a component:

1. Select the component on the Custom Setup screen of the Workflow installa‐tion.

2. Click Change.

Planning Manager Upgrade

Includes the Workflow upgrade files if you are upgrading from Planning Manager 1.3Default installation location is:C:\Program Files\Cognos\TM1\Custom\TM1Data\TM1 Planning Manager V2 Upgrade\

Excel Addin Enables the Workflow toolbar and functionality in Excel.Default installation location is:C:\Program Files\Cognos\TM1\bin\

Component Description



The Change Current Destination Folder dialog appears.

3. Select a new destination folder.

4. Click OK to return to the installation wizard.

5. Repeat these steps to change the destination folder for any other Workflow component.


Installing Workflow for the First Time Table of Contents | Index

Installing Workflow for the First Time

To install a new instance of Workflow on a system with no previous installation of Workflow:

1. Run the Workflow installation and advance to the Custom Setup screen.

2. On the Custom Setup screen, use the default component selection to install only the following components:

• Web Server Component

• Database Components

• Excel Addin

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

NOTE: When installing against an existing budget database, the database must contain budgeting and planning data and have an existing version dimension. Workflow requires this dimension to store its budget version names.

Installing Workflow for One Existing TM1 Database

• To install Workflow into an existing TM1 database, select Database Components and change the Destination Folder to the data directory of the TM1 server that you want to use with Workflow.


Installing Workflow for the First Time Table of Contents | Index

WARNING: Make sure the existing database has not been used with Workflow or you will over‐write previous Workflow files.

Installing Workflow for Multiple TM1 Databases

• To apply Workflow to multiple TM1 databases, install the TM1 Database PM Components to the default destination folder or to another empty folder.

After the installation, you can then manually copy the database component files into the other TM1 data directories that you want to use with Workflow.

4. On the Custom Setup screen, click Next and complete the installation.

5. Restart any of the TM1 servers where you installed Workflow to allow the Workflow options to be loaded.

NOTE: You also need to enable the Workflow option in the server license for each TM1 server that will use Workflow.


Upgrading to Workflow from Planning Manager 1.3 Table of Contents | Index

Upgrading to Workflow from Planning Manager 1.3

To upgrade an existing installation of Planning Manager version 1.3:

1. Back up your existing Planning Manager database and store the copy in a safe place before running the new Workflow installation.

2. Uninstall the previous version of Planning Manager using the Add or Remove Programs feature in the Windows Control Panel.

3. Run the Workflow installation and advance to the Custom Setup screen.

4. On the Custom Setup screen, select the following components to install:

• Web Server Component

• Database Components

• Planning Manager Upgrade

• Excel Addin

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


Upgrading to Workflow from Planning Manager 1.3 Table of Contents | Index

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.

6. On the Custom Setup screen, click Next and complete the installation.

7. Re‐start the TM1 server.

8. Open TM1 Architect or Server Explorer and log in to the server.

9. Run the TI process, sm_upgrade_v2.pro, to upgrade the database.

Log in and run this process on other TM1 servers that require upgrading.


Configuring Workflow for Excel Table of Contents | Index

Configuring Workflow for Excel

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

• Excel Components on the Custom Setup screen

• Workflow Excel Addin options

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



Troubleshooting the Workflow Excel Add-in

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

1. Unload the Workflow add‐in by choosing Tools → Add-ins from the Excel menu and unselecting the TM1Workflow entry.

Workflow toolbar



2. Click OK and close Excel.

3. Restart Excel and make sure that the TM1 Perspectives add‐in loads prop‐erly.

4. Choose Tools → Add-ins from the Excel menu.

5. Reload the Workflow add‐in by clicking Browse and manually selecting the Workflow add‐in, TM1 Planning Manager.xla, located in the <TM1 install directory>\bin directory.


Using Workflow with TM1 Web Table of Contents | Index

Using Workflow with TM1 Web

You can run Workflow as an application in TM1 Web. All of the user functions described in “The Workflow Toolbar” chapter in the TM1 Workflow Administrator’s Guide are available through the TM1 Web.

Workflow On The Web

Workflow in TM1 Web is enabled by editing several parameters in the Web.config file that governs your TM1 Web installation. The Workflow installation automatically installs these parameters into the TM1 Web Web.config file. A full description of these parameters and an explantion of the Web.config file can be found in the “Administering TM1 Web” chapter of the TM1 Operations Guide.

The Workflow toolbar appears the next time you log in to TM1 Web.

Workflow toolbar in TM1 Web



Workflow Features in TM1 Web

Many of the user features of Workflow are available from TM1 Web. For example, if you choose a task, the worksheet mapped to that task appears in TM1 Web. After working on the task, you should be able to use the toolbar to submit the task.

For a complete description of these features, see the chapter, “Using The Workflow Toolbar”, in the TM1 Workflow Administrator’s Guide.

NOTE: The Workflow administration console is not supported through TM1 Web. Administration functions for Workflow, such as setting up mapping and security for Workflow tasks, must be done through Excel.





9 Installing TM1 Viewer Portlets for 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.

Install the TM1 Viewer Portlets

Install the TM1 Viewer Portlets by using the installation wizard that is provided on the CD containing the main TM1 installer.

You must install the TM1 Viewer Portlets in the same directory as the Gateway component for IBM Cognos 8, on a computer that is running a supported Windows server. In addition, the TM1 Web server must be on the same computer.

Steps

1. Stop the IBM Cognos 8 service.

2. Insert the TM1 Viewer Portlets installation CD.

Installing TM1 Viewer Portlets for Cognos 8 Portal Services 9-1

Configure Access to IBM Cognos 8 From the TM1 Viewer Portlets Table of Contents | Index

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 Cog‐nos 8 Gateway component is installed and click Next.

You are prompted for the location of a directory in which to store backup copies of the files that will be overwritten.

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.


Logon Requested or Authentication Error When Accessing a TM1 Viewer Portlet Table of Contents | Index

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

For example,

<url>http://TM1Webserver/TM1Web/TM1WebLogin.aspx</url>

where TM1Webserver is the name of the computer where TM1 Web is running.

Tip: Open your TM1 Web application in a browser, and then copy the text in the address line before the ʹ?ʹ character.

3. Add more URL specifications until you have listed every server that is run‐ning TM1 Web.

4. Save the file.

Logon Requested or Authentication Error When Accessing a TM1 Viewer Portlet

When you try to open a TM1 Viewer Portlet, you are prompted for your logon credentials or you receive an authentication error.

The URL values in the variables_TM1.xml file may be incorrect. To resolve the situation, replace the incorrect URL values.

Steps

1. In TM1 Web, open the TM1 websheet that you were trying to access.

Installing TM1 Viewer Portlets for Cognos 8 Portal Services 9-3

Uninstall the TM1 Viewer Portlets Table of Contents | Index

2. Copy the text in the address line before the ’?’ character.

3. In the c8_location\templates\ps\portal directory, open the variables_TM1.xml file in a text editor.

4. Find the line that has the incorrect URL value, select everything between <url> and </url>, and paste the text that you copied from the TM1 websheet.

5. 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 Cog-nos 8, Uninstall IBM Cognos 8.

2. On the Uninstall Language Selection page. select the language for the unin‐stallation 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.



10 Maintaining and Upgrading Your TM1 Installation

This chapter describes tasks you should perform after you install TM1. It also provides information about upgrading to a newer version of TM1.

After successfully installing TM1, you can return to the TM1 Installation Wizard to perform various tasks. Topics include:

• Maintaining TM1 Components

‐ Repair the TM1 Installation

‐ Remove TM1

• Upgrading TM1

Maintaining TM1 Components

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

Maintaining and Upgrading Your TM1 Installation 10-1

Maintaining TM1 Components Table of Contents | Index

You can use these options to Modify, Repair, or Remove the TM1 installation.

Modify Components

To modify your current installation; remove or add components, or change installation parameters:

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

If autorun is enabled on your CD drive, the TM1 Installation Wizard displays. If autorun is not enabled, run setup.exe in the installation CD root directory to start the TM1 Installation Wizard.

2. Click Next.

3. Select Modify on the Program Maintenance screen and click Next.

4. Select the TM1 installation package you want to modify.

5. Select the Custom installation type and click Next.


Maintaining TM1 Components Table of Contents | Index

The Component Selection screen displays, showing the current state of your TM1 installation. Items currently installed display with a disk drive icon next to the component name. Items not currently installed display with an X next to the name.

Program maintenance does not include changing the location of the TM1 installation directory. To change the location of the installation directory, remove all TM1 files and reinstall TM1 in another location.

6. Click Finish to complete the modifications.

Repair the TM1 Installation

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

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

If autorun is enabled on your CD drive, the TM1 Installation Wizard displays. If autorun is not enabled, run setup.exe in the installation CD root directory to start the TM1 Installation Wizard.

2. Click Next.

3. Select Repair on the Program Maintenance screen.

4. Click Next and answer all subsequent prompts to complete the repair pro‐cess.

The installation program reinstalls your current configuration. It fixes missing or corrupt files, program groups, shortcuts, and registry entries.


Upgrading TM1 Table of Contents | Index

Remove TM1

To uninstall all components of TM1, follow these steps:

1. Create a backup copy of your custom data by coping the contents of the <TM1_Home>\Custom\ directory to a safe place on your hard disk. This directory contains TM1 configuration files that will be re‐generated by the TM1 installation.

2. Delete the <TM1_Home>\custom\ directory.

3. From the Control Panel on your computer, choose Add/Remove Pro-grams.

4. In the list of currently installed programs, select IBM Cognos TM1.

Upgrading TM1

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

Backing Up Your TM1 Data

If you are currently using any previous version of TM1, you must backup your TM1 data directory and configuration files before running the TM1 Installation Wizard for TM1 9.4.

• Save a copy of your existing <TM1_Install>\Custom\ data directory and sub‐directories to a secure location.



• Save a copy of any TM1 configuration files you may want to retain, such as the Tm1admsrv.ini file located in the <TM1_Install>\bin\ directory.

• If installing TM1 Web, backup any custom TM1 Web server pages to a secure location. The default location of the directory containing TM1 Web server pages is C:\inetpub\wwwroot\TM1Web.

Restoring Your TM1 Database

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

1. Copy your existing TM1 server data directory to the new <TM1_Install>\Custom\ that is available after you install TM1 9.4.

2. Restore your existing TM1 configuration files to the <TM1_Install>\bin\ directory.

3. Restore your existing custom TM1 Web server pages to the directory con‐taining TM1 Web server pages, usually C:\inetpub\wwwroot\TM1Web.





Index
Symbols+ plus sign 1-19.NET API 3-3, 4-3.username 2-11/etc/services 7-1
Numerics64‐bit Windows 5-1

x86 6-1

AActive Server Pages (ASP) 4-7Admin Host 2-7Admin Server 3-3, 4-3

Host Machine Name 5-564‐bit 5-4defined 2-17, 2-20TM1 Web 4-5

host name 2-24, 3-5, 4-10port # 2-24, 3-4, 4-9, 5-5

ASP.NET 4-7authentication 2-12

for user access to IBM Cognos 8 from TM1 ViewerPortlets 2-2

authentication errorTM1 Viewer Portlets 2-3

autoload 2-20

Bbackground mode 7-15

Cchange button 1-16Choose a Product to Install 1-14Choose Database 2-17, 4-5Clients

Configuration 2-20Perspectives 3-2TM1 2-3TM1 Web 4-3, 4-8

componentsexclude 1-19Perspectives 3-4TM1 2-3TM1 Web 4-2, 4-8

console installation 7-14conventions

documentation v

Index 1


copyright iicorrupted installation files 3-3

Ddefault values

Perspectives 3-4TM1 2-24, 5-5TM1 Web 4-9

Developer’s EnvironmentPerspectives 3-3TM1 2-4TM1 Web 4-3, 4-9

Disabled in Windows Services 6-4documentation conventions vdomains

account 1-11, 5-2installing without 2-10

Dundas Charts © 4-8

EEdit Directly in Cell 2-20Excel application

building 1-20–??exclude

components 1-19

HHP/UX 1-5, 7-1

IIIS web server 1-6installation

checklist 1-3checklist for UNIX 7-2console 7-14directory 1-16location screen 1-16options screen 1-15order in 64‐bit 6-3silent 7-13troubleshooting 1-17Wizard 1-12

installation prerequisites 1-2installing

TM1 Viewer Portlets 2-1Integrated Login 2-12, 2-14, 2-15, 2-21

TM1 Web 4-5

Llanguage 1-11LDAP

authentication 2-13host 2-13port 2-13search base 2-13search field 2-14

License Agreement 1-13, 7-5local machine syntax 2-11

2 TM1 Installation


locale setting 1-11logging in to TM1 Viewer Portlets

authentication error 2-3

Mmanuals 3-2, 4-3, 4-8, 5-2Microsoft Excel 2000 1-2mixed mode 2-14

Nnaming conventions

x86 and x64 6-5

OODBC Gateway 1-10Oracle 1-3, 7-3

Ppassword 2-9permissions 4-8Perspectives 3-1

components list 3-2default values 3-4

Planning Sample Datax64 6-6

privilegesService Account 1-4

product information ii

Rregional setting 1-11repair installation 3-3ROOT 1-5

Ssample data directory 2-25, 3-5, 4-10, 5-5Search Base LDAP 2-13security

configuring user access to IBM Cognos 8 from TM1Viewer Portlets 2-2

mode 2-25, 4-10, 5-6settings TM1 Web 4-4

servername 4-5Perspectives 3-3, 4-3TM1 2-5, 5-2TM1 Web 4-5, 4-9UNIX 7-5

Service Account TM1 1-4setup.exe 1-11silent installation 7-13Solaris 1-5, 7-1SSL 2-8

port # 2-24, 4-9, 5-5startup

property 1-6type 6-3

subfeatures 1-19

Index 3


TTCP/IP port number 2-7, 4-3, 5-2TEMP 1-9TM1 2-20

Admin Server 1-10API 3-3, 4-3Architect 4-3authentication 2-13

TM1 Web 4-5Client 2-19, 3-3Client Configuration 2-20components list 2-23, 5-5default values 2-24, 5-5Java API 3-3, 4-3Perspectives 3-3Perspectives Client 3-2, 4-3Perspectives/Architect 5-6server 3-3, 3-5, 4-3, 4-9

configuration 4-5name 1-10, 2-24, 4-9, 5-5UNIX 7-14UNIX background mode 7-15

Service Account 1-4Top 2-6, 3-3, 4-3Web

default values 4-9x86 on a Windows x64 6-7

TM1 Client 1-2TM1 Perspectives 1-2

TM1 Viewer Portletsauthentication error 2-3installing 2-1uninstalling 2-4

TM1Install.log 1-9Tm1p.ini 3-3, 4-6Tm1p.xla 2-20Tm1s.cfg 4-5, 5-3, 6-6tm1s_start_example 7-14TurboIntegrator 5-4

Uuninstall 3-4uninstalling

TM1 Viewer Portlets 2-4UNIX 1-3, 7-1, 7-3, 7-14UNIX current version 3-8use integrated login 2-21username 2-9, 5-4

WWeb

components 3-3, 4-3, 4-8Windows

64‐bit application space 6-2permissions 4-8XP Professional 6-1

Workflowinstallation prerequisites 1-2

4 TM1 Installation


XXHOST 7-2

Index 5

Documents

TM1 Installation Guide