Professional Documents
Culture Documents
4 MR1
Product Information
This document applies to IBM Cognos TM1 Version 9.4 MR1 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).
Copyright
Copyright 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company. Portions of Cognos ULC software products are protected by one or more of the following U.S. Patents: 6,609,123 B1; 6,611,838 B1; 6,662,188 B1; 6,728,697 B2; 6,741,982 B2; 6,763,520 B1; 6,768,995 B2; 6,782,378 B2; 6,847,973 B2; 6,907,428 B2; 6,853,375 B2; 6,986,135 B2; 6,995,768 B2; 7,062,479 B2; 7,072,822 B2; 7,111,007 B2; 7,130,822 B1; 7,155,398 B2; 7,171,425 B2; 7,185,016 B1; 7,213,199 B2; 7,243,106 B2; 7,257,612 B2; 7,275,211 B2; 7,281,047 B2; 7,293,008 B2; 7,296,040 B2; 7,318,058 B2; 7,325,003 B2; 7,333,995 B2. Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others. While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to the information contained in this document will be documented in subsequent editions. U.S. Government Restricted Rights. The software and accompanying materials are provided with Restricted Rights. Use, duplication, or disclosure by the Government is subject to the restrictions in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer clause at DFARS 252.227-7013, or subparagraphs (C)(1) and (2) of the Commercial Computer Software - Restricted Rights at 48CFR52.227 as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA 01803. This document contains proprietary information of Cognos. All rights are reserved. No part of this document may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos.
Table of Contents
Introduction
7 9
Installation Checklist 10 TM1 Service Account 12 .NET Framework Requirements 12 Microsoft ASP.NET Framework 3.0 is not Registered 13 Enable TM1 Excel Service 13 ASPNET User is not Defined 14 Logging Installation Messages 15 Installing Components on Different Machines 15 Important Notes on Distributed Installations 16 Starting the Installation Wizard 16 Accept the License Agreement 16 Choose a Product to Install 17 Microsoft Framework Reminder 17 Custom or Standard Installation Options 17 Installation Location 18 Selecting Components to Install 18 Chapter 2: Installing TM1
19
Custom TM1 Installation 19 Custom TM1 Components 19 Configuring TCP/IP Ports for TM1 21 Username and Password for TM1 Services 22 Installing TM1 on Networks without Domains 23 Security Settings 23 Integrated Login Modes 24 Configuring the TM1 Server 25 Configuring TM1 Clients 26 Begin the Installation 27 Post-Installation Tasks 27 Standard TM1 Installation 28 Chapter 3: Installing TM1 Perspectives
31
Custom TM1 Perspectives Installation 31 Configuring TM1 Perspectives 32 Standard TM1 Perspectives Installation 32 Chapter 4: Installing TM1 Web
35
Custom TM1 Web Installation 35 Configuring TM1 Web Components 35 Configuring TCP/IP Ports for TM1 Web 38 Username and Password for TM1 Services 38 Security Settings 38
Installation Guide 3
Table of Contents Configuring the TM1 Server 39 Configuring TM1 Clients 40 Configuring Web Components 40 Standard TM1 Web Installation 40 Chapter 5: Installing TM1 for 64-bit Windows
43
Custom 64-bit TM1 Installation 43 Configuring TCP/IP Ports for 64-bit TM1 43 Username and Password 43 Security Settings 44 Configuring the 64-bit TM1 Server 44 Standard 64-bit Installation 44 Chapter 6: Installing TM1 x86 on a x64 Windows System
47
WOW64 (32-bit) Application Space 47 Installation Notes about TM1 Components 47 Importance of Installation Order 48 Location of Installed TM1 Program Files 48 Naming Conventions for x86 and x64 TM1 Services 49 Installing TM1 x86 in Windows x64 49 Running the TM1 Database with Both x86 and x64 TM1 Servers 49 Chapter 7: Installing TM1 on UNIX
51
Pre-Installation Tasks 51 UNIX Installation Checklist 51 UNIX Compatible Components 52 Starting the Installation Wizard 52 Select a Language 53 Select TM1 UNIX Components 53 Accept the License Agreement 54 Set the Installation Location 54 Configure TCP/IP Ports 54 TM1 Server Configuration 55 Installation Summary 55 After You Complete the Installation 55 S89IBM_TM1 Startup Script 56 Uninstalling UNIX TM1 56 Silent UNIX Installation 57 Console Installation 57 Starting a UNIX TM1 Server 58 Running the UNIX TM1 Server in Background Mode 58 Chapter 8: Installing TM1 Workflow
59
Workflow Prerequisites 59 Licensing 59 Running the Workflow Installation Wizard 60 Selecting Workflow Installation Components 61 Workflow Components 61 Destination Folder for Workflow Components 62 Installing Workflow for the First Time 62
4 TM1
Table of Contents Installing Workflow for One Existing TM1 Database 62 Installing Workflow for Multiple TM1 Databases 62 Upgrading to Workflow from Planning Manager 1.3 63 Upgrading Planning Manager for One Existing TM1 Database 63 Upgrading Planning Manager for Multiple TM1 Databases 63 Configuring Workflow for Excel 64 Troubleshooting the Workflow Excel Add-in 65 Using Workflow with TM1 Web 65 Workflow On The Web 65 Workflow Features in TM1 Web 65 Localizing TM1 Web Toolbar Captions 65 Chapter 9: Using IBM Cognos 8 Security with TM1
67
IBM Cognos 8 Security Overview 67 Setting Up a TM1 Server to Use IBM Cognos 8 Security 68 Configuring the TM1 Server 68 Configuring the TM1 Client 70 Defining a Cognos User to Function as a TM1 Administrator 71 Importing Cognos Groups into TM1 72 Creating Users 72 Administering TM1 Object Security 73 Configuring TM1 Web to Use IBM Cognos 8 Security 73 Logging in to TM1 Top 73 User Considerations When Using IBM Cognos 8 Authentication 73 Chapter 10: Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services Configure TM1 to use IBM Cognos 8 Security 75 Install the TM1 Viewer Portlets 75 Configure Access to IBM Cognos 8 From the TM1 Viewer Portlets 76 Uninstall the TM1 Viewer Portlets 76 Chapter 11: Maintaining and Upgrading Your TM1 Installation Maintaining TM1 Components 77 Modify Components 77 Repair the TM1 Installation 78 Remove TM1 79 Upgrading TM1 79 Backing Up Your TM1 Data 79 Restoring Your TM1 Database 79 Index
75
77
81
Installation Guide 5
Table of Contents
6 TM1
Introduction
This manual describes how to install the IBM Cognos TM1 software components on Windows and UNIX operating systems. Business Performance Management is the continuous management and monitoring of Financial, Operational, Customer and Organizational performance across the enterprise. Business Performance Management solutions have the following capabilities to facilitate the proactive steering of business direction: Wide deployment Collaborative decision making Continuous and real-time review and refinement Monitoring of Key Performance Indicators
IBM Cognos TM1 integrates business planning, performance measurement and operational data to enable companies to optimize business effectiveness and customer interaction regardless of geography or structure. TM1 provides immediate visibility into data, accountability within a collaborative process and a consistent view of information, allowing managers to quickly stabilize operational fluctuations and take advantage of new opportunities.
Audience
To use this guide, you should be familiar with your TM1 system and network requirements and having a basic understanding of programming and installation concepts.
Related Documentation
Our documentation includes user guides, getting started guides, new features guides, readmes, and other materials to meet the needs of our varied audience. The following documents contain related information and may be referred to in this document. Note: For online users of this document, a Web page such as The page cannot be found may appear when clicking individual links in the following table. Documents are made available for your particular installation and translation configuration. If a link is unavailable, you can access the document on the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).
Document
IBM Cognos TM1 AP1
Description
Describes the functions and features of the IBM Cognos TM1 API. The API is intended to give complete access to all the features and functionality of the TM1 OLAP engine. Describes how to create and maintain objects on a TM1 server, administer security, and develop TM1 applications.
Installation Guide 7
Introduction
Document
Description
IBM Cognos TM1 Opera- Provides a basic understanding of TM1 architecture, server operations, tions Guide authentication, and component security. IBM Cognos TM1 Refer- A collection of reference materials that describes TM1 functions, ence Guide variables, and other programming elements. IBM Cognos TM1 Rules Guide Describes how to use TM1 rules to build an application that reveals business data in sophisticated and useful ways based on simple raw data. Describes how to use TM1 TurboIntegrator to import data and metadata into TM1 from a variety of sources. Describes how to use the TM1 Windows clients: TM1 Architect, TM1 Perspectives, and TM1 Client. It also describes the Web-based client, TM1 Web.
IBM Cognos TM1 TurboIntegrator Guide IBM Cognos TM1 Users Guide
Finding Information
Product documentation is available in online help from the Help menu or button in IBM Cognos products. To find the most current product documentation, including all localized documentation and knowledge base materials, access the IBM Cognos Resource Center (http://www.ibm.com/software/ data/support/cognos_crc.html). You can also read PDF versions of the product readme files and installation guides directly from IBM Cognos product CDs.
Getting Help
For more information about using this product or for technical assistance, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html). This site provides information on support, professional services, and education.
8 TM1
When you install TM1, you can click the Help button at the lower left corner of the TM1 Installation Wizard for context-sensitive assistance. Use the Table of Contents, Index, and Search tabs to navigate the help system and locate a particular topic.
Tab
Before You Install
Topic
Installation Checklist TM1 Service Account Hardware and Software Logging Installation Messages Installing Components on Different Machines
Installation Guide 9
Tab
Running the Wizard
Topic
Starting the Installation Wizard Choose Setup Language Accept the License Agreement Choose a Product to Install Installation Location Custom or Standard Installation Options
Installing TM1 Perspectives Installing TM1 Installing TM1 Web Installing TM1 for 64-bit Windows Installing TM1 x86 on a x64 Windows System Installing TM1 on UNIX Installing TM1 Workflow
Additional Topics
Note: Installation Wizard error messages are displayed in English. If you are upgrading to a newer version of TM1, see "Upgrading TM1" (p. 79).
Installation Checklist
To prepare to install TM1, you should complete the tasks described in the following checklist: Familiarize yourself with TM1 terms and concepts. See the IBM Cognos TM1 Users Guide and the IBM Cognos TM1 Developers Guide. Determine which components you want to install and how they should be distributed across your hardware environment. In a production environment, TM1 components are usually distributed across multiple computers. See the IBM Cognos TM1 Operations Guide for details on how to design the optimal TM1 environment. Determine your hardware and software requirements.
Component
Operating Systems (Clients)
Specification
Windows Vista Windows XP (Intel 32-bit)
10 TM1
Component
Specification
iMac (OS X) for TM1 Web
Web Browsers
Internet Explorer 6.x/7 for TM1 Web Firefox 2.0 for TM1 Web
Windows 2003 R2 (Intel 32-bit) Windows 2003 R2 x64 (64 bit) (see note 4) Solaris 10 Sparc (64-bit) AIX 5.3
IIS (ASP) V6 32-bit and 64-bit MS SQL 2005 Oracle 10g/11g DB2 9.5 and 9.1
Notes: 1. Architect/Perspectives require Excel 2002 (XP), 2003 or 2007. Note: Excel XP (2002) is in Microsoft extended support. Cognos will make a best effort to address any issues but may be limited by the support available through Microsoft. ODBO support via Excel 2007 Pivot tables is not supported. Advanced Rules Editor requires .NET Framework 2.0 on the client. 2. Cognos TM1 Connector for use with SAP BW - BW version 3.5 and Netweaver BI 7 supported. 3. For TM1 Web Excel 2003 or 2007 (with latest service pack) recommended on the Web Server. (Excel 2002 supported - see release notes for installation note); Web Application requires .NET 3.0. 4. For Windows 2003 R2 x64 on the Microsoft supported processors - Microsoft lists support for AMD Opteron, AMD Athlon 64, Intel Xeon with Intel EM64T or Intel 64, and Intel Pentium with Intel EM64T or Intel 64 (see MS site http://www.microsoft.com/ windowsserver2003/64bit/x64/enterprise.mspx). 5. TM1 Workflow is only localized currently into English, French and German. If you plan to import data from another relational database, install your database software first.
Installation Guide 11
Chapter 1: TM1 Installation Overview If you are running Oracle on UNIX, install the appropriate UNIX client software for your Oracle database on the UNIX machine. Use the Oracle Network Configuration Assistant to specify a local net service name. For more information, see "Installing TM1 on UNIX" (p. 51). Decide what language to set as the default for the installation. You can choose from a variety of currently available languages. Your choice of language determines the language in which the Installation Wizard runs. It also determines the language in which TM1 components will run. Create your TM1 Service Account. Before you install TM1, we recommend that you create a single domain account for all your Windows-based TM1 Services.
The Installation Wizard will enable and use these privileges during the installation process. This account applies only to Windows-based services and agents. TM1 services installed on Solaris or HP/UX always run as ROOT.
Steps
1. Open a Command Prompt window and navigate to the following directory: C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727
12 TM1
Chapter 1: TM1 Installation Overview 2. Execute the following command: aspnet_regiis.exe -i For a complete list of supported platforms and software, refer to the TM1 platform matrix available on the IBM Cognos Resource Center http://www.ibm.com/software/data/support/ cognos_crc.html.
Steps
1. Uninstall TM1 using Add/Remove Programs in the Windows Control Panel. 2. Make sure Microsoft Internet Information Services (IIS) is installed on your system. You can check this by using the Add/Remove Windows Components feature. 3. Manually register the Microsoft ASP.NET Framework. For more information, see ".NET Framework Requirements" (p. 12). 4. Run the TM1 Installation Wizard again.
Steps
1. Open the Windows Control Panel. 2. Double-click Administrative Tools. 3. Double-click Services. 4. Double-click TM1 Excel Service. 5. Change the Startup Type from Disabled to Automatic. 6. Click OK.
Installation Guide 13
Chapter 1: TM1 Installation Overview Additionally, if you plan to run TM1 Web you must install Microsoft Excel 2002 or Excel 2003 on the same machine where the IIS web server is installed. If Excel 2002 or 2003 is not present on the machine where the IIS web server is installed, the TM1 Web installation displays a warning message, but allows you to continue the installation.
Steps
1. Open the Windows Control Panel. 2. Double-click Administrative Tools. 3. Double-click Computer Management. 4. Click Local Users and Groups. 5. Right-click Users and select New User. The New User dialog box displays. 6. Configure the dialog box as follows, using a password of your choice.
7. Click Create.
14 TM1
The log file is named TM1Install.log. It is written to the directory identified by your TEMP user environment variable. The log file remains until the next time you run an install. To determine the location of this directory you can issue the command echo $TEMP (UNIX) or echo %TEMP (Windows) or complete the following steps.
Steps
1. Open the Windows Control Panel. 2. Double-click System. 3. Click the Advanced tab. 4. Click Environment Variables. Find the TEMP variable in the list of user variables for the directory location of TM1Install.log.
Component
TM1 Server
Description
To install the TM1 server, you must know the name of the machine on which the TM1 Admin Server is running. This can be installed without any knowledge of your network topology. To install the ODBC Gateway on separate machines, you must know the location of the Oracle client files, the Oracle Service Name, and the Oracle database username and password. Installation Guide 15
16 TM1
Chapter 1: TM1 Installation Overview To accept the license terms and continue with the installation, select I accept the terms of the license agreement, then click Next.
Installation Guide 17
Installation Location
In most installations, the default installation directory for TM1 is C:\Program Files\Cognos\TM1. If you perform a custom installation and choose to install only TM1 Web, the default installation directory is C:\Inetpub\wwwroot\TM1Web.
Steps
1. To change the default location where TM1 installs, click on the Change button. The Installation Location screen displays. 2. Navigate to the directory where you want to install and click OK.
Icon
Description
This feature will be installed on local hard drive. Select this option to include an individual component in the TM1 installation. This feature, and all subfeatures, will be installed on local hard drive. Select this option to include all components in a category for installation. For example, if you choose this option for the Clients, all components listed under Clients are included in the installation. This feature will not be available. Select this option to exclude a component from the TM1 installation. Components that are excluded from installation display with an X next to the component name.
+ (plus sign)
Expand selection. For components with subfeatures click + to expand the list.
18 TM1
To run the Installation Wizard and install TM1 components, follow these steps.
Steps
1. After you have answered the introductory prompts. For more information, see "Standard TM1 Installation" (p. 28). The Choose a Product to Install screen displays. 2. Select TM1 and click Next.
Installation Guide 19
Component
Clients
TM1 Architect A stand-alone TM1 client used to create and maintain data and metadata on both local and remote TM1 servers.
Yes
TM1 API Application programming interface that developers use to create C++ and VB applications that interact with TM1.
Yes
TM1 Java API Application programming interface that developers use to create Java applications that interact with TM1.
Yes
TM1 .NET API Application programming interface that developers use to create .NET applications that interact with TM1.
Servers
Yes
TM1 Admin Server A process that keeps track of all TM1 servers running on a network. An Admin Server runs on a computer known as an Admin Host. When a TM1 server starts, the server registers itself with an Admin Server that is running on a specified Admin Host. TM1 clients reference the Admin Server to determine which TM1 servers are available on the network.
20 TM1
Component
Program
TM1 Admin Host port number
Description
5495 is the port number on which the Admin Server on this machine listens for client requests.
Installation Guide 21
Program
Description
TM1 SSL Admin server port number 5498 All TM1 components communicate with the TM1 Admin Server using SSL. The Admin Server supports older TM1 clients that cannot use SSL by listening on two ports; one secured, the other unsecured. See "SSL and TM1" (p. 22) for more information. TM1 Client Message port number 12346 This port number establishes a secondary port for progress messages to use when a lengthy operation is waiting to be cancelled.
Account
Username
Description
Specify a domain account using the syntax domain\username. For example: Company\nolan Note: Running TM1 services under the local system account is not recommended. Windows places restrictions on this account that may cause the TM1 software to operate incorrectly.
Password
Enter the password for the domain account that logs in and starts services. Re-enter your password to confirm correct entry.
Re-enter password
22 TM1
Chapter 2: Installing TM1 When you install TM1 in a distributed environment, where some components reside on one machine and some components on another, you must enter the same user name and password each time you run the installation. For more information, see "Installing TM1 on Networks without Domains" (p. 23).
If you set up file shares in your Windows network for use by TM1 components, be sure that each local account that you set up to run a TM1 service has access to those shares. Note: If you install on a machine that does not participate in a Windows domain, you cannot use Integrated Login. For more information, see "Security Settings" (p. 23).
Security Settings
Use the Security Settings screen to select one of three authentication modes for TM1.
Authentication Mode
Integrated Login
Description
Integrated Login enables TM1 users to automatically log in to TM1 components using their Windows login user name and password. If you choose to use Integrated Login, it runs in mixed mode by default. TM1 Authentication requires users to enter a username and password when they log into a TM1 component. When this authentication mode is used, usernames and passwords are stored on a TM1 server.
TM1 Authentication
Installation Guide 23
Authentication Mode
LDAP Authentication
Description
Use LDAP Authentication to centralize all your security information on a single LDAP server. When a TM1 user attempts to log in to TM1, his username and password are validated against the information stored on an LDAP server. If you choose to use LDAP Authentication, you must also supply values for LDAP Host and LDAP Port.
LDAP Port
The port on which the LDAP server is running. If a port is not specified, 389 (the standard LDAP default) is used. The domain name or dotted string representation of the IP address of the LDAP server host. If you do not enter an LDAP server host, 'localhost' is used by default. The node in the LDAP tree at which the search for the TM1 user being validated begins. For example, if the LDAP distinguished name for an individual TM1 user is in the form uid=nolan,ou=people,o=company.com, then the LDAP search base would be ou=people,o=company.com. Generally, the search base is one level above the node containing distinguished names for TM1 users in the LDAP directory hierarchy.
LDAP Host
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.
Login Mode
Mixed mode
Description
If client programs are set up to use Integrated Login, TM1 tries to log users into the TM1 components using their Windows user name and password. If a TM1 client is not set up to use Integrated Login, the user is prompted by TM1 for a user name and password.
24 TM1
Login Mode
Integrated Login Only
Description
Only TM1 clients set up to use Integrated Login will be allowed to log in to TM1 components. If a client is not set up for Integrated Login, the TM1 server displays an error and the user will not be allowed access the component.
For further details on Integrated Login, including details on server and client configuration parameters, see the IBM Cognos TM1 Operations Guide.
Server Settings
Choose Database
Description
Select the database you want to install with the TM1 server. Click Apply after you select a database to set the server name and data directory path for the selected database. To install the Planning Sample database, select Planning Sample from the drop-down and click Apply. This updates the Server Name with Planning Sample. To install the Sample database, select Sample Database then click Apply to update Server Name with SData. To create an empty data directory where you can install your own custom data, select Custom. Then enter the Server Name to use. Click Change Data Directory to indicate the location of the custom data directory. Click Apply to update the fields.
Server Name
Installation Guide 25
Server Settings
Description
Admin Server Host Machine Name The name of a computer on which a TM1 Admin Server is installed. When a TM1 server is running, it registers itself on this Admin Server. TM1 clients connect to this Admin Server to obtain information about TM1 servers available on a network. Port Number The port on which the TM1 server runs. This parameter is used to distinguish multiple TM1 servers running on the same computer. Valid port values fall between 5000 and 49151. The default is 12345. Click to change the data directory for the server you are installing. Select this option to configure another TM1 server during this installation session.
Client Parameters
Description
Admin Server Host Machine Name The name of a computer on which a TM1 Admin Server is installed. When a TM1 server is running, it registers itself on this Admin Server. TM1 clients connect to this Admin Server to obtain information about TM1 servers available on a network. This option is not offered during a Perspectives installation as the Admin Server always runs on the same machine as the TM1 Server and Client. Disable Excel Edit in Cell Capability The Disable Excel Edit in Cell option is selected by default as it prevents users from accidently overwriting formulas in slice worksheets. We recommend that this option remains selected. Set TM1 to Autoload in Excel Select this option to automatically load the TM1 add-in (Tm1p.xla) when Excel starts. Clear this option to enable a user to manually launch TM1 after Excel starts.
26 TM1
Client Parameters
Use Integrated Login
Description
Select this option to enable Integrated Login for the client. Integrated Login allows you to log in to TM1 components using your Windows user name and password, without the need to complete a login dialog box. Clear the option to disable Integrated Login. Note: TM1 servers and components can be configured to refuse connections from clients that do not use Integrated Login. If servers and components on your system are configured this way, TM1 must use Integrated Login to access the components.
Post-Installation Tasks
Once the installation is complete, a confirmation screen displays. Complete Post-Installation Tasks Start Services Start a TM1 Server Installed as a Service or Application
Start Services
Once you have successfully installed TM1 you must start the following services:
Service
TM1 Admin Server TM1 Excel Service
Description
Service that manages the TM1 servers Handles requests to convert Excel files into XML format. It also handles requests to create Briefing Books, print to PDF, and slice a TM1 view into Excel. Services requests from TM1 clients by loading shared cubes into memory, managing security, sending data to spreadsheets, updating cubes on request, and maintaining a log of changes to the database. The TM1 Server will have the name of your server appended, such as TM1 Server Planning Sample, TM1 Server SData, etc.
TM1 Server
Installation Guide 27
Steps
1. Double-click the Windows Services icon from the Start Programs, Control Panel, Administrative Tasks menu. A list of installed services displays. 2. Select the entry for the TM1 server you want to start, for example TM1 Server - Planning Sample, and click the Start button. An Admin Server must be running before a TM1 server can start. If you have specified an Admin Host in the Tm1s.cfg file, the TM1 server will attempt to connect to an Admin Server on that host. The TM1 server will fail to start if it is unable to connect to an Admin Server for any reason. If you have not specified an Admin Host, the TM1 server attempts to connect to an Admin Server on the local machine. If an Admin Server is not currently running on the local machine, either as a service or an application, the TM1 server starts a new Admin Server application and connects to it. To start a remote server that has been set up as a Windows application, double-click the shortcut icon for the server you want to start.
Component
Installed by default
Yes
Description
Clients
TM1 Perspectives TM1 API TM1 Java API TM1 .NET API SSL TM1 Admin Server TM1 Server (local)
28 TM1
Item
Admin Server port # SSL port # TM1 server port # TM1 Client Message port number TM1 server name Admin Server host name Sample data directory for TM1 server
Default Value
5495 (unsecured) 5498 (secured) 12345 12356 SData Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\TM1Data\ PlanSamp C:\Program Files\Cognos\TM1\Custom\TM1Data\Pdata
A Standard installation uses TM1 Authentication. Users must respond to a prompt for a user name and password when they login to TM1 components. A Custom installation gives you the option of using Integrated Login, which allows TM1 users to automatically login to TM1 components using their Windows login user name and password, or LDAP Authentication. For more information, see "Security Settings" (p. 23).
Selected
Installation Guide 29
30 TM1
Steps
1. After you have answered the introductory prompts, see "Starting the Installation Wizard" (p. 16), the Choose a Product to Install screen displays. 2. Select TM1 Perspectives and click Next. 3. Choose Standard or Custom installation.
Component
Clients
Installation Guide 31
Component
Servers
Component
Clients Developers Environment
Servers
Yes Yes
A Standard installation uses the following default values. For more information, see "Configuring the TM1 Server" (p. 25).
32 TM1
Item
Admin Server port # SSL port # TM1 server (local) port # Admin Server host name
Default Value
5495 (unsecured) 5498 (secured) 12345 Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\ TM1Data\Pdata Selected.
Installation Guide 33
34 TM1
Steps
1. After you have answered the introductory prompts, see "Starting the Installation Wizard" (p. 16). The Choose a Product to Install screen displays. 2. Select TM1 Web and click Next. 3. Choose Standard or Custom installation.
Installation Guide 35
Component
Installed by default
Yes
Description
Clients
TM1 Client Runs as an add-in to Microsoft Excel and provides limited access to data on remote TM1 Servers.
Yes
TM1 Perspectives Runs as an add-in to Microsoft Excel. With TM1 Perspectives, you can create and maintain objects and data on both local and remote TM1 Servers.
Yes
OLEDB Provider Installs the TM1 OLEDB for OLAP provider. The OLEDB Provider enables TM1 to perform MDX queries against OLAP data sources such as Microsoft Analysis Services.
Developers Environment
Yes
TM1 Architect A stand-alone TM1 client used to create and maintain data and metadata on both local and remote TM1 servers.
Yes
TM1 API Application programming interface that developers use to create C++ and VBapplications that interact with TM1.
Yes
TM1 Java API Application programming interface that developers use to create Java applications that interact with TM1.
Yes
TM1 .NET API Application programming interface that developers use to create .NET applications that interact with TM1.
36 TM1
Component
Installed by default
Yes
Description
Servers
TM1 Admin Server A process that keeps track of all TM1 servers running on a network. An Admin Server runs on a computer known as an Admin Host. When a TM1 server starts, the server registers itself with an Admin Server that is running on a specified Admin Host. TM1 clients reference the Admin Server to determine which TM1 servers are available on the network.
Yes
TM1 Server The TM1 Server manages requests from TM1 clients. It loads the names of all available permanent objects (cubes, dimensions, etc.) into memory and responds to client requests by performing calculations, consolidations, and updates as required. The TM1 Server also manages security-granting or denying access to server objects and maintaining a log of changes to the database.
No
TM1 Web Components Installs TM1 Web server components required to access TM1 servers and data using a web browser. These components are selected for installation by default only as part of a TM1 Web installation.
Installation Guide 37
Component
Installed by default
Yes
Description
TM1 Top A TM1 utility that enables you to dynamically monitor threads running in an instance of a Windows or UNIX TM1 server. TM1 Top runs only on a Windows system and is available only with the Windows installation of TM1. Note: To monitor a UNIX TM1 server, use the TM1 Installation Wizard to install TM1 Top on a Windows system and then configure TM1 Top to connect to the UNIX TM1 server. When the ADMINHOST and SERVERNAME parameters are pointing to a UNIX machine, TM1 Top will monitor the UNIX environment. See the IBM Cognos TM1 Operations Guide for details on configuring the TM1Top.ini file.
Security Settings
Use the Security Settings screen to select one of three authentication modes for TM1.
TM1 Authentication
38 TM1
LDAP Port
LDAP Host
Once you have installed you cannot change your TM1 authentication mode by re-running the Installation Wizard. See "Changing Security Parameters" (p. 25) for more information. See also the IBM Cognos TM1 Operations Guide.
Installation Guide 39
Chapter 4: Installing TM1 Web See "Configuring the TM1 Server" (p. 39) for information on loading sample databases.
Steps
1. To install IIS to a different directory, click Change and navigate to the new directory. Note: The Windows permissions on the directory into which you install the Web components must be set to Everyone. If the Windows permissions on this directory are restricted, the TM1 Web client may not be accessible to all users. When you install TM1 Web, TM1 installs Charts (c) technology. Dundas Charts (c) provides the charting functionality of TM1 Web. Dundas Charts (c) technology is delivered through two DLLs that are installed on your IIS web server: C:\Inetpub\wwwroot\TM1Web\bin\DundasWebChart.dll C:\Inetpub\wwwroot\TM1Web\DundasWinChart\DundasWinChart.dll
2. After specifying the TM1 Web directory, click Next to proceed to the next installation screen. 3. If prompted to shut down IIS, click OK.
Component
Clients
Installed by default
Yes Yes
Description
TM1 Client TM1 Perspectives
40 TM1
Component
Installed by default
Yes
Description
TM1 OLE DB Provider TM1 Architect TM1 API TM1 Java API TM1 .NET API SSL TM1 Admin Server TM1 Server (local) TM1 Web Components (ASP script files and TM1ExcelService.exe) TM1 Top
Developers Environment
Servers
Yes
A Standard TM1 Web installation uses the following default values. For more information, see "Configuring the TM1 Server" (p. 25).
Item
Admin Server port # SSL port # TM1 server port # TM1 server name Admin Server host name
Default Value
5495 (unsecured) 5498 (secured) 12345 SData Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\ TM1Data\PlanSamp C:\Program Files\Cognos\TM1Custom\TM1Data\ Pdata
Installation Guide 41
Item
Security mode
Default Value
A Standard installation uses TM1 Authentication. A Custom installation gives you the option of using TM1 Authentication, Integrated Login or LDAP Authentication.
Selected.
42 TM1
Note: To install TM1 x86 (32-bit) components on a 64-bit Windows system, you must use the TM1 x86 Installation Wizard. The TM1 x86 Installation Wizard includes 32-bit versions of the TM1 Admin Server, TM1 Server, TM1 Clients, and other TM1 components such as the TM1 Top utility and the TM1 .NET API. For details see "Installing TM1 x86 on a x64 Windows System" (p. 47). After you have answered the introductory prompts (see "Starting the Installation Wizard" (p. 16)), choose "Standard 64-bit Installation" (p. 44) or "Custom 64-bit TM1 Installation" (p. 43).
Component
TM1 Admin Server TM1 Server
Installed by default
Yes Yes
Installation Guide 43
Security Settings
You can select one of three authentication modes for TM1, Integrated Login, TM1 Authentication, LDAP Authentication. For more information, see "Security Settings" (p. 23). Once youve installed you cannot change your TM1 authentication mode by re-running the Installation Wizard. For more information, see "Changing Security Parameters" (p. 25). See also the TM1 Operations Guide.
Component
Servers
Installed by default
Yes Yes
Description
TM1 Admin Server TM1 Server (local)
Item
Admin Server port # SSL port # TM1 server port #
Default Value
5495 (unsecured) 5498 (secured) 12345
44 TM1
Item
TM1 server name Admin Server host name
Default Value
SData Same as computer on which the installation is run. C:\Program Files\Cognos\TM1\Custom\ TM1Data\PlanSamp C:\Program Files\Cognos\TM1\Custom\ TM1Data\Pdata A Standard installation uses TM1 Authentication. A Custom installation gives you the option of using TM1 Authentication, Integrated Login or LDAP Authentication.
Selected.
Installation Guide 45
46 TM1
Note: Windows XP Professional x64 is not a server class operating system and is not a recommended platform for a TM1 production environment. However, in some situations, it may be used as an individual x64 development environment for TM1. After you have answered the introductory prompts. See "Starting the Installation Wizard" (p. 16) for more information. Choose Standard or Custom installation.
Component
TM1 Admin Server
Considerations
You can install both the x86 and x64 versions of the TM1 Admin Server, but only one of them can be active. For details, see "Importance of Installation Order" (p. 48). You can install and run multiple copies of both the x86 and x64 versions of the TM1 server on the same machine. The only exception is that each server has to be configured to a unique port number. For details, see "Running the TM1 Database with Both x86 and x64 TM1 Servers" (p. 49).
TM1 Server
Installation Guide 47
Component
TM1 Clients
Considerations
There are currently no 64-bit TM1 client applications available.
TM1 Top utility and The TM1 Top utility and the TM1 .NET API are 32-bit applications and TM1 .NET API can be installed only into the WOW64 space using the TM1 x86 installation.
The active/non-active status of a TM1 Admin Server is determined by its Startup Type setting in Windows Services: The active Admin Server has its service Startup Type set to Automatic. The non-active Admin Server has its service Startup Type set to Disabled.
For example, if you install TM1 x64 first and install TM1 x86 second, the x64 Admin Server is set to Automatic and the x86 version will be Disabled in Windows Services. If you then uninstall TM1 x64, the dependencies for all the related TM1 servers are automatically redirected to the remaining x86 Admin Server.
For example, if you select the default installation location when you install both versions of TM1, the TM1 program files are installed in the following directories: TM1 x64 default directory: C:\Program Files\Cognos\TM1
48 TM1
Chapter 6: Installing TM1 x86 on a x64 Windows System TM1 x86 default directory: C:\Program Files(x86)\Cognos\TM1
Component
TM1 x86 Admin Server TM1 x64 Admin Server TM1 x86 servers
Naming Conventions
TM1 Admin Server TM1 Admin Server (x64) TM1 Server - DatabaseName Where DatabaseName is the name of the database you selected during the installation. For example: TM1 Server - Planning Sample.
TM1 Server - DatabaseName x64 Where 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
Installation Guide 49
Chapter 6: Installing TM1 x86 on a x64 Windows System Planning Sample database with both the x86 and x64 versions of TM1 server, you have to edit the port number in one of the Tm1s.cfg files to point to a different port number.
Steps
1. Locate the Tm1s.cfg file for the sample database that was installed with either the x86 or x64 TM1 version. For example, if you installed both versions of TM1 to their default locations, then the Tm1s.cfg file for the Planning Sample database is located in the following directories: For x86 TM1: C:\Program Files(x86)\Cognos\TM1\Custom\TM1Data\PlanSamp For x64 TM1: C:\Program Files\Cognos\TM1\Custom\TM1Data\PlanSamp 2. Open the Tm1s.cfg file with a text editor, such as Windows Notepad. 3. Locate the line of code where the PortNumber parameter is set, as shown below, and change the value to a another valid port number. When you install a TM1 server with the Planning Sample database, the default port number for the sample is set to 12345. Valid port numbers are between 5001 and 49151. 4. Save and close the Tm1s.cfg file. 5. In Windows Services, stop and then restart the associated TM1 server.
50 TM1
Pre-Installation Tasks
Before you install the TM1 software, you should be aware of the following: Your UNIX account must have root privileges to successfully run the installation. This installation will modify the /etc/services file. It will also add a startup script named S89IBM_TM1 to the /etc/rc2.d directory (Solaris and AIX) or the /sbin/rc3.d/ directory (HP/UX).
Additionally, the following requirements must be met to support the graphical user interface of the installation program: You must have X server software installed on the machine that will host your TM1 components. You must have X server client software installed on the machine from which you run the TM1 Installation Wizard. Your UNIX account must be able to create an X-Windows connection. On many systems, you control this through the utility XHOST.
TM1 provides a silent server installation and a console installation that does not require an X windows system. See "Silent UNIX Installation" (p. 57) and "Console Installation " (p. 57).
Installation Guide 51
Chapter 7: Installing TM1 on UNIX Determine which components you want to install and how they should be distributed across your hardware environment. Only the TM1 server can be run on UNIX. You cannot run clients or TM1 Web on UNIX. See the IBM Cognos TM1 Operations Guide for details on how to design the optimal TM1 environment. Determine your hardware and software requirements. Refer to the TM1 platform matrix available on the IBM Cognos Resource Center http://www. ibm.com/software/data/support/cognos_crc.html for hardware and software requirements. If you plan to import data from another relational database, install your database software first. If you are running Oracle on UNIX, install the appropriate UNIX client software for your Oracle database on the UNIX machine. Use the Oracle Network Configuration Assistant to specify a local net service name. Check the X-server software on your UNIX machine. To run the Graphical User Interface UNIX Installation Wizard, X-server software must be installed on the machine that will host your TM1 components. You must have X-server client software installed on the machine from which you run the TM1 Installation Wizard. If X-server software is not installed on the UNIX machine, run the console installation. For more information, see "Console Installation " (p. 57).
52 TM1
Chapter 7: Installing TM1 on UNIX Follow these steps to start the Installation Wizard.
Steps
1. Change directories to your CDROM directory, for example, cd /cdrom 2. Start the Installation Wizard by entering the installation command for your operating system:
Operating System
Sun Solaris AIX HP/UX
Installation Command
./install_solaris.bin ./install_aix.bin
Select a Language
You can choose from a variety of currently available languages. Your choice of language determines the language in which the Installation Wizard runs. It also determines the language in which TM1 components will run. In the case of a TM1 server, messages from the server display in the language you choose. Select a language, then click Next.
Component
Installed by default
Yes
Description
Servers
TM1 Server The TM1 Server manages requests from TM1 clients. It loads the names of all available permanent objects (cubes, dimensions, etc.) into memory and responds to client requests by performing calculations, consolidations, and updates as required. The TM1 Server manages security; grants or denies access to server objects as required; and maintains a log of changes to the database.
Installation Guide 53
Component
Installed by default
Yes
Description
TM1 Admin Server A process that keeps track of all TM1 servers running on a network. An Admin Server runs on a computer known as an Admin Host. When a TM1 server starts, the server registers itself with an Admin Server that is running on a specified Admin Host. TM1 clients reference the Admin Server to determine which TM1 servers are available on the network.
TCP/IP Port
Admin Server SSL Port
Default Value
5498
Description
All TM1 components communicate with the TM1 Admin Server using SSL on this specified port number. The port number on which the Admin Server on this machine listens for client requests.
5495
54 TM1
Item
Server Name
Description
The name you want to use to identify the TM1 server. The port on which the TM1 server runs. This parameter is used to distinguish multiple TM1 servers running on the same computer. Valid port values fall between 5000 and 49151. The default is 12345. The name of a computer on which a TM1 Admin Server is installed. When a TM1 server is running, it registers itself on this Admin Server. TM1 clients connect to this Admin Server to obtain information about TM1 servers available on a network. The Admin Server can reside on the same computer on which the TM1 Server is installed or another computer on your network.
Select this option if you want to install the TM1 sample data, which is referenced extensively by the TM1 documentation. Clear this option if you do not want to install the sample data.
Specify the path to the TM1 servers data directory. If you have an existing TM1 data directory that you want to use with your new server installation, enter the full path to the directory.
Installation Summary
The installation summary provides the following information: The TM1 components you are installing. The amount of disk space your installed components require.
Click Next after reviewing the summary, then click Done after the installation is complete.
Task
Login to ensure proper connectivity. You should IBM Cognos TM1 Users Guide log in to TM1 through TM1 Architect. Choose an authentication model. Set up TM1 security. Start TM1. IBM Cognos TM1 Operations Guide IBM Cognos TM1 Operations Guide "Starting a UNIX TM1 Server" (p. 58)
Steps
1. Go to the <TM1_Install>/TM1_Uninstall directory. The default location of this directory is / Cognos/TM1/TM1_Uninstall. 2. Run the TM1_Uninstall program by issuing the command ./TM1_Uninstall. The TM1 Uninstaller displays. 3. Click Next on the Introduction screen. 4. Select Complete Uninstall or Uninstall Specific Features, then click Next. If you select Complete Uninstall, all TM1 components will be removed immediately. If you select Uninstall Specific Features, you must choose individual components to uninstall. 5. If you select Uninstall Specific Features, clear the check box next to the components that you want to remove, then click Uninstall. 6. Click Done to complete the uninstall. 7. Click Finish after the uninstaller has removed TM1 from your system. To preserve your customizations, none of the files and subdirectories in the <TM1_Install>/Custom directory are removed when you uninstall TM1. For example, the
56 TM1
Chapter 7: Installing TM1 on UNIX configuration files remain available if you reinstall or upgrade your TM1 software. Similarly, any TM1 data directories that exist in <TM1_Install>/Custom/TM1Data are not removed.
For example to install TM1 on AIX from the /software/TM1 directory, enter the command /
software/TM1/./install_aix.bin.
The TM1 server will be installed silently without user input, using the following default values:
Parameter
Install directory Components Server Name Server TCP/IP port Admin Host
Description
/Cognos/TM1 TM1 Server, Admin Server Planning Sample 12345 (blank, defaults to machine where TM1 server is running) /Cognos/TM1/Custom/TM1Data/PlanSamp Admin (blank)
Console Installation
To run a console UNIX TM1 server installation, enter the following line at a command prompt: <path_to_directory_containing_install.bin_executable>./install_<OS>.bin -i console For example, to complete a silent install of TM1 on Solaris from the /software/TM1 directory, enter the command /software/TM1/./install_solaris.bin -i console. To complete a silent install of TM1 on AIX from the /software/TM1 directory, enter the command /software/TM1/./install_aix.bin -i console. You will be prompted to enter server parameter values required to install and run the TM1 server.
Installation Guide 57
Step
Run ./tm1s_start_<server_name> to start your TM1 server.
58 TM1
Workflow Prerequisites
Before you install Workflow, you must have the following software installed and configured: IBM Cognos TM1 Server 9.4 or later. TM1 Client or TM1 Perspectives. (You do not need a TM1 Perspectives license on every client workstation. If users can run the TM1 Client, they can run Workflow.) If you want to run Workflow through TM1 Web, you must have TM1 Web installed. Each Workflow user must be running Excel 2003 or later If you are installing Workflow against an existing TM1 database:
The existing TM1 database must have a dimension that holds the names of budget versions. Without an existing version dimension, you cannot run Workflow.You should back up the existing database and store the copy in a safe place before running the Workflow installation.
Licensing
TM1 Workflow requires TM1 9.4 or later. You must have the following options enabled in your TM1 Server license: TM1 Server TurboIntegrator TM1 Workflow
Installation Guide 59
Note: If you are upgrading from Planning Manager 1.2 or older, you must first upgrade to Planning Manager 1.3. For more details or support, visit the IBM Cognos Resource Center http://www.ibm. com/software/data/support/cognos_crc.html.
Steps
1. Run the Workflow setup.exe file on the Workflow installation CD or from the Workflow installation package that you downloaded. The Workflow Installation Wizard runs and displays the Welcome screen. 2. Click Next at the Welcome screen. The License Agreement screen appears. 3. Accept the license agreement and click Next. The Custom Setup screen appears. Use the Custom Setup screen to select the Workflow components that you want to install, depending on your specific installation scenario. For details, see the following sections: "Selecting Workflow Installation Components" (p. 61) "Installing Workflow for the First Time" (p. 62) "Upgrading to Workflow from Planning Manager 1.3" (p. 63) 4. Click Next. If you selected the Excel Addin option on the Custom Setup screen, the Excel Addin screen appears. The following Excel Addin options are available: Add the Addin to the list of available Addins in Microsoft Excel - This option makes Workflow appear in the Add-Ins dialog box that appears when you select Tools, Add-Ins in Excel. Automatically load the Workflow Addin when Microsoft Excel starts - This option starts and displays the Workflow toolbar when you start Excel.
5. Click Next. The Ready to Install the Program screen appears. 6. Click Install to complete the installation.
60 TM1
Workflow Components
The available Workflow components include the following Server and Excel components:
Component
Description
Web Server Compon- Enables the Workflow toolbar and functionality in TM1 Web. ent Default installation location is: C:\Inetpub\wwwroot\TM1Web\ Database Components Includes the TM1 Workflow server files to add to an existing TM1 database that has not been used with Workflow yet. Default installation location is: C:\Program Files\Cognos\TM1\Custom\TM1Data\TM1 Planning Manager V2\ Planning Manager Upgrade Includes the Workflow upgrade files if you are upgrading from Planning Manager 1.3 Default installation location is: C:\Program Files\Cognos\TM1\Custom\TM1Data\TM1 Planning Manager V2 Upgrade\ Excel Addin Enables the Workflow toolbar and functionality in Excel. Default installation location is: C:\Program Files\Cognos\TM1\bin\
Installation Guide 61
Steps
1. Select the component on the Custom Setup screen of the Workflow installation. 2. Click Change. The Change Current Destination Folder dialog appears. 3. Select a new destination folder. 4. Click OK to return to the installation wizard. 5. Repeat these steps to change the destination folder for any other Workflow component.
Steps
1. Run the Workflow installation and advance to the Custom Setup screen. 2. On the Custom Setup screen, use the default component selection to install only the following components: Web Server Component Database Components Excel Addin
3. Set the destination folder of the Database Components depending on how many TM1 databases you want to use with Workflow.
62 TM1
Chapter 8: Installing TM1 Workflow copy the database component files into the other TM1 data directories that you want to use with Workflow.
Steps
1. On the Custom Setup screen, click Next and complete the installation. 2. Restart any of the TM1 servers where you installed Workflow to allow the Workflow options to be loaded. You also need to enable the Workflow option in the server license for each TM1 server that will use Workflow.
Steps
1. Back up your existing Planning Manager database and store the copy in a safe place before running the new Workflow installation. 2. Uninstall the previous version of Planning Manager using the Add or Remove Programs feature in the Windows Control Panel. 3. Run the Workflow installation and advance to the Custom Setup screen. 4. On the Custom Setup screen, select the following components to install: Web Server Component Database Components Planning Manager Upgrade Excel Addin
5. Set the destination folder of the Planning Manager Upgrade depending on how many databases you need to upgrade as follows.
Installation Guide 63
Chapter 8: Installing TM1 Workflow manually copy the database component files into each of the TM1 data directories that you want to upgrade. Repeat these steps on all other TM1 servers that require upgrading.
Steps
1. On the Custom Setup screen, click Next and complete the installation. 2. Re-start the TM1 server. 3. Open TM1 Architect or Server Explorer and log in to the server. 4. Expand Processes and run the TI process, sm_upgrade_v2.pro, to upgrade the database.
After installing Workflow, run Microsoft Excel. TM1 Perspectives should load, followed by TM1 Workflow. The Workflow toolbar appears in Excel as follows.
Workflow toolbar
64 TM1
Steps
1. Unload the Workflow add-in by choosing Tools, Add-ins from the Excel menu and unselecting the TM1Workflow entry. 2. Click OK and close Excel. 3. Restart Excel and make sure that the TM1 Perspectives add-in loads properly. 4. Choose Tools, Add-ins from the Excel menu. 5. Reload the Workflow add-in by clicking Browse and manually selecting the Workflow add-in, TM1 Planning Manager.xla, located in the <TM1 install directory>\bin directory.
Installation Guide 65
Chapter 8: Installing TM1 Workflow "Configuring TM1 Workflow Parameters" in the IBM Cognos TM1 Operations Guide for more information on these parameters.
66 TM1
For complete details on IBM Cognos 8 security concepts, terminology, and implementation, see the IBM Cognos 8 Administration and Security Guide. Note: Integrating TM1 security with IBM Cognos security requires at least TM1 9.4 and IBM Cognos 8.4.
Installation Guide 67
Steps
1. Open the Tm1s.cfg configuration file in a text editor. Tm1s.cfg is located in the TM1 server's data directory. 2. Add the following parameters to the configuration file.
Parameter Name
ServerCAMURI
Description
The URI for the internal dispatcher that the TM1 server should use to connect to IBM Cognos 8 security. The URI is specified in the form http[s]://<host IP address>: <port>/p2pd/servlet/dispatch. For example, http://10.121.25.121:9300/p2pd/
servlet/dispatch or https://10.121.25.121:9300/ p2pd/servlet/dispatch
Note: To find the URI, ask your IBM Cognos 8 administrator to perform the following steps. 1. Open the IBM Cognos Configuration. 2. Click Environment. 3. In the Gateway section, go to Dispatcher URI to locate the URI.
68 TM1
Parameter Name
ClientCAMURI
Description
The URI for the IBM Cognos 8 Server IBM Cognos Connection used to authenticate TM1 clients. The URI is specified in the form:
http[s]://host/cognos8/cgi-bin/cognos.cgi.
Note: Both cognos8 and cognos.cgi are variables and depend on the exact settings that have been used. Contact your IBM Cognos 8 administrator for more information about these settings. For example:
http://10.121.25.121/cognos8/cgi-bin/cognos. cgi.
CAMSSLCertificate
The full path and name of the SSL certificate to be used when connecting to the internal dispatcher. For example,
C:\AxTM1\Install_Dir\ssl\CognosCert.cer.
This parameter is required only if the IBM Cognos 8 server is configured to use SSL. SkipSSLCAMHostCheck Indicates whether the SSL certificate ID confirmation process can be skipped. The default is FALSE. Important: This parameter should be set to TRUE only if using a generic certificate for demonstration purposes. ClientPingCAMPassport Indicates the interval, in seconds, that a client should ping the IBM Cognos 8 server to keep their passport alive. If an error occurs or the passport expires the user will be disconnected from the TM1 server.
Installation Guide 69
Parameter Name
CAMPortalVariableFile
Description
The path to the variables_TM1.xml file in your C8 installation. In most cases, the path will be:
CAMPortalVariableFile = portal\variables_TM1.xml
The variables_TM1.xml file is included as part of the TM1 Viewer Portlets installation. For details on installing and configuring Viewer Portlets, see the IBM Cognos TM1 Installation Guide. The CAMPortalVariableFile parameter is required only when running TM1 Web. The Tm1s.cfg file should contain parameters similar to the following:
ServerCAMURI=http://10.111.25.121:9300/p2pd/servlet/dispatch ClientCAMURI=http://10.111.25.121/cognos8/cgi-bin/cognos.cgi ClientPingCAMPassport=900 CAMPortalVariableFile=templates\ps\portal\variables_TM1.xml
Steps
1. Open the Tm1p.ini configuration file in a text editor. Tm1s.cfg is located in the C:\Documents and Settings\<user name>\Application Data\Applix\TM1 directory. 2. Add the following parameters to the Tm1p.ini file.
Parameter Name
CognosGatewayURI
Description
The URI for the IBM Cognos 8 Server IBM Cognos Connection used to authenticate TM1 clients. The URI is specified in the form http[s]://host/cognos8/cgi-bin/cognos.cgi For example: http://10.121.25.121/cognos8/cgi-bin/
cognos.cgi
70 TM1
Parameter Name
Description
AllowImportCAMClients Determines if Cognos clients can be imported into TM1. This parameter must be set to T when setting up IBM Cognos 8 security in TM1. Your Tm1p.ini file should include parameters similar to the following:
AllowImportCAMClients = T CognosGatewayURI = http://10.111.25.121/cognos8/cgi-bin/cognos.cgi
Steps
1. Log in to your TM1 server as an administrator. 2. From the Server Explorer, click Server, then Security, then Clients/Groups. 3. From the Clients/Groups dialog box, click Clients, then Add New Client. The Cognos logon dialog box appears. 4. Enter your Cognos user ID and password, then click OK. The Select Entries dialog box appears. 5. In the Name box, click the namespace to which you are currently logged in. Note: Only users from the namespace to which you are logged in can be imported into TM1. Other namespaces may appear in the Name box, but you cannot import users from them. The contents of the Name box update to display the directories available on the selected namespace. 6. Enable the Show users in the list option. 7. Navigate to the directory containing the Cognos user you want to define as a TM1 administrator. In most circumstances, you will define your own Cognos user as a TM1 administrator, as you must know the Cognos user's ID and password to complete administrative tasks. 8. Select the user. 9. Click the green arrow button to move the selected user to the Selected Entries list.
Installation Guide 71
Chapter 9: Using IBM Cognos 8 Security with TM1 The user appears as a new client in the Client/Groups window, but is not assigned to any TM1 groups. 11. Assign the new user to the ADMIN group and click OK. 12. Shut down the TM1 server. 13. Open the Tm1s.cfg configuration file in a text editor. 14. Set the IntegratedSecurityMode parameter to 4, indicating that the server should use IBM Cognos 8 authentication.
IntegratedSecurityMode=4.
15. Save and close Tm1s.cfg. 16. Restart the TM1 server.
Steps
1. In the Server Explorer, double-click your TM1 server. The Cognos logon dialog box appears. 2. Log on as the Cognos user that you have defined as a TM1 administrator. 3. From the Server Explorer, click Server, then Security, then Clients/Groups. 4. From the Clients/Groups window, click Groups, then Add New Groups. The Select Entries dialog box appears. 5. In the Names box, click the namespace to which you are currently connected. Note: Only groups from the namespace to which you are connected can be imported into TM1. Other namespaces may appear in the Name box, but you cannot import groups from them. 6. Navigate through the directory structure and select the Cognos groups you want to import into TM1. 7. Click the green arrow button to move the selected user to the Selected Entries list.
8. Click OK to import the Cognos groups into TM1. If you review the User Group Assignment section of the Clients/Groups window, you should see the Cognos groups added to your server.
Creating Users
When a TM1 server is configured to use IBM Cognos 8 authentication, you cannot create new clients directly on the TM1 server. Instead, all client administration is performed in IBM Cognos 8.
72 TM1
Chapter 9: Using IBM Cognos 8 Security with TM1 When a Cognos user accesses TM1, the user is validated and automatically assigned to the appropriate TM1 groups. There is no need to manually assign users to groups in TM1.
Authentication Behavior
The following rules govern authentication behavior when logging on to a TM1 server that uses IBM Cognos 8 authentication. If common logon is enabled in IBM Cognos 8 and you have previously logged in to an IBM Cognos application and maintain an active session, you are not prompted for credentials when logging on to the TM1 server. If common logon is enabled in IBM Cognos 8 and you have not previously logged in to an IBM Cognos application, you are prompted for credentials when logging on to the TM1 server. If common logon is not enabled in IBM Cognos 8, you are prompted for credentials when logging on to the TM1 server, even if the TM1 server is configured to use IBM Cognos 8 authentication.
Installation Guide 73
Chapter 9: Using IBM Cognos 8 Security with TM1 tions (including TM1) which are configured to reference the same IBM Cognos 8 server will automatically occur, provided your Cognos security passport is valid. For example, if you have three available TM1 servers, all configured to use the same IBM Cognos 8 server, once you connect to the first TM1 server as user X in namespace Y, all connections to the other TM1 servers will automatically occur using the passport of user X from namespace Y. In some circumstances, you might want to log on to a TM1 server as a user other than the one identified by your Cognos security passport. To accommodate this, the Logon As option lets you override the automatic authentication that usually occurs with a passport, while maintaining the validity of the passport for later use. When you log on to a TM1 server using the Logon As option, a private session is established. The credentials used to establish the private session are not stored in a passport and are not shared with any other application. Any existing passport remains valid and can be used to access other IBM Cognos 8 security-enabled applications.
Steps
1. From the Server Explorer, click Server, then Logon As. 2. In the Cognos Logon window, enter the User ID and Password you want to use to log on to the TM1 server. 3. Click OK.
74 TM1
Chapter 10: Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services
Before you can use the TM1 Viewer Portlets to view existing TM1 cube views and websheets, you must install them and, if the TM1 data servers are secured against IBM Cognos 8, configure access to IBM Cognos 8 from the TM1 Viewer Portlets. If you no longer use TM1 data sources or plan to upgrade, you can uninstall the TM1 Viewer Portlets.
Steps
1. Stop the IBM Cognos 8 service. 2. Insert the TM1 Viewer Portlets installation CD. 3. If the installation wizard does not start automatically, start the wizard by double-clicking issetup.exe. 4. On the Welcome page, select the language to use for the installation and click Next. Note: Regardless of the language that you select for the installation wizard, all languages for the product are installed. 5. Accept the license agreement and click Next. 6. On the Installation Location page, select the directory where the IBM Cognos 8 Gateway component is installed and click Next. You are prompted for the location of a directory in which to store backup copies of the files that will be overwritten.
Installation Guide 75
Chapter 10: Installing TM1 Viewer Portlets for IBM Cognos 8 Portal Services 7. On the Shortcut Folder page, type the name that you want the shortcut to use and then click Next. 8. Review the installation summary and then click Next. 9. On the Finish page, view the log files if required and then click Finish.
Steps
1. In the c8_location\templates\ps\portal directory, open the variables_TM1.xml file in a text editor. 2. In the line with <url></url>, specify the location for TM1WebLoginHandler.aspx and TM1WebMain.aspx files. For example, <url>http://TM1Webserver/TM1Web/TM1WebLoginHandler.aspx</url><url>http:// TM1Webserver/TM1Web/TM1WebMain.aspx</url> where TM1Webserver is the name of the computer where TM1 Web is running. 3. Add more URL specifications until you have listed every server that is running TM1 Web. 4. Save the file.
Steps
1. From the Start menu, click Programs, IBM Cognos 8, Uninstall IBM Cognos 8, Uninstall IBM Cognos 8. 2. On the Uninstall Language Selection page, select the language for the uninstallation wizard and then click Next. 3. Select IBM Cognos 8 TM1 Viewer Portlets and click Next. 4. When the uninstallation is complete, click Finish. Some files and folders remain on the computer until you remove them manually. If you plan to upgrade, do not delete the files and folders.
76 TM1
You can use these options to "Modify Components" (p. 77), "Repair the TM1 Installation" (p. 78) or "Remove TM1" (p. 79) the TM1 installation.
Modify Components
Follow these steps to modify your current installation, remove or add components, or change installation parameters.
Steps
1. Insert the TM1 installation CD in your CD drive.
Installation Guide 77
Chapter 11: Maintaining and Upgrading Your TM1 Installation If autorun is enabled on your CD drive, the TM1 Installation Wizard displays. If autorun is not enabled, run setup.exe in the installation CD root directory to start the TM1 Installation Wizard. 2. Click Next. 3. Select Modify on the Program Maintenance screen and click Next. 4. Select the TM1 installation package you want to modify. 5. Select the Custom installation type and click Next. The Component Selection screen displays, showing the current state of your TM1 installation. Items currently installed display with a disk drive icon next to the component name. Items not currently installed display with an X next to the name.
Program maintenance does not include changing the location of the TM1 installation directory. To change the location of the installation directory, remove all TM1 files and reinstall TM1 in another location. 6. Click Finish to complete the modifications.
Steps
1. Insert the TM1 installation CD in your CD drive. If autorun is enabled on your CD drive, the TM1 Installation Wizard displays. If autorun is not enabled, run setup.exe in the installation CD root directory to start the TM1 Installation Wizard. 2. Click Next. 3. Select Repair on the Program Maintenance screen. 4. Click Next and answer all subsequent prompts to complete the repair process. The installation program reinstalls your current configuration. It fixes missing or corrupt files, program groups, shortcuts, and registry entries.
78 TM1
Remove TM1
To uninstall all components of TM1, follow these steps.
Steps
1. Create a backup copy of your custom data by coping the contents of the <TM1_Home>\Custom\ directory to a safe place on your hard disk. This directory contains TM1 configuration files that will be re-generated by the TM1 installation. 2. Delete the <TM1_Home>\custom\ directory. 3. From the Control Panel on your computer, choose Add/Remove Programs. 4. In the list of currently installed programs, select IBM Cognos TM1.
Upgrading TM1
TM1 9.4 does not support automatic upgrading from a previous version of TM1. If you are upgrading to TM1 9.4, you must back up your previous TM1 database, uninstall the previous version, install TM1 9.4, then restore your database.
Steps
1. Copy your existing TM1 server data directory to the new <TM1_Install>\Custom\ that is available after you install TM1 9.4. 2. Restore your existing TM1 configuration files to the <TM1_Install>\bin\ directory. 3. Restore your existing custom TM1 Web server pages to the directory containing TM1 Web server pages, usually C:\inetpub\wwwroot\TM1Web.
Installation Guide 79
80 TM1
Index
Symbols
/etc/services, 51 .NET API, 31, 35 .username, 23 + plus sign, 18 64-bit Windows, 43 x86, 47 TM1 Web, 35, 40 Cognos 8 authentication, 67 defining an administrator, 71 importing groups into TM1, 72 Cognos 8 security, 67 CognosGatewayURI, 70 Cognos security passport, 67 components exclude, 18 Perspectives, 32 TM1, 19 TM1 Web, 35, 40 console installation, 57 corrupted installation files, 78
A
Active Server Pages (ASP), 40 Admin Host, 21 Admin Server, 31, 35 Host Machine Name, 25, 26, 39, 44 host name, 28, 32, 40 port #, 28, 32, 40, 44 AllowImportCAMClients, 70 ASP.NET, 40 authentication, 23, 67 for user access to IBM Cognos 8 from TM1 Viewer Portlets, 76 authentication error TM1 Viewer Portlets, 76 autoload, 26
D
default values Perspectives, 32 TM1, 28, 44 TM1 Web, 40 Developer Environment Perspectives, 31 TM1, 19 TM1 Web, 35, 40 Disabled in Windows Services, 48 domains account, 16, 43 installing without, 23 Dundas Charts (c), 40
B
background mode, 58
C
CAMID, 67 CAMPortalVariableFile, 68 CAMSSLCertificate, 68 change button, 18 Choose a Product to Install, 17 Choose Database, 25, 39 ClientCAMURI, 68 ClientPingCAMPassport, 68 Clients Configuration, 26 Perspectives, 31 TM1, 19
E
Edit Directly in Cell, 26 Excel application, 65 exclude components, 18
H
HP/UX, 12, 51
I
IBM Cognos Resource Center, 8
Installation Guide 81
Index IIS web server, 12 installation checklist, 10 checklist for UNIX, 51 console, 57 directory, 18 location screen, 18 options screen, 17 order in 64-bit, 48 silent, 57 troubleshooting, 65 installation prerequisites, 59 installing TM1 Viewer Portlets, 75 Integrated Login, 23, 24, 26 TM1 Web, 38 password, 22 permissions, 40 Perspectives, 31 components list, 31 default values, 32 Planning Sample Data x64, 49 privileges Service Account, 12
R
regional setting, 16 repair installation, 78 ROOT, 12
S
sample data directory, 28, 32, 40, 44 Search Base LDAP, 23 security configuring user access to IBM Cognos 8 from TM1 Viewer Portlets, 76 mode, 28, 40, 44 settings TM1 Web, 38 server name, 39 Perspectives, 31, 35 TM1, 19 TM1 Web, 39, 40 UNIX, 53 ServerCAMURI, 68 Service Account TM1, 12 setup.exe, 16 silent installation, 57 SkipSSLCAMHostCheck, 68 Solaris, 12, 51 SSL, 21 port #, 28, 40, 44 startup property, 12 type, 48 subfeatures, 18
L
language, 16 LDAP authentication, 23 host, 23 port, 23 search base, 23 search field, 23 License Agreement, 16, 54 locale setting, 16 local machine syntax, 23 logging in to TM1 Viewer Portlets authentication error, 76
M
manuals, 31, 35, 40 Microsoft Excel 2000, 59 mixed mode, 24
N
naming conventions x86 and x64, 49
O
ODBC Gateway, 15 Oracle, 10, 51
T
TCP/IP port number, 21, 38, 43 TEMP, 15
P
passport, 67 82 TM1
Index TM1, 26 Admin Server, 15 API, 31, 35 Architect, 35 authentication, 23 Client, 26, 32 Client Configuration, 26 components list, 28, 44 default values, 28, 44 Java API, 31, 35 Perspectives, 31 Perspectives/Architect, 44 Perspectives Client, 31, 35 server, 15, 28, 31, 32, 35, 39, 40, 44, 58 Service Account, 12 Top, 19, 31, 35 Web, 40 TM1 Client, 59 TM1Install.log, 15 Tm1p.ini, 32, 40 Tm1p.xla, 26 TM1 Perspectives, 59 tm1s_start_example, 58 Tm1s.cfg, 39, 44, 49 TM1 Viewer Portlets authentication error, 76 installing, 75 uninstalling, 76
X
XHOST, 51
U
uninstall, 79 uninstalling TM1 Viewer Portlets, 76 UNIX, 10, 51, 58 use integrated login, 26 username, 22, 44
W
Web components, 31, 35, 40 Windows permissions, 40 XP Professional, 47 Workflow installation prerequisites, 59
Installation Guide 83