+ All Categories
Home > Documents > public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33...

public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33...

Date post: 24-Aug-2020
Category:
Upload: others
View: 11 times
Download: 0 times
Share this document with a friend
299
IBM Cognos TM1 Version 10.1.0 Installation and Configuration Guide
Transcript
Page 1: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

IBM Cognos TM1Version 10.1.0

Installation and Configuration Guide

���

Page 2: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

NoteBefore using this information and the product it supports, read the information in “Notices” on page 277.

Product Information

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

Microsoft product screen shot(s) used with permission from Microsoft.

Licensed Materials - Property of IBM

© Copyright IBM Corporation 2007, 2012.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 3: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Contents

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Chapter 1. What's new for Cognos TM1 installation and configuration . . . . . . . . . 1New features in version 10.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

New installation programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Default installation directory on Windows . . . . . . . . . . . . . . . . . . . . . . . . 1New Cognos components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Cognos Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2New sample databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Apache Tomcat included with the installation . . . . . . . . . . . . . . . . . . . . . . . 3Support for IPv6 IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3New installation and configuration guide. . . . . . . . . . . . . . . . . . . . . . . . . 3

Changed features in version 10.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Cognos TM1 Admin Server and configuration now managed in Cognos Configuration . . . . . . . . . 3User account needs to be set for Cognos TM1 components running as Microsoft Windows services . . . . . 4Cognos TM1 Contributor renamed to Cognos TM1 Applications . . . . . . . . . . . . . . . . . 4Parallel Interaction concurrency set by default . . . . . . . . . . . . . . . . . . . . . . . 4Prerequisite software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Language selection and configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 5Security and authentication configuration. . . . . . . . . . . . . . . . . . . . . . . . . 5Cognos TM1 Admin Server port numbers . . . . . . . . . . . . . . . . . . . . . . . . 5Silent installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2. Planning your Cognos TM1 installation . . . . . . . . . . . . . . . . . 7Available installation programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Available components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Default installation values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Configuration overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Cognos Configuration and Cognos TM1 . . . . . . . . . . . . . . . . . . . . . . . . . 15Cognos TM1 configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . 16

User accounts for running Cognos TM1 services on Windows . . . . . . . . . . . . . . . . . . 17Confirming the proper installation of Microsoft .NET Framework . . . . . . . . . . . . . . . . . 17

Enabling Cognos TM1 Excel Service . . . . . . . . . . . . . . . . . . . . . . . . . . 18Defining the ASPNET user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Cognos TM1 Web requires Microsoft Chart Controls component . . . . . . . . . . . . . . . . . . 19Installing TM1 on Networks without domains . . . . . . . . . . . . . . . . . . . . . . . . 19

Local machine syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 3. Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Cognos TM1 architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Cognos TM1 Admin Server overview. . . . . . . . . . . . . . . . . . . . . . . . . . 22Cognos TM1 Server overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Cognos TM1 files overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Data directory overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Cognos TM1 Web architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Accessing multiple Cognos TM1 servers from Cognos TM1 Web . . . . . . . . . . . . . . . . 28Limiting access to a single Cognos TM1 server from Cognos TM1 Web . . . . . . . . . . . . . . 28

Cognos TM1 Applications architecture . . . . . . . . . . . . . . . . . . . . . . . . . . 29Cognos TM1 Applications Tier 1: Web clients . . . . . . . . . . . . . . . . . . . . . . . 30Cognos TM1 Applications Tier 2: Web servers . . . . . . . . . . . . . . . . . . . . . . . 31Cognos TM1 Applications Tier 3: Data . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 4. Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

© Copyright IBM Corp. 2007, 2012 iii

Page 4: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Deploying Cognos TM1 on a single Windows computer . . . . . . . . . . . . . . . . . . . . 33Deploying Cognos TM1 Admin Server and TM1 Server . . . . . . . . . . . . . . . . . . . . 34Deploying Cognos TM1 Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Deploying Cognos TM1 Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Security considerations for Cognos TM1 Applications . . . . . . . . . . . . . . . . . . . . 35Deploying all Cognos TM1 Applications components on a single computer . . . . . . . . . . . . . 36Deploying Cognos TM1 Applications components on separate computers . . . . . . . . . . . . . 37

Deploying Cognos TM1 client applications . . . . . . . . . . . . . . . . . . . . . . . . . 38Deploying Cognos TM1 with Cognos Business Intelligence . . . . . . . . . . . . . . . . . . . 39

Chapter 5. Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Planning the upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Stopping Cognos TM1 services before upgrading . . . . . . . . . . . . . . . . . . . . . . . 44Backing up data for a previous version of Cognos TM1. . . . . . . . . . . . . . . . . . . . . 45Uninstalling a previous version of IBM Cognos TM1 . . . . . . . . . . . . . . . . . . . . . 46Upgrading a single computer installation of Cognos TM1 . . . . . . . . . . . . . . . . . . . . 46Upgrading Cognos TM1 Server on UNIX or Linux . . . . . . . . . . . . . . . . . . . . . . 47Upgrading Cognos TM1 Server on Windows . . . . . . . . . . . . . . . . . . . . . . . . 47Upgrading Cognos TM1 Architect and Perspectives clients . . . . . . . . . . . . . . . . . . . 47Upgrading Cognos TM1 Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Upgrading Cognos TM1 Contributor to Cognos TM1 Applications . . . . . . . . . . . . . . . . . 48Restoring data from a previous version into Cognos TM1 . . . . . . . . . . . . . . . . . . . . 50

Chapter 6. Cognos TM1 single-computer installation . . . . . . . . . . . . . . . . 53Install the prerequisite software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Install the basic Cognos TM1 components . . . . . . . . . . . . . . . . . . . . . . . . . 54Use Cognos Configuration to start the Cognos TM1 components . . . . . . . . . . . . . . . . . 55Run Cognos TM1 Perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Run Cognos TM1 Architect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Run Cognos TM1 Web. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Run the Cognos TM1 Applications portal . . . . . . . . . . . . . . . . . . . . . . . . . 58Run Cognos TM1 Performance Modeler . . . . . . . . . . . . . . . . . . . . . . . . . . 58Run Cognos Insight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Use Cognos TM1 Application Web . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Other Cognos TM1 components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Configuring client computers to export Cognos TM1 data in PDF format . . . . . . . . . . . . . . . 60

Chapter 7. Cognos TM1 Server installation . . . . . . . . . . . . . . . . . . . . 63Installing Cognos TM1 Server on Windows . . . . . . . . . . . . . . . . . . . . . . . . . 63

Install Cognos TM1 Server components on Windows . . . . . . . . . . . . . . . . . . . . 63Use Cognos Configuration to start Cognos TM1 servers on Windows . . . . . . . . . . . . . . . 64

Installing Cognos TM1 Server on UNIX or Linux . . . . . . . . . . . . . . . . . . . . . . . 65Install Cognos TM1 Server components on UNIX or Linux operating systems . . . . . . . . . . . . 65Running Cognos TM1 on IBM AIX . . . . . . . . . . . . . . . . . . . . . . . . . . 67Cognos TM1 Object Names and Character Encoding for Cognos TM1 Servers on UNIX and Windows Systems 68

Creating a new empty Cognos TM1 server in Cognos Configuration . . . . . . . . . . . . . . . . 69Adding an existing Cognos TM1 server in Cognos Configuration . . . . . . . . . . . . . . . . . 70Specifying the location of the Cognos TM1 Admin Host . . . . . . . . . . . . . . . . . . . . 70Specifying multiple Cognos TM1 Admin Hosts . . . . . . . . . . . . . . . . . . . . . . . 71

Chapter 8. Cognos TM1 Web installation . . . . . . . . . . . . . . . . . . . . . 73Install prerequisite software for Cognos TM1 Web . . . . . . . . . . . . . . . . . . . . . . 73Configure IIS 7 to run Cognos TM1 Web on Windows Vista, Windows 7, and Windows Server 2008. . . . . . 74Install and configure Cognos TM1 Web . . . . . . . . . . . . . . . . . . . . . . . . . . 74Configuring the Login Page using AdminHostName and TM1ServerName . . . . . . . . . . . . . . 76

Chapter 9. Cognos TM1 Applications installation . . . . . . . . . . . . . . . . . 77Installing Cognos TM1 Applications with the provided Apache Tomcat . . . . . . . . . . . . . . . 78

Installing Cognos TM1 Applications . . . . . . . . . . . . . . . . . . . . . . . . . . 78Deploying the Cognos TM1 Application Server with the provided Tomcat web application server . . . . . 78

iv IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 5: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Configuring authentication security for Cognos TM1 Applications . . . . . . . . . . . . . . . . 79Configuring the server and client environment for Cognos TM1 Applications . . . . . . . . . . . . 80

Install Cognos TM1 Applications with your own installation of Apache Tomcat web application server. . . . . 81Installing Cognos TM1 Applications . . . . . . . . . . . . . . . . . . . . . . . . . . 81Use IBM Cognos Configuration to build an application file for a Tomcat server. . . . . . . . . . . . 82Configuring authentication security for Cognos TM1 Applications . . . . . . . . . . . . . . . . 82Configuring the server and client environment for Cognos TM1 Applications . . . . . . . . . . . . 83

Install Cognos TM1 Applications with your own installation of IBM Websphere . . . . . . . . . . . . 85Installing Cognos TM1 Applications . . . . . . . . . . . . . . . . . . . . . . . . . . 85Using IBM Cognos Configuration to build an application file for a IBM Websphere . . . . . . . . . . 86Deploy Cognos TM1 Application Server with WebSphere Application Server . . . . . . . . . . . . 86Configuring authentication security for Cognos TM1 Applications . . . . . . . . . . . . . . . . 87Configuring the server and client environment for Cognos TM1 Applications . . . . . . . . . . . . 88

Determining the URL startup link for Cognos TM1 Applications . . . . . . . . . . . . . . . . . 90Configuring a Cognos TM1 Server to work with Cognos TM1 Applications . . . . . . . . . . . . . . 91

Chapter 10. Cognos TM1 client installation . . . . . . . . . . . . . . . . . . . . 93Installing Cognos TM1 Perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Installing Cognos TM1 Architect . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Installing Cognos TM1 Performance Modeler . . . . . . . . . . . . . . . . . . . . . . . . 96

Installing Cognos TM1 Performance Modeler using the installation program . . . . . . . . . . . . 96Installing Cognos TM1 Performance Modeler from the Cognos Applications Portal . . . . . . . . . . 97Remotely installing Cognos TM1 Performance Modeler on multiple computers . . . . . . . . . . . . 97

Installing Cognos Insight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Installing Cognos Insight using the installation program . . . . . . . . . . . . . . . . . . . 100Installing Cognos Insight from the Cognos Applications Portal . . . . . . . . . . . . . . . . . 101Remotely installing Cognos Insight on multiple computers . . . . . . . . . . . . . . . . . . 101

Chapter 11. Cognos TM1 sample databases installation . . . . . . . . . . . . . . 105Using the SData sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Using the Planning Sample database . . . . . . . . . . . . . . . . . . . . . . . . . . 106Using the GO_New_Stores sample . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Set up the GO Contributor sample . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Set up the Great Outdoors Company sample . . . . . . . . . . . . . . . . . . . . . . . . 108Using the TM1 server samples based on the sample database . . . . . . . . . . . . . . . . . . 109

Restoring backup files for IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . 109Restoring backup files for Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Restoring backup files for Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . 114Setting up Great Outdoors Sales sample . . . . . . . . . . . . . . . . . . . . . . . . 115

Chapter 12. Installing the Cognos TM1 Operations Console . . . . . . . . . . . . 117Using the provided Apache Tomcat with the Cognos TM1 Operations Console . . . . . . . . . . . . 118

Add certificates to the JRE keystore . . . . . . . . . . . . . . . . . . . . . . . . . . 118Deploy Cognos TM1 Operations Console with the provided version of Apache Tomcat. . . . . . . . . 118Create a user group for the Cognos TM1 Operations Console . . . . . . . . . . . . . . . . . 119Edit the OpsConfig.xml file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Configure Microsoft Internet Explorer 8 for the Cognos TM1 Operations Console . . . . . . . . . . 120Start and log into the Cognos TM1 Operations Console . . . . . . . . . . . . . . . . . . . 120

Using your own version of Apache Tomcat . . . . . . . . . . . . . . . . . . . . . . . . 121Verify JRE user environment variable . . . . . . . . . . . . . . . . . . . . . . . . . 121Add certificates to the JRE keystore . . . . . . . . . . . . . . . . . . . . . . . . . . 121Deploy the Cognos TM1 Operations Console . . . . . . . . . . . . . . . . . . . . . . . 122Create a user group for the Cognos TM1 Operations Console . . . . . . . . . . . . . . . . . 123Edit the OpsConfig.xml file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Configure Microsoft Internet Explorer 8 for the Cognos TM1 Operations Console . . . . . . . . . . 124Start and log into the Cognos TM1 Operations Console . . . . . . . . . . . . . . . . . . . 124

Using Websphere 7.0 and 8.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Import Websphere certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Deploying Cognos TM1 Operations Console on Websphere . . . . . . . . . . . . . . . . . . 126Starting the Cognos TM1 Operations Console on Websphere . . . . . . . . . . . . . . . . . 127

Contents v

Page 6: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 13. Cognos TM1 tools installation . . . . . . . . . . . . . . . . . . . . 129

Chapter 14. Cognos TM1 and Cognos Business Intelligence interoperabilityinstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Install Cognos TM1 BI interoperability . . . . . . . . . . . . . . . . . . . . . . . . . . 131Configure Cognos TM1 BI interoperability to use IBM Cognos Security . . . . . . . . . . . . . . . 132Configure Cognos BI for Cognos TM1 Viewer Portlets. . . . . . . . . . . . . . . . . . . . . 132Uninstall Cognos TM1 BI interoperability . . . . . . . . . . . . . . . . . . . . . . . . . 133Enabling Cognos BI reporting on Cognos TM1 data sources . . . . . . . . . . . . . . . . . . . 133

Chapter 15. Cognos TM1 Package Connector installation . . . . . . . . . . . . . 135Cognos TM1 Package Connector requirements . . . . . . . . . . . . . . . . . . . . . . . 135Installing the Cognos TM1 Package Connector . . . . . . . . . . . . . . . . . . . . . . . 135

Installing the Cognos TM1 Package Connector on Windows 7 or Vista . . . . . . . . . . . . . . 136Enabling connectivity to SAP from Cognos TM1. . . . . . . . . . . . . . . . . . . . . . . 136Configuring the Cognos TM1 Package Connector . . . . . . . . . . . . . . . . . . . . . . 136

Setting the environment variable . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Setting the Cognos TM1 server configuration parameter (optional) . . . . . . . . . . . . . . . 137Cognos TM1 Package Connector on the client computer . . . . . . . . . . . . . . . . . . . 138

Running the TM1 Package Connector . . . . . . . . . . . . . . . . . . . . . . . . . . 138Installing the Cognos TM1 Package Connector on UNIX . . . . . . . . . . . . . . . . . . . . 138

Chapter 16. Cognos TM1 Workflow Installation . . . . . . . . . . . . . . . . . . 139

Chapter 17. Advanced configuration . . . . . . . . . . . . . . . . . . . . . . 141Changing Cognos TM1 services to run as a specific user account on Windows . . . . . . . . . . . . 141Cognos TM1 language configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Cognos TM1 language codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Configuring language for the Cognos TM1 server . . . . . . . . . . . . . . . . . . . . . 143Configuring language for Cognos TM1 clients on Windows . . . . . . . . . . . . . . . . . . 144Configuring language in Internet Explorer for Cognos TM1 Web . . . . . . . . . . . . . . . . 145

Changing default port numbers for Cognos TM1 Admin Server . . . . . . . . . . . . . . . . . 145Configuring Cognos TM1 to use IPv6 . . . . . . . . . . . . . . . . . . . . . . . . . . 145Configuring client computers to export Cognos TM1 data in PDF format . . . . . . . . . . . . . . 147Cognos TM1 Web advanced configuration. . . . . . . . . . . . . . . . . . . . . . . . . 147

Configuring the Login Page using AdminHostName and TM1ServerName . . . . . . . . . . . . . 148Configuring language in Internet Explorer for Cognos TM1 Web . . . . . . . . . . . . . . . . 149Displaying and Entering Numbers Based on Regional Settings . . . . . . . . . . . . . . . . . 149Configuring Internet Explorer for Cognos TM1 Web . . . . . . . . . . . . . . . . . . . . 149Running Cognos TM1 Web in Firefox Web Browser . . . . . . . . . . . . . . . . . . . . 150Running the 64-bit version of Cognos TM1 Web on Windows x64 . . . . . . . . . . . . . . . . 150Running Cognos TM1 Web on a WAN Server and exporting Excel and PDF files . . . . . . . . . . . 151Using ClearType on Cognos TM1 Web Server to Enhance Display and Rendering of Websheets . . . . . . 152Configuring Cognos TM1 Web to Run in Windows Vista . . . . . . . . . . . . . . . . . . . 152

Cognos TM1 Applications advanced configuration . . . . . . . . . . . . . . . . . . . . . . 153Using Cognos TM1 Applications with Cognos Business Intelligence Security . . . . . . . . . . . . 153Deploying Cognos TM1 Applications on the Cognos BI web server . . . . . . . . . . . . . . . 156Configuring Cognos TM1 Applications with Microsoft IIS . . . . . . . . . . . . . . . . . . 157Configuring Cognos TM1 Applications to use Multiple Cognos TM1 Servers . . . . . . . . . . . . 158Font for Cognos TM1 Applications Export to PDF . . . . . . . . . . . . . . . . . . . . . 159Configuring Cognos TM1 TurboIntegrator function security in Insight . . . . . . . . . . . . . . 159

Chapter 18. Security configuration . . . . . . . . . . . . . . . . . . . . . . . 163Authentication security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Overview to authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163ETLDAP utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Integrated Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176LDAP Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Using Cognos security with Cognos TM1 . . . . . . . . . . . . . . . . . . . . . . . . 186

vi IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 7: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Using SSL for data transmission security . . . . . . . . . . . . . . . . . . . . . . . . . 192Overview to using SSL for data transmission security . . . . . . . . . . . . . . . . . . . . 192Generated certificates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Configuring the Cognos TM1 Admin Server to use SSL . . . . . . . . . . . . . . . . . . . 194Configuring the Cognos TM1 Server to use SSL . . . . . . . . . . . . . . . . . . . . . . 196Configuring Cognos TM1 clients to use SSL . . . . . . . . . . . . . . . . . . . . . . . 199Configuring Cognos TM1 Web to use SSL . . . . . . . . . . . . . . . . . . . . . . . . 200Configuring Cognos TM1 Applications to use SSL . . . . . . . . . . . . . . . . . . . . . 201Configuring the Cognos TM1 Top Utility to use SSL . . . . . . . . . . . . . . . . . . . . 203Configuring the TM1 C API to Use SSL . . . . . . . . . . . . . . . . . . . . . . . . 203Configuring the Cognos TM1 Java API to use SSL . . . . . . . . . . . . . . . . . . . . . 203Configuring the Cognos TM1 ETLDAP Utility to use SSL . . . . . . . . . . . . . . . . . . 204Using independent certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Chapter 19. Maintenance of your Cognos TM1 10.1 installation . . . . . . . . . . . 211Backing up data for Cognos TM1 10.1 . . . . . . . . . . . . . . . . . . . . . . . . . . 211Modifying Cognos TM1 installed components . . . . . . . . . . . . . . . . . . . . . . . 212Uninstalling Cognos TM1 10.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Uninstalling Cognos TM1 Applications . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Backup your Cognos TM1 Applications data . . . . . . . . . . . . . . . . . . . . . . . 213Exporting applications from Cognos TM1 10.1 Applications . . . . . . . . . . . . . . . . . . 214Stopping related services in Cognos TM1 10.1 . . . . . . . . . . . . . . . . . . . . . . 214Uninstalling Cognos TM1 10.1 Applications . . . . . . . . . . . . . . . . . . . . . . . 214Undeploy Cognos TM1 Applications in Apache Tomcat . . . . . . . . . . . . . . . . . . . 214Undeploy Cognos TM1 Applications in WebSphere. . . . . . . . . . . . . . . . . . . . . 215Importing applications from the current version back into the current version Cognos TM1 Applications . . . 215

Appendix A. Accessibility features . . . . . . . . . . . . . . . . . . . . . . . 217Keyboard shortcuts for the installation wizard . . . . . . . . . . . . . . . . . . . . . . . 217Keyboard shortcuts for Cognos Configuration . . . . . . . . . . . . . . . . . . . . . . . 218

Appendix B. The Tm1s.cfg Server Configuration File . . . . . . . . . . . . . . . 219Location of the Tm1s.cfg File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Sample Tm1s.cfg File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Parameters in the Tm1s.cfg File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

AdminHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221AllowReadOnlyChore Reschedule . . . . . . . . . . . . . . . . . . . . . . . . . . 221AllowSeparateNandCRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221AllRuleCalcStargateOptimization . . . . . . . . . . . . . . . . . . . . . . . . . . . 222AuditLogMaxFileSize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222AuditLogMaxQueryMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223AuditLogMaxTempFileSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223AuditLogOn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223AuditLogUpdateInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224CalculationThresholdForStorage . . . . . . . . . . . . . . . . . . . . . . . . . . . 224CAMSSLCertificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224CheckFeedersMaximumCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224ClientCAMURI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225ClientPingCAMPassport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225CAMPortalVariableFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225ClientMessagePortNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226ClientPropertiesSyncInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226ClientVersionMaximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226ClientVersionMinimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227ClientVersionPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228CognosInterfacePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229DataBaseDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229DefaultMeasuresDimension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229DisableMemoryCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229DisableSandboxing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Contents vii

Page 8: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

DisableWorksheetView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Display_Info_DBType_R8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230DistributedPlanningOutputDir . . . . . . . . . . . . . . . . . . . . . . . . . . . 231DownTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231ExcelWebPublishEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232ForceReevaluationOfFeedersForFedCellsOnDataChange . . . . . . . . . . . . . . . . . . . 232GroupsCreationLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233IdleConnectionTimeOutSeconds . . . . . . . . . . . . . . . . . . . . . . . . . . . 234IntegratedSecurityMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234IPAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235IPVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236JobQueuing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237JobQueueMaxWaitTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237JobQueueThreadPoolSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237JobQueueThreadSleepTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238LDAPUseServerAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239LDAPPasswordFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239LDAPPasswordKeyFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239LockPagesInMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239LoggingDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240LogReleaseLineCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240MaskUserNameInServerTools . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240MaximumCubeLoadThreads . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241MaximumLoginAttempts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241MaximumMemoryForSubsetUndo . . . . . . . . . . . . . . . . . . . . . . . . . . 242MaximumSynchAttempts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242MaximumTILockObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243MaximumUserSandboxSize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243MaximumViewSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243MaxUndoHoldLineCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244MessageCompression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244NetRecvBlockingWaitLimitSeconds . . . . . . . . . . . . . . . . . . . . . . . . . . 244NetRecvMaxClientIOWaitWithinAPIsSeconds. . . . . . . . . . . . . . . . . . . . . . . 245ParallelInteraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245PasswordMinimumLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245PasswordSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245PerformanceMonitorOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246PersistentFeeders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246PortNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246PrivilegeGenerationOptimization . . . . . . . . . . . . . . . . . . . . . . . . . . . 247ProgressMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247ProportionSpreadToZeroCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248RawStoreDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249ReceiveProgressResponseTimeoutSecs . . . . . . . . . . . . . . . . . . . . . . . . . 249RunningInBackground . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250RulesOverwriteCellsOnLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250SAPLoggingEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250SAPLogFilePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250SaveTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251SecurityPackageName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251ServerCAMURI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251ServerLogging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251ServerName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252ServicePrincipalName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252SkipLoadingAliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252SkipSSLCAMHostCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253SpreadingPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253SpreadingPrecision (Consolidated Holds) . . . . . . . . . . . . . . . . . . . . . . . . 254SubsetElementBreatherCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254StartupChores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

viii IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 9: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

SyncUnitSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255UserDefinedCalculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255UseLocalCopiesforPublicDynamicSubsets . . . . . . . . . . . . . . . . . . . . . . . . 256UseSQLFetch UseSQLFetchScroll UseSQLExtendedFetch . . . . . . . . . . . . . . . . . . . 256UseSSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256UseStargateForRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ViewConsolidationOptimization . . . . . . . . . . . . . . . . . . . . . . . . . . . 257ViewConsolidationOptimizationMethod . . . . . . . . . . . . . . . . . . . . . . . . 258

Appendix C. The Tm1p.ini Client Configuration File . . . . . . . . . . . . . . . . 259Location of the Tm1p.ini File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Parameters in the Tm1p.ini file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

AdminHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259AdminSvrSSLCertAuthority . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260AdminSvrSSLCertID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260AdminSvrSSLCertRevList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260AdminSvrSSLExportKeyID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260AdvancedRulesEditor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260AllowImportCamClients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260BrowseDisplayReadsRightToLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . 261ClassicSliceMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261CognosGatewayURI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261ConnectLocalAtStartup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261DataBaseDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261DimensionDownloadMaxSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261DisplayApplications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261DisplayChores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262DisplayControlCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262DisplayCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262DisplayDimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262DisplayExplorerPropertiesWindow . . . . . . . . . . . . . . . . . . . . . . . . . . 262DisplayProcesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262DisplayReplications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262ExpandRowHeaderWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262ExportAdminSvrSSLCert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262InSpreadsheetBrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263IntegratedLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263LocalServerNetworkProtocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264MainWindowLayoutInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264PreviousAdminHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264PreviousDataDirectories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264SecurityAssignmentWindowLayoutInfo. . . . . . . . . . . . . . . . . . . . . . . . . 264SentMsgsToServerCountWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . 264ShowAdminHostChangeWarning. . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowAliasAttributeWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowChoresSchedulingWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowCubeReplicationWarning. . . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowDimDeleteElementWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowDimensionAccessWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowDynamicSubsetWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowPickOperationWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265ShowProcessUNASCIIWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . 266ShowProcessUNODBCWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . 266SliceNewWorkbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266SubsetWindowLayoutInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266TM1RebuildDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Appendix D. Setting up unattended installations and configurations. . . . . . . . . 269Unattended installations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Contents ix

Page 10: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Setting up an unattended installation . . . . . . . . . . . . . . . . . . . . . . . . . 269Setting up an unattended configuration . . . . . . . . . . . . . . . . . . . . . . . . . 270Setting up an unattended uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . 271

Appendix E. Troubleshooting a problem . . . . . . . . . . . . . . . . . . . . . 273Cognos Information Centers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Support Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Gathering information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Service requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Support Assistant Lite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Cognos Customer Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274Fix Central . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275Problem determination tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275Forums and communities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275Business Analytics Support Notebook . . . . . . . . . . . . . . . . . . . . . . . . . . 275Software Support RSS feeds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275Searching and navigating Cognos products . . . . . . . . . . . . . . . . . . . . . . . . 275

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

x IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 11: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Introduction

This document describes how to install, upgrade, and configure IBM® Cognos®

TM1® software components on Microsoft Windows and UNIX operating systems.

Audience

IBM Cognos TM1 integrates business planning, performance measurement, andoperational data to enable companies to optimize business effectiveness andcustomer interaction regardless of geography or structure. Cognos TM1 providesimmediate visibility into data, accountability within a collaborative process, and aconsistent view of information, allowing managers to quickly stabilize operationalfluctuations and take advantage of new opportunities.

To use this guide, you should be familiar with:v installation conceptsv security issuesv basic Windows or UNIX administration skillsv the existing server environment and security infrastructure in your organizationv your Cognos TM1 system and network requirements

Finding information

To find IBM Cognos product documentation on the web, including all translateddocumentation, access one of the IBM Cognos Information Centers(http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp). ReleaseNotes are published directly to Information Centers, and include links to the latesttechnotes and APARs.

Accessibility features

Accessibility features help users who have a physical disability, such as restrictedmobility or limited vision, to use information technology products. The installationwizard has accessibility features. For information on these features, see theaccessibility section in this document.

IBM Cognos HTML documentation has accessibility features. PDF documents aresupplemental and, as such, include no added accessibility features.

Forward-looking statements

This documentation describes the current functionality of the product. Referencesto items that are not currently available may be included. No implication of anyfuture availability should be inferred. Any such references are not a commitment,promise, or legal obligation to deliver any material, code, or functionality. Thedevelopment, release, and timing of features or functionality remain at the solediscretion of IBM.

Samples disclaimer

The Great Outdoors Company, GO Sales, any variation of the Great Outdoorsname, and Planning Sample depict fictitious business operations with sample data

© Copyright IBM Corp. 2007, 2012 xi

Page 12: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

used to develop sample applications for IBM and IBM customers. These fictitiousrecords include sample data for sales transactions, product distribution, finance,and human resources. Any resemblance to actual names, addresses, contactnumbers, or transaction values is coincidental. Other sample files may containfictional data manually or machine generated, factual data compiled fromacademic or public sources, or data used with permission of the copyright holder,for use as sample data to develop sample applications. Product names referencedmay be the trademarks of their respective owners. Unauthorized duplication isprohibited.

xii IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 13: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 1. What's new for Cognos TM1 installation andconfiguration

This section contains a list of new, changed, and removed features for this release.

It will help you plan your upgrade and application deployment strategies and thetraining requirements for your users.

To locate the most current product documentation, go to the IBM Cognos TM110.1.0 Information Center (http://publib.boulder.ibm.com/infocenter/ctm1/v10r1m0/index.jsp).

To review an up-to-date list of environments supported by IBM Cognos products,such as operating systems, patches, browsers, web servers, directory servers,database servers, and application servers, visit the Cognos Customer Center(http://www.ibm.com/software/data/support/cognos_crc.html).

New features in version 10.1.0These are the new installation features and configuration steps for IBM CognosTM1 since the last release.

New installation programsThis release includes a new installation wizard user interface and a new collectionof installation programs.

The installation wizard program is now based on the standard IBM Cognosinstallation program. The installation programs and component selection are noworganized to emphasize the architecture of IBM Cognos TM1 and better assist withdeployments ranging from a single computer to deployments across multiplecomputers in a network environment.

For details, see the following topics:v “Available installation programs” on page 7v “Available components” on page 8

Default installation directory on WindowsThis release includes a new installation wizard user interface and a new collectionof installation programs.

The installation program now uses the following default installation directorywhen you install on Microsoft Windows:

C:\Program Files\IBM\cognos\tm1

For example, IBM Cognos TM1 Web is now installed here:

C:\Program Files\IBM\cognos\tm1\TM1Web

© Copyright IBM Corp. 2007, 2012 1

Page 14: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

New Cognos componentsThis release includes the following new components:

IBM Cognos TM1 Operations Console - A new component for administrators.This component requires configuration and deployment on a Java-based webapplication server.

IBM Cognos TM1 Performance Modeler - Enables developers to build planningand analysis models in the Cognos TM1 environment. Accessible from CognosTM1 Applications.

IBM Cognos Insight - Provides the power to analyze data, explore scenarios, andinfluence decisions by creating managed workspaces. Use these workspaces tocommunicate results to line-of-business managers as interactive managedworkspaces. Because Cognos Insight supports write-back, you can also use theseworkspaces to gather and consolidate management targets, commitments, andforecasts.

Cognos ConfigurationThe IBM Cognos Configuration utility is provided with this release to managecommon tasks and configuration for the following IBM Cognos TM1 components.v IBM Cognos TM1 Admin Serverv IBM Cognos TM1 Serverv IBM Cognos TM1 Excel Servicev IBM Cognos TM1 Application Serverv IBM Cognos TM1 Application Gateway

Cognos Configuration must be installed on at least one computer to run the TM1Admin Server.

Important: Change the following Cognos TM1 services that are created by CognosConfiguration so that the services run under a specific user account on MicrosoftWindows:v Cognos TM1 Admin Serverv Cognos TM1 Serverv Cognos TM1 Excel service

For details, see:v “User accounts for running Cognos TM1 services on Windows” on page 17.v “Changing Cognos TM1 services to run as a specific user account on Windows”

on page 141.

New sample databasesA new sample database is available that is designed to work with IBM CognosTM1 Applications called GO_New_stores

This sample database is installed by default into the TM1_location/sampleslocation. See Chapter 11, “Cognos TM1 sample databases installation,” on page 105.

2 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 15: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Apache Tomcat included with the installationThis release includes a version of the Apache Tomcat web application server foruse with the following components:v IBM Cognos TM1 Application Serverv IBM Cognos TM1 Operations Console

An instance of Apache Tomcat is automatically installed when you install theCognos TM1 Applications components.

Support for IPv6 IP AddressesThis release includes support for the IPv6 IP address convention.

IBM Cognos TM1 now supports two IP address protocols: IPv4 and IPv6. IPv4uses 32-bit IP addresses and IPv6 uses 128-bit IP addresses. The default is IPv4.

For more information, see “Configuring Cognos TM1 to use IPv6” on page 145.

New installation and configuration guideThe installation documentation is reorganized.

The new IBM Cognos TM1 Installation and Configuration Guide. provides a morecomprehensive combination of installation and configuration topics includingarchitecture, deployment, configuration parameters, and security configuration.

The following topics were moved from the IBM Cognos TM1 Operation Guide to theIBM Cognos TM1 Installation and Configuration Guide:v Cognos TM1 system architecturev Tm1s.cfg server configuration file and parametersv Tm1p.ini client configuration file and parametersv Cognos TM1 authentication and SSL security configuration

Changed features in version 10.1.0Listed below are changes to the installation and configuration for IBM CognosTM1 since the last release.

Cognos TM1 Admin Server and configuration now managed inCognos Configuration

The IBM Cognos Configuration utility is provided with this release to managecommon tasks and configuration for the following IBM Cognos TM1 components.

As of IBM Cognos TM1 version 10.1.0, the TM1 Admin Server configuration file,Tm1admsrv.ini, is no longer used or supported by Cognos TM1.

The configuration settings for the Cognos TM1 Admin Server are now exclusivelyconfigured and stored in the IBM Cognos Configuration tool. You must useCognos Configuration to configure the Cognos TM1 Admin Server. CognosConfiguration also starts and stops the Cognos TM1 Admin server.

Chapter 1. What's new for Cognos TM1 installation and configuration 3

Page 16: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

User account needs to be set for Cognos TM1 componentsrunning as Microsoft Windows services

The IBM Cognos Configuration tool registers Cognos TM1 components asWindows services using the predefined Local System account. You will need tochange these services to run as a specific user.

Important: Change the following Cognos TM1 services to run under a specificuser account on Microsoft Windows:v Cognos TM1 Admin Serverv Cognos TM1 Serverv Cognos TM1 Excel service

Earlier versions of Cognos TM1 allowed you to specify a specific user for theinstalled services during the installation process. Because the current process doesnot prompt you for a user account, you will need to manually change anyWindows service created by the Cognos Configuration tool.

For details, see:v “User accounts for running Cognos TM1 services on Windows” on page 17.v “Changing Cognos TM1 services to run as a specific user account on Windows”

on page 141.

Cognos TM1 Contributor renamed to Cognos TM1Applications

IBM Cognos TM1 Contributor and its subcomponents have been renamed for thisrelease.v The overall component is now called IBM Cognos TM1 Applications.v The web server components are now called IBM Cognos TM1 Application Server

and IBM Cognos TM1 Application Gateway.v The previous component for designing applications has been replaced by the

new component IBM Cognos TM1 Performance Modeler.

Parallel Interaction concurrency set by defaultThe Parallel Interaction feature introduced in the previous release is now on bydefault.

Improvements to concurrency processing achieved used the Parallel Interactionfeature are now automatically available to all users by default. Previously aconfiguration parameter needed to be set to use this feature.

For details about this feature, see the "Using Parallel Interaction with a CognosTM1 server" topic in the IBM Cognos TM1 Operation Guide.

For details about this parameter, see “ParallelInteraction” on page 245.

Prerequisite softwareSome third-party components are required and need to be installed beforeinstalling IBM Cognos TM1.

Download and install these components on the target system before installing therelated Cognos TM1 components.

4 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 17: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

For details, see “Software requirements” on page 13.

For the latest information about prerequisite software, see Cognos TM1 10.1.0Software Environments (www.ibm.com/support/docview.wss?uid=swg27021976).

Language selection and configurationSelecting a language during the installation applies only to the installation programand no longer sets the language for the installed version of IBM Cognos TM1.

The language for the different Cognos TM1 user interfaces and messages is nowautomatically set by detecting the current language in your operating system orweb browser at runtime.

To set a specific language for Cognos TM1, you now configure this option aftercompleting the installation.

See “Cognos TM1 language configuration” on page 142.

Security and authentication configurationThe installation program does not provide an option to select login security forIntegrated Login or LDAP authentication.

You must configure security manually after you complete the installation. SeeChapter 18, “Security configuration,” on page 163.

Cognos TM1 Admin Server port numbersIf you change the default IBM Cognos TM1 Admin Server host or Cognos TM1Admin Server SSL port numbers in Cognos Configuration, you must manuallyupdate the new values in the UNIX and Microsoft Windows services file.

This operating system file is not updated by Cognos TM1.

For details, see “Changing default port numbers for Cognos TM1 Admin Server”on page 145.

Silent installationThe silent (unattended) installation options and usage have changed from previousCognos TM1 versions.

See “Unattended installations” on page 269.

Chapter 1. What's new for Cognos TM1 installation and configuration 5

Page 18: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

6 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 19: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 2. Planning your Cognos TM1 installation

The key to a successful installation is planning.

When implementing IBM Cognos TM1, decide how you will install and configureit to provide the best possible performance. The installation and configurationchoices that you make depend on your requirements, resources, and preferences.

Available installation programsIBM Cognos TM1 provides a collection of installation programs for installing andconfiguring Cognos TM1 components on different operating systems and fordifferent deployment scenarios.

The installation programs and component options are organized by operatingsystem and architecture tier to support deployment in single and multiplecomputer environments.

The available Cognos TM1 10.1 installation programs are described below.

TM1 Windows 32-bit

Includes a collection of all the 32-bit Cognos TM1 components that areavailable for Microsoft Windows.

Use this installation program to install all components on a single 32-bitWindows system or to selectively install individual components, such asthe Cognos TM1 Admin Server and Cognos TM1 Server, on separate 32-bitWindows systems.

By default, this installation program automatically installs the IBM CognosConfiguration utility for managing the Cognos TM1 Admin Server, CognosTM1 Server and Cognos TM1 Applications components.

TM1 Windows 64-bit

Includes a combined collection of 32-bit and 64-bit components forinstallation on a 64-bit Microsoft Windows system.

This installation program will only run on a 64-bit Windows system.

Use this installation program to install all components on a single 64-bitWindows system or to selectively install individual components, such asthe Cognos TM1 Admin Server and Cognos TM1 Server, on separate 64-bitWindows systems.

By default, this installation program automatically installs the IBM CognosConfiguration utility for managing the Cognos TM1 Admin Server, CognosTM1 Server and Cognos TM1 Applications components.

TM1 Client-only

Includes only the standard Cognos TM1 clients / user interfaces. Thesecomponents are only available as 32-bit versions.

Cognos TM1 Architect

Cognos TM1 Perspectives

Cognos TM1 Performance Modeler

© Copyright IBM Corp. 2007, 2012 7

Page 20: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos Insight

Use this installation program to distribute and install Cognos TM1 clientsto multiple end-user computers in your environment.

TM1 UNIX

Includes only the UNIX versions of the Cognos TM1 Admin Server andCognos TM1 Server components.

Use the Cognos TM1 UNIX installation program to install the Cognos TM1Admin and or Cognos TM1 Server on any of the supported UNIX or Linuxoperating systems. A separate installation program is available for each ofthese supported operating systems.

By default, this installation program automatically installs the IBM CognosConfiguration utility for managing the Cognos TM1 Admin Server andCognos TM1 Server components.

TM1 Interoperability for Business Intelligence

Optional installation program

Installs optional components that provide interaction between IBM CognosTM1 and IBM Cognos Business Intelligence (BI). Provides support forCognos TM1 Viewer Portlets and dashboards, provisioning Cognos Insightfrom the Cognos BI Gateway, and linking to IBM Cognos TM1Applications from Cognos BI.

Available for UNIX and Microsoft Windows.

TM1 Package Connector for Business Intelligence

Optional installation program

Installs components that support IBM Cognos TM1 connectivity to IBMCognos Business Intelligence (BI) packages with SAP Business Warehousedata sources and other relational and ODBC data sources.

TM1 Workflow

Optional installation program.

Installs the required components for the IBM Cognos TM1 Workflowapplication.

Available componentsIBM Cognos TM1 includes a collection of server and client components foradministering, monitoring, modeling, analyzing, and interacting with Cognos TM1data.

The installation program organizes the different Cognos TM1 components intogroups based on architecture tier. You can install different combinations ofcomponents onto a single computer or across multiple computers, depending onyour specific requirements, operating system and environment. Each componentrequires a specific operating system and software environment.

Application tier components

The following table includes the description and operating system for each CognosTM1 component in the application tier.

8 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 21: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 1. Application tier components

Component Operating System Description

TM1 Server 32-bit Windows

64-bit Windows

64-bit UNIX

The Cognos TM1 Server manages requestsfrom Cognos TM1 clients. It loads thenames of all available permanent objects(cubes, dimensions, etc.) into memory andresponds to client requests by performingcalculations, consolidations, and updates asrequired.

The Cognos TM1 Server also managessecurity by granting or denying access toserver objects and maintaining a log ofchanges to the database.

See Chapter 7, “Cognos TM1 Serverinstallation,” on page 63.

TM1 Admin Server 32-bit Windows

64-bit Windows

64-bit UNIX

A process that keeps track of all CognosTM1 servers running on a network. AnAdmin Server runs on a computer known asan Admin Host.

When a Cognos TM1 server starts, theserver registers itself with an Admin Serverthat is running on a specified Admin Host.

Cognos TM1 clients reference the AdminServer to determine which Cognos TM1servers are available on the network.

See Chapter 7, “Cognos TM1 Serverinstallation,” on page 63.

TM1 Tools Supported operatingsystems vary bytool.

Includes the following collection of toolsand utilities for Cognos TM1 administrators,developers, and modelers:

TIRunTI

TM1xfer

See Chapter 13, “Cognos TM1 toolsinstallation,” on page 129.

Web application tier components

These components require a web application server on which to run.

The following table includes the description and operating system for each CognosTM1 component in the web application tier.

Chapter 2. Planning your Cognos TM1 installation 9

Page 22: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 2. Web application tier components

Component Operating System Description

TM1 ApplicationGateway

32-bit Windows

64-bit Windows

Java-based web component that providesthe provisioning of the Cognos TM1Performance Modeler and Cognos Insightcomponents to remote end users.

This component is typically installed alongwith the TM1 Application Servercomponent.

See Chapter 9, “Cognos TM1 Applicationsinstallation,” on page 77.

TM1 ApplicationServer

32-bit Windows

64-bit Windows

Java-based web application that providesthe primary support for IBM Cognos TM1Applications.

Cognos TM1 Applications enables you todesign, deploy and run managed planningand contribution-based applications onCognos TM1 data. This component alsointeracts with Cognos TM1 PerformanceModeler and Cognos Insight components.

This component requires a Java-based webapplication server and the Java RuntimeEnvironment (JRE)

You can use the Apache Tomcat applicationserver that is installed by default or yourown instance of an application server suchas WebSphere® Application Server.

An IBM JRE is installed automatically withCognos TM1 Applications. If you are usingan application server, use the JRE that isinstalled with it.

See Chapter 9, “Cognos TM1 Applicationsinstallation,” on page 77.

TM1 Web 32-bit Windows

64-bit Windows

Web server and client components based onthe Microsoft Internet Information Services(IIS) / .NET Framework.

Cognos TM1 Web enables users to connectto Cognos TM1 servers and interact withdata using one of the supported webbrowsers.

See Chapter 8, “Cognos TM1 Webinstallation,” on page 73.

10 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 23: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 2. Web application tier components (continued)

Component Operating System Description

TM1 OperationsConsole

32-bit Windows

64-bit Windows

Java-based web application that provides aweb-based monitoring tool for TM1administrators to monitor and take actionon TM1 server activity.

The IBM Cognos TM1 Operations Consoleprovides a simple and effective way tounderstand how Cognos TM1 servers anduser loads are working.

You can use this component with theApache Tomcat application server that isinstalled by default or your own installationof a supported application server.

An IBM JRE is installed automatically withCognos TM1 on Windows. If you are usingan application server, use the JRE that isinstalled with it.

See Chapter 12, “Installing the Cognos TM1Operations Console,” on page 117.

Client tier components

The following table includes the description and operating system for each CognosTM1 component in the client tier.

Table 3. Client tier components

Component Operating System Description

TM1 Perspectives 32-bit Windows Cognos TM1 add-in client for MicrosoftExcel.

Enables you to use the features of Excel toperform complex analysis on data stored ina Cognos TM1 server. Can also create andmaintain objects and data on both local andremote Cognos TM1 Servers.

See “Installing Cognos TM1 Perspectives”on page 93.

Cognos Insight 32-bit Windows Java , Eclipse-based rich client interface thatcan be launched independently or from theCognos TM1 Applications portal page.

Available as a selectable component in theClient-only, and 32-bit and 64-bit Windowsinstallation programs.

By default, this component is available butnot selected in the 32-bit and 64-bitWindows installation programs.

See “Installing Cognos Insight” on page 99.

Chapter 2. Planning your Cognos TM1 installation 11

Page 24: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 3. Client tier components (continued)

Component Operating System Description

TM1 APIs Dependent uponspecific APIs

Installs the required files that enabledevelopers to work with the followingCognos TM1 application programminginterfaces (APIs).

TM1 API - Allows developers to createcustom C, C++ and VB applications thatinteract with TM1.

TM1 Java API - Allows developers to createcustom Java applications that interact withTM1.

TM1 .NET API - Allows developers tocreate custom Microsoft .NET applicationsthat interact with TM1.

Developer tier components

The following table includes the description and operating system for each TM1component in the developer tier.

Table 4. Developer tier components

Component Operating System Description

TM1 Architect 32-bit Windows A Windows-based desktop application foradministering, creating, and maintainingdata and metadata on both local and remoteTM1 servers.

See “Installing Cognos TM1 Architect” onpage 94.

TM1 PerformanceModeler

32-bit Windows Java, Eclipse-based rich client interface thatis launched from the Cognos TM1Applications portal page.

Enables developers to build planning andanalysis models in the Cognos TM1environment.

Available as a selectable component in theClient-only, and 32-bit and 64-bit Windowsinstallation programs.

By default, this component is available butnot selected in the 32-bit and 64-bitWindows installation programs.

See “Installing Cognos TM1 PerformanceModeler” on page 96.

Sample database components

The following table includes the description and operating system for each TM1additional component.

12 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 25: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 5. Sample database components

Component Operating System Description

Samples 32-bit Windows

64-bit Windows

64-bit UNIX

Installs Cognos TM1 sample databases:

Chapter 11, “Cognos TM1 sample databasesinstallation,” on page 105.

Additional components not listed

The following table includes the description and operating system for requiredcomponents that are not listed or selectable in the installation program but areinstalled by default with the installation of other selectable components.

Table 6. Additional components not listed

Component Operating System Description

TM1 Excel Service 32-bit Windows A required support component for CognosTM1 Web. Installed only when Cognos TM1Web is installed.

Installs and runs as a Microsoft Windowsservice on the web server that hosts CognosTM1 Web.

See Chapter 8, “Cognos TM1 Webinstallation,” on page 73.

TM1 OLE DBProvider Application

32-bit Windows

64-bit Windows

Allows third party software to retrieve cubedata from the Cognos TM1 server usingMDX queries.

Software requirementsBefore you install IBM Cognos TM1 server or client components, review systemrequirements and set up resources in your environment so that the componentscan operate.

Review the latest list of environments supported by Cognos TM1, includinginformation on operating systems, patches, web servers and web browsers, byvisiting Cognos TM1 Software Environments (https://www.ibm.com/support/docview.wss?rs=3446&uid=swg27014444).

Prerequisite software

Cognos TM1 Perspectives, Cognos TM1 Architect, Cognos TM1 Web, and CognosTM1 Applications require the installation of specific software components beforethey can be installed and used.

Table 7. Required third-party components

Prerequisite Component Description

Microsoft Excel Required for Cognos TM1 Perspectives.

Optional on the web server where Cognos TM1 Web isrunning.

Chapter 2. Planning your Cognos TM1 installation 13

Page 26: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 7. Required third-party components (continued)

Prerequisite Component Description

Microsoft Visual C++ 2005 SP1Redistributable Package

Required for Cognos TM1 Perspectives and Cognos TM1Architect.

Microsoft .NET 3.5 SP1Framework

Required for Cognos TM1 Perspectives, Cognos TM1Architect and Cognos TM1 Web.

Microsoft Chart Controls forMicrosoft .NET Framework 3.5.

As of Cognos TM1 version 9.5.2, Cognos TM1 Webrequires the Microsoft Chart Controls for Microsoft .NETFramework 3.5 on the web server where Cognos TM1Web is running.

This component supports the charting of data in theCognos TM1 Web and Cognos TM1 Applications userinterfaces.

Download and install these components on the target system before installing therelated Cognos TM1 components.

Default installation valuesThis topic describes the set of default values used by the IBM Cognos TM1installation.

The Cognos TM1 installation uses the following default configuration values:

Table 8. Default configuration values for Cognos TM1 installation

Item Description and Default Value

Default install location On a 32-bit Microsoft Windows system:

C:\Program Files\IBM\Cognos\TM1

C:\Program Files\IBM\Cognos\TM1\TM1Web

On a 64-bit Microsoft Windows system:

C:\Program Files\IBM\cognos\tm1_64

C:\Program Files\IBM\cognos\tm1_64\TM1Web

Admin Server portnumber

The TCP/IP port number on which the Admin Server listens forclient requests.

5495 (unsecured)

Admin Server SSL portnumber

The TCP/IP port number on which all Cognos TM1 componentscommunicate with the Cognos TM1 Admin Server using SecureSocket Layer (SSL).

5498 (secured)

Cognos TM1 server portnumber

The port on which the Cognos TM1 server runs. This parameteris used to distinguish multiple Cognos TM1 servers running onthe same computer. Valid port values fall between 5000 and49151.

The default is 12345.

14 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 27: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 8. Default configuration values for Cognos TM1 installation (continued)

Item Description and Default Value

Cognos TM1 ClientMessage port number

12345

This is a sample default. The system chooses the next availableport number.

This port number establishes a secondary port for progressmessages to use when a lengthy operation is waiting to becancelled.

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

Sample Cognos TM1server names

Planning Sample

SData

GO_New_Stores

Login credentials:

User name: admin

Password: apple

Default data directoryfor sample Cognos TM1servers

C:\Program Files\IBM\cognos\tm1\samples\tm1\PlanSamp

C:\Program Files\IBM\cognos\tm1\samples\tm1\SData

C:\Program Files\IBM\cognos\tm1\samples\tm1\GO_New_Stores

Security mode A Standard installation uses Cognos TM1 Authentication. In thismode, the Cognos TM1 server prompts users for a user nameand password when they log in to Cognos TM1 components.

Configuration overviewAfter installing IBM Cognos TM1, use the Cognos Configuration tool and theCognos TM1 configuration file parameters to configure the program for optimalperformance.

Cognos Configuration and Cognos TM1The IBM Cognos Configuration tool is used to start, stop, configure, and save thesetting for each IBM Cognos TM1 server.

Use Cognos Configuration to manage the following components and tasks:

Table 9. Cognos Configuration tasks

Component/task Action

Cognos TM1 Admin Server Start and stop the server.

Cognos TM1 Server Start, stop and add Cognos TM1 Servers.

Cognos TM1 Excel Service Start and stop the Cognos TM1 Excel service that supportsCognos TM1 Web.

Chapter 2. Planning your Cognos TM1 installation 15

Page 28: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 9. Cognos Configuration tasks (continued)

Component/task Action

Cognos TM1 ApplicationServer

Start and stop the provided Apache Tomcat web applicationserver and Cognos TM1 Application Server that supportsCognos TM1 Applications.

If you are using your own installation of Tomcat or anotherweb application server, configure and run the Cognos TM1Application Server outside of Cognos Configuration.

Saving configurationinformation

When you save the configuration setting in the CognosConfiguration tool, the tool:

v verifies the configuration

v generates cryptographic information

v checks integrity of encrypted data

v saves configuration for Cognos TM1 servers

v backs up configuration files

v saves configuration parameters

v updates Tomcat configuration file

Creating war files fordeployment

If you want to deploy the Cognos TM1 Application Serverwith your own web application server, use CognosConfiguration to create the required web application (war)file.

In Cognos Configuration click Actions > Build ApplicationFiles.

Cognos TM1 configuration parametersIBM Cognos TM1 uses a collection of configuration parameters to control thebehavior of the client and server components.

Table 10. Available Cognos TM1 configuration parameters

Configuration Description

Tm1s.cfg file Cognos TM1 server configuration

See Appendix B, “The Tm1s.cfg Server ConfigurationFile,” on page 219.

Tm1p.ini file Client configuration for Cognos TM1 Architect andCognos TM1 Perspectives

See Appendix C, “The Tm1p.ini Client Configuration File,”on page 259.

Cognos TM1 Web - web.configfile

TM1 Web configuration and settings

See “Cognos TM1 Web advanced configuration” on page147.

Cognos TM1 Applicationsconfiguration

Cognos TM1 Applications configuration

See “Cognos TM1 Applications advanced configuration”on page 153.

Cognos TM1 OperationsConsole

Cognos TM1 Operations Console configuration

See Chapter 12, “Installing the Cognos TM1 OperationsConsole,” on page 117.

16 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 29: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

User accounts for running Cognos TM1 services on WindowsWhen you use IBM Cognos Configuration to start the Cognos TM1 Admin Server,Cognos TM1 Server, and Cognos TM1 Excel Service, they are registered to run asWindows services using the predefined Microsoft Windows Local System Account.You should manually change these services to run under a specific user account.

Run Cognos TM1 services under a specific Windows useraccount

By default, Cognos Configuration registers the following Cognos TM1 services torun under the Microsoft Windows Local System Account:v Cognos TM1 Admin Serverv Cognos TM1 Serverv Cognos TM1 Excel service

Important: Change these Cognos TM1 services to run under a specific useraccount on Microsoft Windows.

For details on how to change the account for a Cognos TM1 component running asa Windows service, see “Changing Cognos TM1 services to run as a specific useraccount on Windows” on page 141.

After making these changes, you will still be able to use Cognos Configuration tostart and stop these services.

Required privileges for a specific Windows user account

The user account for running Cognos TM1 services on Windows should be amember of the Local Administrator group and also be included in the databaseowner group to access SQL tables and views.

The account must have the following privileges on the local machine:v Act as part of the operating systemv Bypass traverse checkingv Increase quotasv Replace a process level tokenv Log on as a servicev Have read and write privileges on the Windows Registry item

Confirming the proper installation of Microsoft .NET FrameworkThe Microsoft.NET Framework Version 3.5 SP1 is required for Cognos TM1Perspectives, Cognos TM1 Architect and Cognos TM1 Web.

You can download the .Net Framework from the Microsoft support website. Whenyou install a message displays to remind you of this requirement.

Microsoft Internet Information Services (IIS) must be installed before installing the.NET 3.5 framework that is required for Cognos TM1 Web.

For the latest information about prerequisite software visit Cognos TM1 10.1.0Software Environments (www.ibm.com/support/docview.wss?uid=swg27021976).

Chapter 2. Planning your Cognos TM1 installation 17

Page 30: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

To ensure that the .NET Framework 3.5 SP1 is properly installed and registered onyour computer, perform these steps.

Procedure1. Open a Command Prompt window and navigate to the following directory:

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

For an x64 Windows system, use the following directory:C:\WINDOWS\Microsoft.NET\Framework64\v2.0.50727

Remember: IBM Cognos TM1 Web requires the Microsoft .NET Framework3.5 SP1, however, .NET 2.0 remains on your system after upgrading .NET andis required for this step.

2. Execute the following command:aspnet_regiis.exe -i

Enabling Cognos TM1 Excel ServiceIf the .NET Framework is not installed before you install IBM Cognos TM1 Web,the Cognos TM1 Excel Service will be disabled when you complete the CognosTM1 Web installation.

This service provides critical Cognos TM1 Web functionality, and you mustcomplete the following steps to set the service Startup property to Automatic afteryou install the .NET Framework.

Procedure1. 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 Cognos TM1 Web you must install a currentlysupported version of Microsoft Excel on the same machine where the IIS webserver is installed.

Defining the ASPNET userIf you install IBM Cognos TM1 Web on a system where the Microsoft .NETFramework is not yet installed, you may encounter an error that the ASPNET useris not defined on the system.

You must define the ASPNET user before you install Cognos TM1 Web. Followthese steps to create the ASPNET user.

Procedure1. 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.6. Configure the fields as follows:

18 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 31: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

User nameASPNET

Full nameASP.NET Machine Account

DescriptionAccount for running ASP.NET applications

PasswordEnter a password of your choice.

User must change password at next logonThis field is not available.

User cannot change passwordSelect this check box.

Password never expiresSelect this check box.

Account is disabledDo not select this check box.

7. Click Create.

Cognos TM1 Web requires Microsoft Chart Controls componentAs of IBM Cognos TM1 version 9.5.2, Cognos TM1 Web requires a third-partychart component, Microsoft Chart Controls for Microsoft .NET Framework 3.5, onthe web server where Cognos TM1 Web is running. You must manually downloadand install this component.

The Microsoft Chart Controls component supports the charting of data in theCognos TM1 Web and Cognos TM1 Applications user interfaces.

Download and install this component on the web server where Cognos TM1 Webis running.

For more details about the Microsoft Chart Controls component, search theMicrosoft web site for this topic: Microsoft Chart Controls for Microsoft .NETFramework 3.5

Installing TM1 on Networks without domainsIf you install IBM Cognos TM1 in a network that does not use a domain controller,you can set your Cognos TM1 services to use local accounts.

For details on configuring Cognos TM1 services, see “Changing Cognos TM1services to run as a specific user account on Windows” on page 141.

If you use one or more local accounts for your Cognos TM1 services, you must besure these accounts have the following privileges on their local machines:v Act as part of the operating systemv Bypass traverse checkingv Increase quotasv Replace a process-level tokenv Log on as a service

Chapter 2. Planning your Cognos TM1 installation 19

Page 32: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

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

Note: If you install on a machine that does not participate in a Microsoft Windowsdomain, you cannot use Integrated Login.

Local machine syntaxDo not use dot, as in "." as an abbreviation for the local machine domain when youspecify login information.

You must explicitly enter the machine name. In certain configurations, using the".\username" syntax may cause serious problems.

20 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 33: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 3. Architecture

To understand the architecture of the majro IBM Cognos TM1 components, youshould be familiar with your information technology infrastructure and with thebusiness needs of people in your organization who will use IBM Cognos TM1.

For details about Cognos TM1 login authentication and communication security,see “Authentication security” on page 163.

Cognos TM1 architectureIBM Cognos TM1 employs a distributed, client-server architecture that consists ofthe IBM Cognos TM1 server to which a combination of different clients canconnect.

Cognos TM1 provides the following clients and user interfaces:v Cognos TM1 Perspectivesv Cognos TM1 Architectv Cognos TM1 Client (limited version of Cognos TM1 Perspectives )v Cognos TM1 Cognos Web clientv Cognos TM1 Application portal and workflow (using the Cognos TM1

Application Server)v Cognos TM1 Performance Modelerv Cognos Insight

In this environment, corporate data resides on remote servers, which authorizedclients can access. Depending on how you set up the system, clients can access oneor more remote TM1 servers to obtain different kinds of data. Cognos TM1 clientsare described in detail in the IBM Cognos TM1 User Guide.

Tier 3: Data

TM1 Server

TM1 Admin Server

Cognos Configuration

Tier 1: Web Clients

Desktop clients Web clients

Tier 2: Web Application ServersWeb server

Figure 1. High-level overview of the Cognos TM1 client-server architecture

© Copyright IBM Corp. 2007, 2012 21

Page 34: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Windows desktop clients

TM1 Perspectives and TM1 Architect can connect to a local IBM Cognos TM1server, which acts as a repository for private TM1 data. If you have the properauthority, you can copy data from a remote server to your local server byreplicating that data, and then synchronize your updates back to the remote server.

TM1 Perspectives, TM1 Architect, and TM1 Client are standard TM1 clients. In anormal LAN/WAN environment, these clients all communicate with a remoteserver using the TCP/IP network protocol.

Cognos TM1 Admin Server overviewThe IBM Cognos TM1 Admin Server is a process that keeps track of all CognosTM1 servers running on a network. An Admin Server runs on a computer knownas an Admin Host.

When the Cognos TM1 server starts, the server registers itself with an AdminServer that is running on a specified Admin Host. TM1 clients reference the AdminServer to determine which Cognos TM1 servers are available on the network.

The Admin Server maintains the following information for each available CognosTM1 server:v Server namev IP addressv Protocolv Port number

All this information is supplied by the Cognos TM1 server when the serverregisters itself on the Admin Server.

An Admin Server must be running before a Cognos TM1 server can start. If youhave specified an Admin Host in the Tm1s.cfg file or the server command line, theCognos TM1 server will attempt to connect to an Admin Server on that host. TheCognos TM1 server will fail to come up if it is unable to connect to the AdminServer for any reason.

If you have not specified an Admin Host, the Cognos TM1 server attempts toconnect to an Admin Server on the local machine. If an Admin Server is notcurrently running on the local machine, the Cognos TM1 server starts a newAdmin Server and connects to it.

The Admin Server becomes aware of Cognos TM1 servers on the network bylistening for notification from the servers. Usually, the Cognos TM1 server sendsnotification of its presence at a regular interval called the "heartbeat interval,"which is 60 seconds by default. When the Admin Server detects the Cognos TM1server, that server becomes registered and available to clients on the network.However, if the Admin Server does not detect the presence of a registered CognosTM1 server over a period equal to three times the heartbeat interval, that CognosTM1 server is removed from the list of servers available on the network.Consequently, the Cognos TM1 server will not be available to clients on thenetwork.

By default, the Admin Server uses port 5495. If port 5495 is already in use, you canassign a new port number by creating a new service called Tm1admsrv. All

22 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 35: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos TM1 applications look for a named service called Tm1admsrv, and if thatservice exists, the applications use the port number assigned to the service. If theservice does not exist, Cognos TM1 applications use port 5495.

Cognos TM1 Server overviewThe IBM Cognos TM1 Server manages access to the Cognos TM1 data directory forCognos TM1 clients.

The following figure illustrates the operations of a remote Cognos TM1 server.These operations are explained in the text that follows.

v On startup, the remote server loads dimensions and cubes from the datadirectory into the server machine RAM. At the same time, the server opens anew transactional log file called Tm1s.log in the data directory. After the cubesare loaded, the remote server is available.

v The remote Cognos TM1 server registers itself with one or more Admin Serversso that clients can connect to the remote Cognos TM1 server.

v Client applications contact Admin Servers to locate available Cognos TM1servers. The clients log into the Cognos TM1 servers whose data they want toaccess.

v Clients edit the cube data, sending the values back to the Cognos TM1 server.v As new values are received from clients, the Cognos TM1 server writes the

records to the Tm1s.log file, keeping track of every data change, including thedate and time the edit occurred, and the ID of the client who made the edit.

v As the server calculates new values in response to client requests, the serverstores them in memory, increasing the amount of memory used by the server.

v When the server shuts down, all records in the Tm1s.log file are saved to disk,and the transaction log file is renamed by appending a date/time stamp to it.The Tm1s.log file is saved in the server's data directory to back out datatransactions. For details, see the topic "Backing Out Records from theTransactionLog” in the IBM Cognos TM1 Operation Guide.

TM1 clients

TM1 Server

TM1 clients retrieve cube values from the server. Clients also send edits to cube values to the TM1 server

Data directory

While the TM1 server is running, all cube data resides in RAM.All edits received from TM1 clients are stored in a transaction log file named Tm1s.log

When the TM1 server is shutdown, or when an explicit SaveData command is issued, anychanges to cube values arewritten from the transactional logfile to the data directory

When the TM1 server isstarted, all TM1 data isloaded from the TM1 datadirectory into RAM on theserver machine

Figure 2. Operations of a remote server

Chapter 3. Architecture 23

Page 36: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

If the server is intentionally shut down without saving the changes, the log fileis saved with a time/date stamp and the extension is changed to .rej. You canprocess the Tm1syyyymmddhhmmss.rej file through TurboIntegrator to recover thetransactions.

v To save all changes to the data on a Cognos TM1 server at any time withoutshutting down the server, right-click a server in Server Explorer and Click SaveData. All records in the Tm1s.log file are immediately written to disk, thetransaction log file is renamed by appending a date/time stamp to it, and a newTm1s.log file is created to accept any subsequent edits to cube values.Any changes to the metadata, such as dimension definitions and cubedefinitions, are immediately saved to disk. The changes to the metadata are notwritten to the transaction log file.

Cognos TM1 files overviewIBM Cognos TM1 requires numerous object and system files, most of which arestored in the Cognos TM1 server's data directory.

Some of these are installed with the product, while others are generated for eachdimension and cube you create. Yet other files are generated by Cognos TM1 tostore metadata, such as security information.

The following table lists the files that define cubes, dimensions, and other CognosTM1 objects. These files are located in the data directory, which is described laterin this section.

Table 11. Files that define cubes, dimensions, and other objects

File Extension Description

.blb Cube formatting file

.cho Chore definition file

.cub Cube database file

.dim Compiled dimension

.dit ASCII dimension source file

.pro TurboIntegrator process definition file

.rux Compiled rule

.sub Dimension subset

.tbu ASCII source for view file

.tqu Saved query

.tru ASCII source for a rule file

.vue Saved view

.xdi Excel dimension worksheet

24 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 37: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 11. Files that define cubes, dimensions, and other objects (continued)

File Extension Description

.xru Excel rule worksheet

Data directory overviewThe data directory contains the cubes, dimensions, and system information that areloaded into memory when a Cognos TM1 server is started. When you access aserver from any Cognos TM1 client, Cognos TM1 reads data from that server'sdata directory.

When you run Cognos TM1 , the changes you make to cube values areimmediately stored in memory and in the transaction log (Tm1s.log). Cognos TM1then saves the data back to the data directory when any of the following occur:v Cognos TM1 server is shut down.v An administrator right-clicks a server icon in Server Explorer and choose Save

Data from the pop-up menu. This directs Cognos TM1 to save the changes to theselected server.

v An administrator chooses File, Save Data All in Server Explorer. This directsCognos TM1 to save the changes to all the connected servers, if you have theproper authority.

v A user saves the batch updates.

Choose the path for your data directory when you install Cognos TM1 .

Table 12. Default Data Directory Paths

Data Directory Default Path

Cognos TM1 local server installation_location\custom\tm1data\pdata

Windows Cognos TM1 remote server forsample data

installation_location\custom\tm1data\sdata

UNIX Cognos TM1 server installation_location/custom/tm1data/sdata

Required network accessA client's ability to save data is determined by the IBM Cognos TM1 securityscheme.

For information, see the IBM Cognos TM1 Developer Guide.

Important: Make this directory visible only to administrators and to the login thatis used by the server.

Multiple data directoriesYou can specify that you want IBM Cognos TM1 to use multiple data directoriesby separating the directory names with semicolons. When you specify multipledata directories, Cognos TM1 does the following.

Chapter 3. Architecture 25

Page 38: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Accesses cubes and dimensions from each of the specified directories. If there isa duplicate object, Cognos TM1 accesses the object from the first directoryspecified.

v Writes changes to the directory where the object is located. When you create anew object, Cognos TM1 writes to the first directory you had specified.

For example, suppose you want to store dimensions in a directory called tm1dims,and cubes in a directory called tm1cubes. You would specify the following in theTm1s.cfg file:DatabaseDirectory="c:\tm1dims;c:\tm1cubes"

By concatenating the two directories, you can access these objects through ServerExplorer as if they were in a single location.

Data directory locationYou specify the location of the data directory differently for local and remoteservers.v For a local server, specify the location of the data directory by naming this

directory in the DataBaseDirectory parameter of the Tm1p.ini file.You can change the.ini file by using the IBM Cognos TM1 Options menu inServer Explorer.For more information, see Appendix C, “The Tm1p.ini Client ConfigurationFile,” on page 259.

v For a remote server, specify the location of the data directory by using either theDatabaseDirectory parameter in the Tm1s.cfg file or the -d command-lineparameter when you bring up the server.

For information on server parameters, see Appendix B, “The Tm1s.cfg ServerConfiguration File,” on page 219.

A remote server must be able to recognize the drive where the data directoryresides. If the directory is on a remote drive, you must map that drive to a localdrive letter.

Tip: When you access a remote server, you do not need to map to the drive wherethe server data directory resides.

If you do not specify the location of the data directory, the Cognos TM1 server willnot be able to start and the following error message displays.Data Directory not specified. Aborting server startup.

Cognos TM1 Web architectureIBM Cognos TM1 Web uses a multi-tiered architecture that enables users to accessand interact with Cognos TM1 data using any supported web browser.

The IBM Cognos TM1 Web multi-tiered architecture includes web client, webapplication server and data component tiers.

26 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 39: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Tier 1: Web clients

The web clients tier allows users to access and interact with Cognos TM1 datausing any of the supported web browsers. Users can work with Cognos TM1 cubesand Cognos TM1 Websheets.

Visit Cognos TM1 Software Environments (https://www-304.ibm.com/support/docview.wss?rs=3446&uid=swg27014444) for currently supported web browsers.

Tier 2: Web application server

Cognos TM1 Web runs on a Microsoft Internet Information Services (IIS) webserver and requires the Microsoft .NET Framework.

Configure the Microsoft IIS web server with the following:v Required virtual directories to store Cognos TM1 Web ASP scripts and other

related files.v Supported version of Microsoft .NET Framework installed.v Supported version of Microsoft Chart Controls for .NET Framework.v Optional - Supported version of Microsoft Excel installed. This software is

required to generate Cognos TM1 Websheets.

This tier must also include the Cognos TM1 Excel Service running as a Windowsservice on the web server. The Cognos TM1 Excel Service provides support forconverting and displaying Microsoft Excel worksheets as Cognos TM1 Websheets.This service also exports Websheets back to Microsoft Excel and PDF formats.

When you install Cognos TM1 Web, the installation program installs the CognosTM1 Excel Service (TM1ExcelService.exe) as a Windows service on your Webserver.

TM1 Server

Tier 3: Data

TM1 Admin Server

TM1 Web serverrunning on

Microsoft IIS Web Server

TM1 Web client(in supported web browser)

Microsoft .NET FrameworkMicrosoft Chart Controls

TM1 Excel Service

Microsoft Excel

Tier 2: Web Application Server

Tier 2: Web Clients

Figure 3. Cognos TM1 Web architecture overview diagram

Chapter 3. Architecture 27

Page 40: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Tier 3: Data

This tier includes the Cognos TM1 Admin Server and at least one Cognos TM1Server.

IBM Cognos TM1 Admin server

The Cognos TM1 Admin Server can be installed on any computer on your LANbut it must reside in the same LAN segment as your Cognos TM1 Server. Typically,the Cognos TM1 Server and the Cognos TM1 Admin Server are installed on thesame computer.

IBM Cognos TM1 server

The Cognos TM1 server can be installed on the same computer that hosts yourWeb server, but installing on a separate computer is more efficient.

The version of the Cognos TM1 server that is used in your Cognos TM1 Webenvironment must be equal to or more recent than the version of Cognos TM1 Webthat you are running. If the version of Cognos TM1 Web you are running is morerecent than the version of the Cognos TM1 server, users will receive an error whenattempting to log in to Cognos TM1 Web.

Accessing multiple Cognos TM1 servers from Cognos TM1Web

IBM Cognos TM1 Web provides multi-database support, allowing users to accessmultiple Cognos TM1 servers that are registered on the same Cognos TM1 AdminServer and where users have the same user name and password combination.

When you log in, Cognos TM1 Web displays the Navigation pane for the primaryserver that you selected on the login screen. However, if your user name andpassword combination matches other Cognos TM1 servers registered under thesame Cognos TM1 Admin Server, then IBM Cognos TM1 Web will automaticallylog you in to these other servers on an as-needed basis. This behavior is differentfrom Cognos TM1 Architect and Cognos TM1 Perspectives where you have to loginto other Cognos TM1 servers as a separate, manual step.

Multi-database support mainly applies to Websheets because they can containCognos TM1 formulas and references that point to other Cognos TM1 servers. Forexample, if you open a Websheet that does contain Cognos TM1 references toanother server registered under the same Admin Server, Cognos TM1 Web willattempt to log you into this other server using your current user name andpassword.

Limiting access to a single Cognos TM1 server from CognosTM1 Web

If you want to prevent IBM Cognos TM1 Web users from using multi-databasesupport to access other Cognos TM1 servers under the same Admin Server, youcan use a different Admin Server to register each Cognos TM1 server.

For example, with this configuration, if you log into Cognos TM1 Web and try toopen a Websheet that references another Cognos TM1 server registered under adifferent Admin Server, the data will not display even if you have the same username and password for that server.

28 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 41: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Tip: If you configure your Cognos TM1 servers to run under separate AdminServers, but still want to access them from Cognos TM1 Web, Cognos TM1Architect, or Cognos TM1 Perspectives , you can use the AdminHost parameter.This parameter lets you specify multiple Admin Hosts so users can access anyCognos TM1 servers that are registered with the Admin Servers on the specifiedhosts.v For information about configuring IBM Cognos TM1 Web to access multiple

Admin Servers, see "Configuring the Login Page using AdminHostName andTM1ServerName” in the IBM Cognos TM1 Operation Guide.

v For information about configuring Cognos TM1 Architect and Cognos TM1Perspectives to access multiple Admin Servers, see “Specifying multiple CognosTM1 Admin Hosts” on page 71.

Cognos TM1 Applications architectureIBM Cognos TM1 Applications has a multi-tiered architecture that consists of threetiers: Web clients, Web application servers, and data.

The following diagram shows the multi-tiered architecture and basiccommunication paths for all the Cognos TM1 Applications components.

The lines in the Cognos TM1 Applications architecture diagram are primarilyintended to show the typical communication paths required for the tasks managedby the Cognos TM1 Application Server, such as keeping track of workflow states.

In addition to these communication lines, Cognos TM1 Performance Modeler andCognos Insight also require a direct connection to the underlying Cognos TM1Server at all times. As an exception, when using Cognos Insight in Distributedmode, it does not require a constant connection to the Cognos TM1 Server.

Tier 3: Data

Cognos TM1 Server

Cognos TM1 Admin Server

Cognos TM1 Applications

Cognos TM1 Performance Modeler

Java-based web application server(IBM WebSphere or Apache Tomcat)

Cognos TM1 Application Gateway

Cognos Insight(Distributed)

Tier 1: Web Clients

Tier 2: Web Servers

Data contribution clients

Cognos Insight(Connected)

Cognos TM1Application Web

Cognos Insight

Figure 4. Cognos TM1 Applications architecture overview diagram

Chapter 3. Architecture 29

Page 42: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos TM1 Applications Tier 1: Web clientsThe Web clients tier contains all the user interfaces for IBM Cognos TM1Applications. These user interfaces are used by end-users, administrators, andplanning application developers.

Cognos TM1 Applications

The main Cognos TM1 Applications client is a web browser-based user interfacesupported by a Java-based web application server, such as IBM WebSphere or theprovided installation of Apache Tomcat. The user interfaces for Cognos TM1Applications are organized into two main sub-pages and three different datacontribution clients.

Cognos TM1 Applications page

The Cognos TM1 Applications page (portal page) is the main starting point forboth administrator and non-administrator users. This page provides a list ofavailable applications that is filtered for the current user. Clicking on anapplication in this page opens the workflow page.

Administrators and application developers can also open Cognos TM1Performance Modeler and Cognos Insight from the Cognos TM1 Applicationstoolbar.

Cognos TM1 Application page

The Cognos TM1 Application page (workflow page) allows you to manage taskswithin a single application. This client displays each node that a user is responsiblefor contributing to and/or reviewing in a specific plan. Depending on how youconfigure the application, the user can open the Cognos Insight client or CognosTM1 Application Web client for any accessible node in this client.

Data contribution clients

The following table summarizes the Cognos TM1 Applications data contributionclients that enable users to work with data in grid and chart formats.

Table 13. Cognos TM1 Applications - data contribution clients

Client Description

IBM Cognos TM1Application Web

Default client. Processing is in real time with the server. Enablesusers to view and edit application data in a grid format usingCognos TM1 cube views or TM1 Websheets based oninfrastructure from Cognos TM1 Web

This user interface requires a web server running Cognos TM1Web components with Microsoft Internet Information Services(IIS).

IBM Cognos Insight -Connected

IBM Cognos Insight client. Processing is in real time with theserver. Enables users to view and edit application data in adashboard or workspace format.

This client can be provisioned and installed from the CognosTM1 Application Gateway or installed remotely by a systemadministrator using a Windows Installer command line andother software management tools.

30 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 43: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 13. Cognos TM1 Applications - data contribution clients (continued)

Client Description

IBM Cognos Insight -Distributed

IBM Cognos Insight client with local processing of data. Data isupdated to the server only when a commit data action isperformed.

Same provisioning and installation options as the CognosInsight - Connected client.

Cognos TM1 Performance Modeler

The Cognos TM1 Performance Modeler client provides the user interface foradministrators and developers to design and deploy applications.

This user interface must be installed locally on the user's computer. Users canprovision and install this client from the Cognos TM1 Application Gateway thefirst time they open the client. System administrators can also distribute and installthe program remotely using Windows Installer and other software managementtools. For details, see “Installing Cognos TM1 Performance Modeler” on page 96.

Cognos Insight

Cognos Insight can run separate from Cognos TM1 Applications to enable users tocreate workspaces to use within an application.

This user interface must be installed locally on the user's computer. It can beprovisioned from the Cognos TM1 Application Gateway and installed by the userthe first time they open the client. System administrators can also distribute andinstall the program remotely using a Windows Installer command line and othersoftware management tools. For details, see “Installing Cognos Insight” on page99.

Cognos TM1 Applications Tier 2: Web serversThe Web servers tier contains two web servers; a required Java-based webapplication server and an optional Microsoft Internet Information Services (IIS)web server. Microsoft IIS is required only if you plan to use the IBM Cognos TM1Application Web client.

Java web application server

The Cognos TM1 Application Server and Gateway both run on a Java-based webapplication server. You can use the version of Apache Tomcat that is provided withthe installation or your own installation of one of the supported Java-based webapplication servers.

If you use Cognos TM1 Applications with a Cognos TM1 Server that is using IBMCognos security, you can deploy the Cognos TM1 Application Server with theApache Tomcat web server that is supplied with IBM Cognos. For details, see“Using Cognos TM1 Applications with Cognos Business Intelligence Security” onpage 153.

Chapter 3. Architecture 31

Page 44: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Microsoft IIS web server

Microsoft Internet Information Services (IIS) is required to support the CognosTM1 Application Web client. The Cognos TM1 Application Web client is a userinterface based on Cognos TM1 Web technology for viewing and editingapplication data. For more details, see “Configuring Cognos TM1 Applicationswith Microsoft IIS” on page 157.

Cognos TM1 Applications Tier 3: DataThe data tier for IBM Cognos TM1 Applications includes the IBM Cognos TM1Admin Server and one or more IBM Cognos TM1 servers running on either aMicrosoft Windows or UNIX-based system. The Cognos TM1 Application Serverand related client interfaces communicate with the components in the data tier toaccess Cognos TM1 data.

Cognos TM1 Admin Server

The Cognos TM1 Admin Server is a process that keeps track of all Cognos TM1servers running on a network. The Cognos TM1 Application Server communicateswith the Cognos TM1 Admin Server to determine which Cognos TM1 servers areavailable on the network.

Cognos TM1 Server

The Cognos TM1 Server contains the data for the applications that you build anddeploy with Cognos TM1 Applications.

32 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 45: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 4. Deployment

This section describes some of the typical installation and deployment scenarios forthe available IBM Cognos TM1 components. Use this section help you plan theinstallation and configuration of Cognos TM1 in different computer environmentsand to maximize its performance.

You can install and deploy components on a single computer or across multiplecomputers in a networked environment.

For each component you want to install on a different computer, run the CognosTM1 Installation Wizard on that computer.

Server components

You can install the following server components on separate dedicated computers:v Cognos TM1 Admin Server and Cognos TM1 Serverv Cognos TM1 Webv Cognos TM1 Application Server

Client components

You can install the following client components on multiple computers:v Cognos TM1 Perspectivesv Cognos TM1 Architectv Cognos TM1 Performance Modelerv Cognos Insight

Deploying Cognos TM1 on a single Windows computerInstalling IBM Cognos TM1 components on one computer running MicrosoftWindows is a practical approach for proof of concept, test, demonstration,development and training environments.

You can use either the Cognos TM1 32-bit or 64-bit installation program forWindows.

Installation on a single Windows computer is primarily intended for a single useron one of the supported 32-bit or 64-bit Windows operating systems. For example,Microsoft Windows XP, Windows Vista, or Windows 7. However these are notserver class, production level operating systems and this type of deploymentshould only be used for individual use and not in a production environment withmultiple users.

Typical single computer installation

A typical Cognos TM1 installation on a single Windows computer includes thefollowing components:

Application Tier

v Cognos TM1 Admin server

© Copyright IBM Corp. 2007, 2012 33

Page 46: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Cognos TM1 Serverv Cognos TM1 Tools

Web Application Tier

v Cognos TM1 Application Gatewayv Cognos TM1 Application Serverv Cognos TM1 Webv Cognos TM1 Operations Console

Client Tier

v Cognos TM1 Perspectivesv Cognos Insightv Cognos TM1 APIs

Developer Tier

v Cognos TM1 Architectv Cognos TM1 Performance Modeler

SamplesSample databases for Cognos TM1 and Cognos TM1 Applications

You can adjust which components you install based on your specific needs.

Deployment differences between 64-bit and 32-bit installations

Not all Cognos TM1 components are available for 64-bit systems. If the componentis available as a 64-bit installation, the default installation directory is differentfrom the default installation directory that is used in a 32-bit installation.

Deploying Cognos TM1 Admin Server and TM1 ServerYou can install the IBM Cognos TM1 Admin Server and Cognos TM1 Servercomponents on a separate Microsoft Windows and UNIX computer in yourhardware environment.

For each component you want to install on a different computer, run the CognosTM1 Installation Wizard on that computer.

You can install the Cognos TM1 Admin Server on the same computer on which theCognos TM1 Server is installed or another computer on your network.

When a Cognos TM1 server is running, it registers itself on the specified AdminServer. Cognos TM1 clients then connect to this same Admin Server to obtaininformation about Cognos TM1 servers available on a network.

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

Component Description

Cognos TM1 Server To install and configure the Cognos TM1 server, you must knowthe name of the computer on which the Cognos TM1 AdminServer is running.

34 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 47: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Component Description

Cognos TM1 AdminServer

This can be installed without any knowledge of your networktopology.

Important Notes on Distributed Installationsv All services must be running under a single domain account. The Cognos TM1

Installation Wizard sets the parameters of the domain account for you, but youmust create the account under which the services run before you run theinstallation. If services are running under different accounts, they will not beable to communicate with each other.

v Cognos TM1 services must run on computers set to the same locale. Youcannot, for example, install some services on a computer running the US Englishlocale, and other services on a computer running the German locale. Set thelocale using the Standards and Formats option in Microsoft Windows StartMenu, Regional and Local Settings.

Deploying Cognos TM1 WebDepending on your requirements, you can deploy IBM Cognos TM1 Web in anumber of different ways.

How you deploy Cognos TM1 Web depends on how you plan to use thecomponent. The typical deployment scenarios include:v As the primary web-based user interface that enables users to access Cognos

TM1 data using a web browser.For details, see “Cognos TM1 Web architecture” on page 26 and Chapter 8,“Cognos TM1 Web installation,” on page 73.

v To support the IBM Cognos TM1 Application Web client in IBM Cognos TM1Applications.The Cognos TM1 Application Web client uses the infrastructure of Cognos TM1Web. For details, see “Cognos TM1 Applications architecture” on page 29 andChapter 9, “Cognos TM1 Applications installation,” on page 77.

v To support interoperability with IBM Cognos Business Intelligence (BI)components, such as using Cognos TM1 Viewer Portlets and iWidgets.For details, see Chapter 14, “Cognos TM1 and Cognos Business Intelligenceinteroperability installation,” on page 131.

Deploying Cognos TM1 ApplicationsDepending on your specific network environment and business requirements, youcan install IBM Cognos TM1 Applications on a single computer or distribute thecomponents to separate computers in a network.

Security considerations for Cognos TM1 ApplicationsYou can use either IBM Cognos TM1 standard security authentication or IBMCognos security for the Cognos TM1 servers you use with Cognos TM1Applications.

Do not use a combination of different security authentication modes for the sameinstallation of Cognos TM1 Applications.

Chapter 4. Deployment 35

Page 48: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Determine the security mode before you configure Cognos TM1 Applications touse a Cognos TM1 server and use that same security mode with any additionalservers you add.

For details about using Cognos security, see: “Using Cognos TM1 Applicationswith Cognos Business Intelligence Security” on page 153.

Using the IntegratedSecurityMode parameter with Cognos TM1Applications

To set the Cognos TM1 security authentication mode use theIntegratedSecurityMode parameter in the Tm1s.cfg file of each Cognos TM1 serveryou want to use.

Important: The Cognos TM1 Applications component is compatible only withCognos TM1 security authentication modes 1 and 5.

For example, to use Cognos TM1 standard security authentication, set theIntegratedSecurityMode parameter to 1 for each server.

IntegratedSecurityMode=1

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

IntegratedSecurityMode=5

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

Configuring Cognos TM1 Applications security for multipleCognos TM1 Servers

If you want to use multiple Cognos TM1 servers with Cognos TM1 Applications,they must all be configured to use the same security authentication (either CognosTM1 standard authentication or Cognos security) and include the sameadministrator user name and password.

For more details, see “Configuring Cognos TM1 Applications to use MultipleCognos TM1 Servers” on page 158.

Deploying all Cognos TM1 Applications components on asingle computer

For development, testing, or demonstration purposes, you may want to install allof the required components for IBM Cognos TM1 Applications onto a singlecomputer running Microsoft Windows.

Installation program

Deploying Cognos TM1 Applications to a single computer is the quickest way toget the program up and running.

Use either the 32- or 64-bit Cognos TM1 installation program for Windows toinstall Cognos TM1 Applications on a single Windows-based computer.

36 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 49: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Required Cognos TM1 components

The following components are required to deploy and run Cognos TM1Applications on a single Windows-based computer.v Cognos TM1 Admin Serverv Cognos TM1 Serverv Cognos TM1 Application Serverv Cognos TM1 Application Gatewayv Cognos TM1 Webv Cognos TM1 Sample databases (optional) - Allows you to easily run a sample

Cognos TM1 server for testing purposes.

By default, the Cognos Configuration tool is required and automatically installedwith this configuration. After completing the installation, you use CognosConfiguration to deploy and start the Cognos TM1 Application Server and manageyour Cognos TM1 servers.

A version of Apache Tomcat web application server is also automatically installedfor use with Cognos TM1 Applications.

Cognos TM1 Web is required if you plan to use the Cognos TM1 Applications Webclient.

Required web application servers

Cognos TM1 Applications requires a Java-based web application server and anoptional instance of Microsoft Internet Information Services (IIS) web server.

You can deploy Cognos TM1 Applications to one of the following Java-based webapplication servers:v Use the version of Tomcat that is provided with the installation.v Use your own instance of Tomcatv Use your own instance of IBM Websphere

Optionally, an instance of Microsoft IIS web server is also required if you plan touse the Cognos TM1 Applications Web client which is supported by Cognos TM1Web and IIS infrastructure.

Tip: To deploy the quickest and most typical installation on a single computer, usethe provided Apache Tomcat web application server with your own instance ofMicrosoft IIS.

Deploying Cognos TM1 Applications components on separatecomputers

Deploying some or all of the IBM Cognos TM1 Applications components onseparate, dedicated computers can improve performance, availability, and capacity.

Depending on your network environment and business requirements, you candistribute the web application servers tier and data tier across multiple computersin a number of different ways.

Chapter 4. Deployment 37

Page 50: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Deploy web application servers tier and data tier on separatecomputers.

This configuration combines the Java web application server and Microsoft InternetInformation Services (IIS) on the same computer but locates the data tier CognosTM1 server) on a separate computer.

Deploy web application servers on separate computers

This configuration places the Java web application server and Microsoft IIS ontheir own computers. The data tier could also be installed on one of thesecomputers or its own dedicated computer.

Deploy all components on separate computers

This configuration places the Java web application server, Microsoft IIS, CognosTM1 Admin Server and the Cognos TM1 server(s) all on separate computers.

Checklist for deploying Cognos TM1 Applications

Use the following checklist to help you install the IBM Cognos TM1 ApplicationServer and related components on separate computers.

Table 14. Checklist for deploying IBM Cognos TM1 Applications components on separatecomputers

Install scenario Install steps

Running your Java webapplication server on a separatecomputer

Use the Cognos TM1 installation program to install theCognos TM1 Application Server and Cognos TM1Application Gateway on the computer running the Javaapplication server.

Running Microsoft IIS on aseparate computer

Use the Cognos TM1 installation program to installCognos TM1 Web on the computer running IIS.

The Installation Wizard installs the required files for theCognos TM1 Application Web client - one of the clientinterfaces for viewing and editing application data.

For details, see “Configuring Cognos TM1 Applicationswith Microsoft IIS” on page 157.

Running the data tier on aseparate computer

Use the TM1 installation program to install the TM1Admin Server and TM1 Server components on thatcomputer.

For more information, see “Deploying Cognos TM1Admin Server and TM1 Server” on page 34

Deploying Cognos TM1 client applicationsThis section describes how to deploy the different IBM Cognos TM1 client (userinterfaces) in your network environment.

The different Cognos TM1 clients include:v Cognos TM1 Perspectivesv Cognos TM1 Architectv Cognos TM1 Performance Modeler

38 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 51: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Cognos Insightv Cognos TM1 Web (using a URL / web link)v Cognos TM1 Applications (using a URL / web link)

Deploying Cognos TM1 with Cognos Business IntelligenceThere are a number of different ways that you can integrate IBM Cognos TM1 withIBM Cognos Business Intelligence (BI). This topic summarizes some of the mosttypical integration approaches and includes links to the related documentation.

The main options for integrating Cognos TM1 with Cognos BI include security,data access, and data interaction. Configuring integration between Cognos TM1and Cognos BI involves a combination of installation and configuration tasks onthe computers hosting the server and web server components. In some cases,installation and configuration is required on individual end-user computers.

Deploying Cognos TM1 to use Cognos BI security

You can configure the Cognos TM1 server to authenticate users using Cognos BIsecurity. With this configuration, any Cognos TM1 user interface or other customapplication must use a valid user name and password from the Cognos BI serverto access Cognos TM1 data. You can also configure IBM Cognos TM1 Applicationsto use Cognos BI security.

For details, see the following topics:v “Using Cognos security with Cognos TM1 ” on page 186v “Using Cognos TM1 Applications with Cognos Business Intelligence Security”

on page 153

Deploying the Cognos TM1 Package Connector to importCognos BI data into Cognos TM1

The IBM Cognos TM1 Package Connector is currently supported for use with IBMCognos Business Intelligence packages against SAP Business Warehouse and otherrelational and ODBC data sources. You can use the Cognos TM1 PackageConnector to import data from these sources into Cognos TM1 using a CognosTM1 TurboIntegrator process.

The IBM Cognos TM1 Package Connector is an optional component, separate fromthe main TM1 installation, available as its own CD or download. This componentmust be installed on both the TM1 server and the administrative client machineswhere TurboIntegrator processes are being created against a BW package.

For more details, see the following documentation:v See Chapter 15, “Cognos TM1 Package Connector installation,” on page 135 for

installation instructions.v See the "Importing Data Using the IBM Cognos TM1 Package Connector"

chapter in the IBM Cognos TM1 TurboIntegrator Guide for more information aboutusing the TM1 Package Connector.

v See the following resources:IBM Cognos Business Intelligence 10.1.0 Information Center(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m0/index.jsp)IBM Cognos Business Intelligence 10.1.1 Information Center(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m1/index.jsp)

Chapter 4. Deployment 39

Page 52: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

– See the Supported Hardware and Software link for specifics on supportedsoftware.

– See the IBM Cognos Framework Manager User Guide about creating packages.v See your SAP documentation for SAP related topics.

Deploying Cognos TM1 as a datasource with Cognos BI

You can configure IBM Cognos BI to access Cognos TM1 servers and cubes fromCognos Report Studio and Cognos Query Studio.

To enable Cognos BI reporting against Cognos TM1 data sources, use the CognosTM1 Client installation program to install the required Cognos TM1 API files on allCognos BI servers that are running report services on Microsoft Windows

For more details, see the following documentation:v See “Enabling Cognos BI reporting on Cognos TM1 data sources” on page 133

for installation instructions.v See the following topic on one of the following IBM Cognos Information

Centers:IBM Cognos Business Intelligence Administration and Security Guide > Data Sourcesand Connections > TM1 Data SourceIBM Cognos Business Intelligence 10.1.0 Information Center(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m0/index.jsp)IBM Cognos Business Intelligence 10.1.1 Information Center(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m1/index.jsp)

v See the following IBM Technote:Unable to connect to TM1 from C10: TM1-ERR-050 An attempt to initialize theTM1 API failed... (http://www-01.ibm.com/support/docview.wss?uid=swg21474468).

Deploying Cognos TM1 to use as Widgets and Viewer Portlets inCognos BI

You can use the IBM Cognos TM1 BI interoperability installation program tosupport the following functionality:v Use IBM Cognos Business Insight to access and view Cognos TM1 data as

widgets in a Cognos Business Insight dashboard.v Use IBM Cognos Connection with Cognos TM1 Viewer Portlets to access TM1

cube views and websheets.v Provide linking to Cognos TM1 Applications from Cognos BI.

For more details, see the following documentation:v See Chapter 14, “Cognos TM1 and Cognos Business Intelligence interoperability

installation,” on page 131 for installation instructions.v See the following topics on one of the following IBM Cognos Information

Centers:IBM Cognos Business Intelligence 10.1.0 Information Center(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m0/index.jsp)IBM Cognos Business Intelligence 10.1.1 Information Center(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m1/index.jsp)

40 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 53: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

– IBM Cognos Business Intelligence Installation and Configuration Guide >Configuration Options > Configuring IBM Cognos Business Insight >Configuring IBM Cognos Business Insight to Use Content from a TM1 DataServer

– IBM Cognos Business Intelligence Installation and Configuration Guide >Configuration Options > Configuring IBM Cognos Business Insight >Configuring IBM Cognos Business Insight to Access IBM Cognos TM1Contributor

– IBM Cognos Business Intelligence Administration and Security Guide > DataSources and Connections > TM1 Data Sources

– IBM Cognos Business Insight User Guide > Creating dashboards > Adding IBMCognos content > TM1 content

Chapter 4. Deployment 41

Page 54: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

42 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 55: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 5. Upgrading

Upgrading an earlier version of IBM Cognos TM1 to the newest version should beconsidered a process that you perform in stages.

You should treat upgrading as an IT project that requires careful planning,adequate time, and resources.

Upgrading to Cognos TM1 10.1 from version 9.0.x, 9.1.x, or 9.5.x requires a fullmanual uninstall, and then a full installation of 10.1.

Note: TM1 9.0.x and 9.1.x databases are automatically converted to Unicode whenthey are opened (started) with a TM1 server version 9.4 or higher. Once an olderTM1 database is converted to Unicode, it can no longer be opened in the earlierversions of TM1.

Upgrade process

When you upgrade, you perform several distinct activities:1. Stopping all related services.2. Backing up your existing data and applications.3. Removing the previous version of the product.4. Installing the new version of the product.5. Restoring your data, configuration settings, and applications with the new

version of the product.

Planning the upgradeThe steps to upgrade an existing IBM Cognos TM1 installation depends on theCognos TM1 components you currently use and have deployed.

Additional steps are required if you are also upgrading a previous version ofCognos TM1 Contributor to Cognos TM1 Applications.

Before you upgrade

Review the following considerations before you upgrade.

Cognos TM1 Admin ServerAs of IBM Cognos TM1 version 10.1.0, the TM1 Admin Serverconfiguration file, Tm1admsrv.ini, is no longer used or supported byCognos TM1. You must use Cognos Configuration to configure the CognosTM1 Admin Server.

Cognos TM1 Server

v TM1 9.0.x and 9.1.x databases are automatically converted to Unicodewhen they are opened (started) with a Cognos TM1 server version 9.4 orhigher. Once an older TM1 database is converted to Unicode, it can nolonger be opened in the earlier versions of TM1.

v In IBM Cognos TM1 version 10.1.0, you can use Cognos Configurationto start, stop, and manage your Cognos TM1 servers.

© Copyright IBM Corp. 2007, 2012 43

Page 56: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos TM1 Web

v The default installation directory for Cognos TM1 Web has changedfrom C:\inetpub\wwwroot\TM1Web to <TM1_Install>\tm1web.

v If you want to use any settings from your previous Cognos TM1 Webconfiguration file, you can selectively merge lines from your previousWeb.config file into the new Web.config file.

Cognos TM1 Applications

v Attention: You will need to edit your previous applications in CognosTM1 Performance Modeler if they use the following features:– Dynamic Subsets cannot be used as the approval hierarchy in Cognos

TM1 Applications.– Applications cannot share the same approval cubes in Cognos TM1

Applications.v A version of Apache Tomcat web application server is installed with the

new version of Cognos TM1. You can use this instance of Tomcat to runCognos TM1 Applications and manage it using Cognos Configuration.

v If you plan to use Cognos TM1 Applications without Microsoft Excelinstalled on the web server where you are running Cognos TM1 Web,you will need to explicitly set the ExcelWebPublishEnabled parameter toTrue (T) in the tm1s.cfg configuration file for your Cognos TM1 servers.Earlier versions of Cognos TM1 Contributor did not require thisparameter to be set.

Backing up your existing data

Before you upgrade, ensure that you back up your existing data, application, andconfiguration files to a safe place. Depending on your network architecture anddeployment of Cognos TM1, your Cognos TM1 data might reside on more thanone computer. Make a list of where this data is located and create a plan to backup the data.

The following files need to be backed-up:v Cognos TM1 Admin Server configuration filesv Cognos TM1 Server configuration and database filesv Cognos TM1 Web server configuration and custom filesv Cognos TM1 Architect client configuration filev Cognos TM1 Perspectives client configuration filev Cognos TM1 Contributor application and configuration files

Stopping Cognos TM1 services before upgradingAll services for the earlier version of IBM Cognos TM1 must be stopped beforeupgrading.

Procedure1. Use Windows Services to stop all Cognos TM1 services. This includes:

v Cognos TM1 Admin Serverv Cognos TM1 Excel servicev Cognos TM1 Server services

44 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 57: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

2. Stop the Cognos TM1 Contributor pmpsvc application. To do this, use themanagement tools for the web application server that is running Cognos TM1Contributor.

3. If you are using IBM Cognos Business Intelligence security with Cognos TM1Applications, stop the IBM Cognos BI service.

What to do next

Back up your existing data and applications. For more information, see “Backingup data for a previous version of Cognos TM1.”

Backing up data for a previous version of Cognos TM1This topic provides guidelines for backing up data and configuration files for allIBM Cognos TM1 9.x components.

Before you begin

Stop all related services. For more information, see “Stopping Cognos TM1 servicesbefore upgrading” on page 44.

About this task

If you are currently using a previous version of Cognos TM1, you must back upyour Cognos TM1 data directory and configuration files before installing CognosTM1 10.1. If you are using Cognos TM1 Web or Cognos TM1 Contributor, youshould also back up the related data and configuration files for those components.

Procedure1. Back up Cognos TM1 Admin Server configuration files you may want to retain,

such as the tm1admsrv.ini file located in the <TM1_Install>\bin\ directory.2. Back up Cognos TM1 Server data and configuration files <TM1_Install>\

Custom\TM1Data data directory and subdirectories to a secure location.

Tip: The default data location for Cognos TM1 9.5 was: C:\ProgramFiles\Cognos\TM1\Custom\TM1Data.

3. Back up Cognos TM1 Architect and Cognos TM1 Perspectives configurationfiles:a. Back up the system default Tm1p.ini file located here:

%ALLUSERSPROFILES%\Application Data\Applix\TM1\Tm1p.ini

For example: C:\Documents and Settings\All Users\ApplicationData\Applix\TM1\Tm1p.ini

b. Back up the user-specific Tm1p.ini file located here:%APPDATA%\Applix\TM1\Tm1p.ini

For example: C:\Documents and Settings\user name\ApplicationData\Applix\TM1\Tm1p.ini

4. Back up Cognos TM1 Web configuration and custom files to a secure location.The default location of Cognos TM1 Web 9.x was C:\inetpub\wwwroot\TM1Web

a. Back up a copy of the web.config file.

Tip: You might want to use some of the settings in this file when youconfigure your new installation of Cognos TM1 Web.

b. Backup any custom web server pages you might have created.

Chapter 5. Upgrading 45

Page 58: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

5. Back up your Cognos TM1 Contributor 9.5.x applications folder andpmpsvc_config.xml configuration file to a safe location.a. Back up the folder \webapps\pmpsvc\WEB-INF\applications.b. Backup your configuration file \webapps\pmpsvc\WEB-INF\configuration\

pmpsvc_config.xml.If you deployed with your own installation of Apache Tomcat, check here:Program Files\Apache Software Foundation\Tomcat 6.0.If you deployed with the Apache Tomcat provided with IBM Cognos BusinessIntelligence (BI), check here: Program Files\cognos\c8.

What to do next

Remove the previous version of the product. For more information, see“Uninstalling a previous version of IBM Cognos TM1.”

Uninstalling a previous version of IBM Cognos TM1All components of a previous version of IBM Cognos TM1 must be removed anduninstalled.

Before you begin

Do follow these steps on every computer that is to be upgraded. Make sure thatyou have backed up all of your data and configuration files. For more information,see “Backing up data for a previous version of Cognos TM1” on page 45.

Procedure1. To uninstall an earlier version of Cognos TM1 Server, Cognos TM1 Architect,

Cognos TM1 Perspectives, and Cognos TM1 Web:a. From the Windows Control Panel, click Add or Remove Programs.b. In the list of currently installed programs, select IBM Cognos TM1.c. Click Remove and follow the instructions to complete the process.

2. To uninstall Cognos TM1 Contributor:v Undeploy Cognos TM1 Contributor from the web application server you are

using.v Uninstall the Cognos TM1 Contributor 9.5.x Administration tool and IBM

Cognos Rich Client Framework.

What to do next

Install the new version of the product.

Upgrading a single computer installation of Cognos TM1This topic describes how to upgrade IBM Cognos TM1 on a single computerrunning on Microsoft Windows operating system.

After removing the previous version of the product, you are ready to install.

When that is done, complete the upgrade by restoring your data, configurationsettings, and applications.

46 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 59: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Related concepts:Chapter 6, “Cognos TM1 single-computer installation,” on page 53This type of installation puts IBM Cognos TM1 on a single computer running theMicrosoft Windows operating system and using default settings. Use this kind ofinstallation to get up and running quickly with Cognos TM1 or to install a test orevaluation environment.

Upgrading Cognos TM1 Server on UNIX or LinuxYou can upgrade the Cognos TM1 server components on a 64-bit computerrunning either a UNIX or Linux operating system.

After removing the previous version of the product, you are ready to install.

When that is done, complete the upgrade by restoring your data, configurationsettings, and applications.Related concepts:“Installing Cognos TM1 Server on UNIX or Linux” on page 65You can install the Cognos TM1 server components on a 64-bit computer runningeither a UNIX or Linux operating system. Use this type of installation to installand run the Cognos TM1 server on a dedicated computer that remote users canaccess.

Upgrading Cognos TM1 Server on WindowsYou can upgrade the Cognos TM1 server components on either 32-bit or 64-bitcomputers running the Microsoft Windows operating system.

After removing the previous version of the product, you are ready to install.

When that is done, complete the upgrade by restoring your data, configurationsettings, and applications.Related concepts:“Installing Cognos TM1 Server on Windows” on page 63You can install the Cognos TM1 server components on either 32-bit or 64-bitcomputers running the Microsoft Windows operating system. Use this type ofinstallation to install and run the Cognos TM1 server on a dedicated computer thatremote users can access.

Upgrading Cognos TM1 Architect and Perspectives clientsYou can upgrade IBM Cognos TM1 client components using the Cognos TM1server installation program or the Cognos TM1 client installation program.

After removing the previous version of the product, you are ready to install.

When that is done, complete the upgrade by restoring your data, configurationsettings, and applications.

Chapter 5. Upgrading 47

Page 60: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Related concepts:Chapter 10, “Cognos TM1 client installation,” on page 93You can install IBM Cognos TM1 client components using the Cognos TM1 serverinstallation program or the Cognos TM1 client installation program.

Upgrading Cognos TM1 WebIf you have IBM Cognos TM1 Web on a computer that is separate from thecomputer where you installed the Cognos TM1 server then do these steps toupgrade the web server.

After removing the previous version of the product, you are ready to install.

When that is done, complete the upgrade by restoring your data, configurationsettings, and applications.Related concepts:Chapter 8, “Cognos TM1 Web installation,” on page 73You can install IBM Cognos TM1 Web on a computer that is separate from thecomputer where you installed the Cognos TM1 server and other Cognos TM1components.

Upgrading Cognos TM1 Contributor to Cognos TM1 ApplicationsUpgrading Cognos TM1 Contributor to Cognos TM1 Applications requires a seriesof steps. These steps include a process to move your old application files intoCognos TM1 Applications.

Before you begin

Review the following considerations before you upgrade your application filesfrom Cognos TM1 Contributor to Cognos TM1 Applications.

Attention: You might need to edit your old applications to make themcompatible with the newer version.v Dynamic Subsets cannot be used as the approval hierarchy in Cognos TM1

Applications.v Applications cannot share the same approval cubes in Cognos TM1 Applications.

If an application cannot be upgraded, a message is displayed during the upgradeprocess and the application is moved to an undeployed state. Undeployedapplications do not appear in the Cognos TM1 Applications portal, but instead,appear in the Cognos TM1 Performance Modeler application design tab. You canuse Cognos TM1 Performance Modeler to edit and fix the application and thenvalidate and deploy it.

Procedure1. Stop related services.

See “Stopping Cognos TM1 services before upgrading” on page 44.2. Back up your Cognos TM1 Contributor 9.5.x applications folder and

pmpsvc_config.xml configuration file to a safe location.a. Back up the folder \webapps\pmpsvc\WEB-INF\applications.b. Back up your configuration file \webapps\pmpsvc\WEB-INF\configuration\

pmpsvc_config.xml.

48 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 61: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

If you deployed with your own installation of Apache Tomcat, check here:Program Files\Apache Software Foundation\Tomcat 6.0.If you deployed with the Apache Tomcat provided with IBM Cognos BusinessIntelligence (BI), check here: Program Files\cognos\c8.

3. Uninstall IBM Cognos TM1 9.5.x.See “Uninstalling a previous version of IBM Cognos TM1” on page 46

4. Uninstall the Cognos TM1 Contributor 9.5.x Administration tool and IBMCognos Rich Client Framework:

Tip: You will need to repeat these steps for each computer where the CognosTM1 Contributor 9.5.x Administration tool was installed.a. In Microsoft Windows, open Add or Remove Programs.

Attention: Depending on how the Administration tool was installed, youmight only see one entry.

b. If the entry exists, first remove IBM Cognos TM1 ContributorAdministration.

c. Remove the IBM Cognos Rich Client Framework.5. Undeploy the Cognos TM1 Contributor pmpsvc web application:

v If you deployed with your own installation of Apache Tomcat or IBMWebsphere, use the respective management tool to undeploy the pmpsvcweb application.

v If you deployed with IBM Cognos BI, the program files are located in thefollowing locations:– C:\Program Files\cognos\c8\webapps\pmpsvc

– C:\Program Files\cognos\c8\tomcat4.1.27\work\Standalone\localhost\pmpsvc

6. Install Cognos TM1 Applications.For details, see Chapter 9, “Cognos TM1 Applications installation,” on page77.

7. Restore your data files for each Cognos TM1 server you plan to use withCognos TM1 Applications.For details, see “Restoring data from a previous version into Cognos TM1” onpage 50.

8. Edit the tm1s.cfg configuration file for each Cognos TM1 server that youwant to use with Cognos TM1 Applications:a. Configure the ExcelWebPublishEnabled parameter.

Important: Earlier versions of Cognos TM1 Contributor always consideredthis parameter was set to True and did not use the actual setting in theCognos TM1 server tm1s.cfg file. As of Cognos TM1 10.1, Cognos TM1Applications uses this parameter, requiring you to explicitly configure theparameter in the tm1s.cfg file.For more details, see “ExcelWebPublishEnabled” on page 232.

b. Configure the AllowSeparateNandCRules andDistributedPlanningOutputDir parameters.For more details, see “Configuring a Cognos TM1 Server to work withCognos TM1 Applications” on page 91.

9. If you want to use any of your old configuration settings, manually copy themfrom your old file into the new configuration files for Cognos TM1Applications.

Chapter 5. Upgrading 49

Page 62: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Attention: In Cognos TM1 Applications, the contents of the previouspmpsvc_config.xml configuration file has been reorganized into two separatefiles; pmpsvc_config.xml and fpmsvc_config.xml.a. Copy client settings from the old pmpsvc_config.xml file into the new

pmpsvc_config.xml file.b. Copy server related settings from the old pmpsvc_config.xml file into the

new fpmsvc_config.xmlfile.10. Copy your previous Cognos TM1 Contributor 9.5.x applications folder into

the new location for Cognos TM1 Applications:For example, C:\Program Files\IBM\cognos\tm1\webapps\pmpsvc\WEB-INF\applications

11. Start the related Cognos TM1 services using IBM Cognos Configuration.a. TM1 Admin Server

b. TM1 Excel service

c. TM1 Application Server

d. Start any Cognos TM1 servers you are using with Cognos TM1Applications.

12. Log in to the Cognos TM1 Applications portal as an administrator to upgradeyour applications.During the login process, the application files in the webapps/pmpsvc/WEB-INF/application folder will be upgraded from Cognos TM1 Contributor 9.5.2 toCognos TM1 Applications.

13. If you are prompted about dynamic subsets during the upgrade process, editthe application to make it compatible.a. Open Cognos TM1 Performance Modeler.b. Change the subset from dynamic to static or select a new static subset to

usec. Redeploy the application and review the security for the application. Some

security may have changed requiring you to recreate the securityassignments using the Manage Rights options.For details, see the IBM Cognos TM1 Performance Modeler User Guide.

14. If you are prompted about shared views during the upgrade process, edit theapplication to make it compatible.a. Open Cognos TM1 Performance Modeler.b. To fix the issue, you will need to reorganize the TM1 data so that approval

cubes are not shared by applications.c. Save and deploy the application.

For details, see the IBM Cognos TM1 Performance Modeler User Guide.

Restoring data from a previous version into Cognos TM1After installing the newer version of IBM Cognos TM1, complete these steps torestore your previous Cognos TM1 configuration and database files.

Before you begin

Install the new version of the product.

50 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 63: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Restore your Cognos TM1 Admin Server configuration files:

Attention: As of IBM Cognos TM1 version 10.1.0, the TM1 Admin Serverconfiguration file, Tm1admsrv.ini, is no longer used or supported by CognosTM1. The configuration settings for the Cognos TM1 Admin Server are nowexclusively configured and stored in the IBM Cognos Configuration tool. Youmust use Cognos Configuration to configure the Cognos TM1 Admin Server.a. Open IBM Cognos Configuration.b. In the Cognos Configuration Explorer pane, expand Local Configuration >

Environment and click TM1 Admin Server. The parameters for the AdminServer display in the Properties pane.

c. Open the old Tm1admsrv.ini file.d. For each parameter you want to use with your new installation, copy the

value of the parameter from the Tm1admsrv.ini file into the matchingparameters in Cognos Configuration. For example, if you were usingcustom SSL settings with your previous installation, copy the values forthese parameters into Cognos Configuration.

e. In Cognos Configuration, click File > Save.2. Restore your Cognos TM1 Server data and configuration files:

Tip: As of IBM Cognos TM1 version 10.1.0, you can use Cognos Configurationto start, stop, and manage your CognosTM1 servers.a. For each Cognos TM1 server that you want to restore, copy its data

directory and subdirectories to the new location for data:<TM1_Install>\samples\tm1.

b. Add each CognosTM1 server in Cognos Configuration where you can start,stop, and manage the server. For details, see “Adding an existing CognosTM1 server in Cognos Configuration” on page 70.

3. Restore your Cognos TM1 Architect and Cognos TM1 Perspectivesconfiguration files:

If you want to restore any settings from your previous installation of CognosTM1 Architect or Cognos TM1 Perspectives, copy the values from your oldTm1p.ini file into the new Tm1p.ini file.Attention: If you leave your old Tm1p.ini files in place, you might need toupdate the directory path in the file for the AdminSvrSSLCertAuthorityparameter. For example, if you are using the default Cognos TM1 SSLcertificate, manually change the value for this parameter to the new install pathC:\Program Files\IBM\cognos\tm1\bin\ssl\applixca.pem.a. Update the new system default Tm1p.ini file located here:

%ALLUSERSPROFILES%\Application Data\Applix\TM1\Tm1p.ini

For example: C:\Documents and Settings\All Users\ApplicationData\Applix\TM1\Tm1p.ini

b. Update the new user-specific Tm1p.ini file located here:%APPDATA%\Applix\TM1\Tm1p.ini

For example: C:\Documents and Settings\user name\ApplicationData\Applix\TM1\Tm1p.ini

4. Restore your Cognos TM1 Web files:

If you are using the new version of Cognos TM1 Web, restore any configurationsettings or custom files that you want to use.

Chapter 5. Upgrading 51

Page 64: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Note: As of IBM Cognos TM1 version 10.1.0, the default installation directoryfor Cognos TM1 Web is <TM1_Install>\tm1web.a. Open your old Web.config file and selectively merge the lines and

parameters that you want to use into the new Web.config file located in<TM1_Install>\tm1web.

b. If you want to use any of your previous custom Cognos TM1 Web serverpages, copy them into the new Cognos TM1 Web directory.

5. Restore your Cognos TM1 Contributor 9.5.x application and configurationfiles in Cognos TM1 Applications:

For details, see “Upgrading Cognos TM1 Contributor to Cognos TM1Applications” on page 48.

52 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 65: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 6. Cognos TM1 single-computer installation

This type of installation puts IBM Cognos TM1 on a single computer running theMicrosoft Windows operating system and using default settings. Use this kind ofinstallation to get up and running quickly with Cognos TM1 or to install a test orevaluation environment.

To configure and install the full features and optional components of Cognos TM1,see the comprehensive IBM Cognos TM1 Installation and Configuration Guide(http://publib.boulder.ibm.com/infocenter/ctm1/v10r1m0/topic/com.ibm.swg.ba.cognos.tm1_inst.10.1.0.doc/c_tm1_inst_intro.html).

The single computer installation explains how to install and run:v Cognos TM1 Admin Serverv Cognos TM1 Serverv Cognos TM1 Perspectivesv Cognos TM1 Architectv Cognos TM1 Webv Cognos TM1 Application Serverv Cognos TM1 Application Webv Cognos Insightv Cognos TM1 Performance Modeler

This installation scenario assumes:v You are on a single 32- or 64-bit computer running the Microsoft Windows

operating system.v You use the Apache Tomcat web server software installed by the Cognos TM1

installation.v You use the default, standard Cognos TM1 authentication.v You accept the default configurations including English as the language.

Not all Cognos TM1 components are available for 64-bit systems. If the componentis available as a 64-bit installation, it is installed in a directory identified as a 64-bitlocation instead of in the default 32-bit installation directory location. For example,bin64 instead of bin.

Remember: Your browser may use a slightly different interface than the browserused in the steps described here.Related concepts:“Upgrading a single computer installation of Cognos TM1” on page 46This topic describes how to upgrade IBM Cognos TM1 on a single computerrunning on Microsoft Windows operating system.

Install the prerequisite softwareYou need the prerequisite software before you install IBM Cognos TM1.

© Copyright IBM Corp. 2007, 2012 53

Page 66: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

About this task

If you do not have these prerequisites in place, the Cognos TM1 Installation wizardtries to install them for you, however the wizard can install only one at a time. Ifyou are missing more than one, you may need to restart the install until you havethem all. You may already have this software installed.

Procedure1. Install or confirm that you have:

v Microsoft .NET Framework 3.5 Service Pack 1v Microsoft Visual C++ 2005 SP1 Redistributable Packagev Microsoft ExcelThis software is used by Cognos TM1 Perspectives or Cognos TM1 Architect.

2. Install or confirm that you have:v Microsoft .NET Framework 3.5 Service Pack 1v Microsoft Chart Controls for Microsoft .NET Framework 3.5v Microsoft Internet Information Services (IIS) web server software.This software is used by Cognos TM1 Web or Cognos TM1 Application Server.On Windows 7, Windows XP, and Windows Server 2008 operating systems,ensure that the IIS 6 Management Compatibility option is enabled. Without thissetting, Cognos TM1 Web cannot create the virtual directories it needs. Searchthe Microsoft support website for "IIS 6 Management Compatibility" for moredetails.See Cognos TM1 10.1.0 Software Environments (www.ibm.com/support/docview.wss?uid=swg27021976) for the latest information about prerequisitesoftware.

3. Cognos Insight and Cognos TM1 Performance Modeler can both be launchedfrom the Cognos TM1 Applications portal, so you must install and be able torun Cognos TM1 Applications before you can launch Cognos Insight or CognosTM1 Performance Modeler from that portal.

Install the basic Cognos TM1 componentsUse the installation program to select the components you want to install and thelocation on your computer where you want to install them.

Before you beginv Ensure that you have administrator privileges for the computer on which you

are installing software.v Ensure that the computer has a TEMP system variable that points to the

directory where you want to store temporary files. During installation, files aretemporarily copied to this directory.

v Some Microsoft Windows web server software does not support non-ASCIIcharacters in directory names. Ensure that the directories where you install IBMCognos TM1 components contain only ASCII characters in the path name.

v Ensure that all of the prerequisite software has been installed.v There are several varieties of installation program available to you. Depending

on which operating system you are using, go to the directory where the one youwant to install is stored:– TM1 for 32-bit Windows– TM1 for 64-bit Windows

54 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 67: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. To start the installation:

v Go to the download location for the Cognos TM1 installation program thatyou want to use.

v Or, insert the IBM Cognos TM1 product disk.If the installation wizard does not open automatically, go to the operatingsystem directory to locate the issetup.exe command.

2. Depending on your operating system software, right-click or double-click theissetup.exe command:v On Microsoft Windows Vista, Windows 7, or Windows Server 2008 operating

system software, right-click the issetup.exe command and click Run asAdministrator.

v For all other Windows operating system software, double-click issetup.exe.

3. Follow the directions in the installation wizard to select all of the components.The components that you need to run the software are selected by default.If you do not want to install Cognos Insight or Cognos TM1 PerformanceModeler, skip to Step 5.

4. To include Cognos Insight in the installation, expand the TM1 Client Tier andthe select Cognos Insight.

5. To include Cognos TM1 Performance Modeler in the installation, expand theTM1 Developer Tier and select TM1 Performance Modeler.

6. Click Next until the installation begins.The installation runs until all components have been installed. This may take asignificant amount of time.

Tip: For earlier Windows operating systems, you can check Start CognosConfiguration on the last screen of the installation to immediately run theconfiguration tool. On Microsoft Windows Vista, Windows 7, or WindowsServer 2008 operating system software, do not check that box and instead usethe Start menu so you can choose Run as Administrator when launching theCognos Configuration tool.

7. Click Finish.

Use Cognos Configuration to start the Cognos TM1 componentsBefore you can use Cognos TM1, you need to start the IBM Cognos TM1 AdminServer, the TM1 Excel service, the TM1 Application Server, and at least one IBMCognos TM1 sample database server. This action registers the servers in theWindows service restry. Then you need to configure the services so that they rununder a specific user. Servers that are running in a Microsoft Windowsenvironment are referred to as "services."

Procedure1. If it is not already running, start the configuration tool by clicking Start > All

Programs > IBM Cognos TM1 > IBM Cognos Configuration.

Remember: Right-click and use Run as Administrator on Windows Vista,Windows 7, and Windows Server 2008 operating system software.

2. In the Cognos Configuration Explorer pane, expand Local Configuration >Environment.

3. Right-click each server that you want to start and select Start:

Chapter 6. Cognos TM1 single-computer installation 55

Page 68: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

a. TM1 Admin Server It is best to start the TM1 Admin Server first since thatserver must be running before any sample database can run.The Cognos Configuration tool prompts you to save any edits made to theconfiguration settings. This process will take longer the first time you save asetting as the cryptographic settings and other actions take place for thefirst time. Click Yes in response to the message asking you to save thesettings. You will also see this type of message when you close CognosConfiguration.

b. TM1 Excel service

c. TM1 Application Server

4. Expand the Data Access > TM1 Server node and right-click each Cognos TM1sample database server that you want to start and select Start. For example,start the provided sample databases:a. SData

b. Planning Sample

c. GO_New_Stores

5. Click File > Save.6. Now that the services are all registered in the Windows services registry, you

can reconfigure them to use a specific user account:a. In Cognos Configuration, right-click each service you want to change and

select Stop.b. Open Windows Services.c. Right-click on each service and select Properties.d. Enter a user name and password valid on your system with the appropriate

rights for the service. See "User accounts for running Cognos TM1 serviceson Windows" in the "Planning" chapter of the IBM Cognos TM1 Installationand Configuration Guide for details about the rights that this user accountshould have.

e. Close Windows Services.7. In Cognos Configuration, right-click each server and select Start.8. Close Cognos Configuration.

Run Cognos TM1 PerspectivesAfter installation, you can run IBM Cognos TM1 Perspectives.

Procedure1. From the Windows Start menu, click IBM Cognos TM1 > Perspectives. If the

component does not start, ensure that the servers you started with CognosConfiguration are still running.

2. Click Enable Macros when the security warning displays.3. Click TM1 > Server Explorer, then expand TM1 to see the servers that are

available.4. Double-click a Cognos TM1 Server to log in.

For SData, Planning Sample, or GO_New_Stores use these login credentials:v User name: admin

v Password: apple

Tip: To load Cognos TM1 Perspectives automatically whenever you startMicrosoft Excel, add TM1_location/Tm1p.xla to Microsoft Excel's add-in tool

56 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 69: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

list, where TM1_location is the file directory where Cognos TM1 is installed.After completing this step, "TM1" displays on the Microsoft Excel menu bar.

Run Cognos TM1 ArchitectAfter installation, you can run the non-Microsoft Excel version of IBM Cognos TM1called IBM Cognos TM1 Architect.

Procedure1. From the Windows Start click All Programs > IBM Cognos TM1 > Architect.

If Cognos TM1 Architect does not start up, ensure that the servers you startedwith Cognos Configuration are still running.

2. Expand TM1 to see the servers that are available.3. Double-click a Cognos TM1 Server to log in.4. Use these credentials to log into the SData, Planning Sample, or

GO_New_Stores sample databases:v User name: admin

v Password: apple

Run Cognos TM1 WebThe IBM Cognos TM1 installation configures IBM Cognos TM1 Web to run withyour existing installation of Microsoft Internet Information Services (IIS) webserver software.

Before you begin

Keep in mind the following information when using TM1 Web:v On Windows 7, Windows XP, and Windows Server 2008 operating systems,

ensure that the IIS 6 Management Compatibility option is enabled. Without thissetting, Cognos TM1 Web cannot create the virtual directories it needs. Searchthe Microsoft support website for "IIS 6 Management Compatibility" for moredetails.

v See "Changing Cognos TM1 services to run as a specific user account onWindows" in the "Cognos TM1 Web installation" chapter of the IBM Cognos TM1Installation and Configuration Guide for details on how to configure the TM1 ExcelService to run as a specific user.

Procedure1. In a web browser, enter the following URL: http://localhost/tm1web

You can use the "localhost" term to make the computer location default to useyour current computer. Or you can explicitly enter the IP address or name forthe computer where you installed Cognos TM1.

2. Depending on what other components you have launched, the Log In boxvalues will usually be automatically entered for you. If they are not, you canenter or change those values as needed.

3. Click Log In.

Note: Your anti-virus software may prompt you when the Cognos TM1 Excelservice attempts to log into the web. Follow your company guidelines forsecurity. Cognos TM1 Web requires access to the web so a setting such asPermit Always is optimal for all your Cognos TM1 services.

Chapter 6. Cognos TM1 single-computer installation 57

Page 70: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Run the Cognos TM1 Applications portalIBM Cognos TM1 Applications is the web-based client and portal used to runplanning applications built using IBM Cognos TM1 data.

About this task

Cognos TM1 Applications is also used to launch IBM Cognos TM1 PerformanceModeler and can be used to launch IBM Cognos Insight.

Procedure1. In a web browser, enter the following URL: http://localhost:9510/pmpsvc

where 9510 is the usual port used by Cognos TM1 Application Server. If youused a different port when you installed, enter that other value here.

2. Accept the defaults for all of the configuration settings to identify the AdminHost, server, types of clients, and the URL used by the Cognos TM1Applications Server.

3. Click OK.4. Enter the admin and apple for theusername and password for the sample

database servers.5. To complete the installation, dismiss the message about editing the

AllowSeparateNandCRules and DistributedPlanningOutputDir parameters in thetm1s.cfg files.You do not need to edit those parameters until you begin working with theclients.The portal is empty until you build an application using Cognos TM1Performance Modeler or import an existing application.

Run Cognos TM1 Performance ModelerIBM Cognos TM1 Performance Modeler is available as an unselected component ofthe IBM Cognos TM1 installation. You launch Cognos TM1 Performance Modelerfrom the IBM Cognos TM1 Applications portal.

Procedure1. From the Cognos TM1 Applications portal, click the Open Performance

Modeler icon.

Remember: Depending on your browser, you may see slightly different stepsused to install downloaded components such as Cognos TM1 PerformanceModeler.

2. Click OK with the Open with IBM Cognos RCP Application Updater selectedon the provagent.cogrcp_modeler dialog box.

3. Click OK to dismiss the configuration settings message and complete theinstallation.You do not need to edit those parameters until you begin working with theclients.

4. Click the Model Design tab to see the GO_New_Stores data cubes andstructure.

5. Click the Application Design tab to build a new application usingGO_New_Stores.

58 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 71: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

See the IBM Cognos TM1 Performance Modeler User Guide found on the TM110.1.0 Information Center(http://publib.boulder.ibm.com/infocenter/ctm1/v10r1m0/index.jsp) for details on using the Cognos TM1 Performance Modelerto design and build applications.

Run Cognos InsightIBM Cognos Insight is available as an unselected component of the IBM CognosTM1 installation. Cognos Insight can be used as a client for contributing toapplications and also as a dynamic workspace builder for creating interactivecontributing user experiences.

Procedure1. To run Cognos Insight, complete one of the following actions:

v From the Cognos TM1 Applications portal, click the icon.Or you can:

v Right-click a node of an application that has been configured to use CognosInsight.

v You can also click the Cognos Insight desktop icon that gets installed.v Cognos Insight can also be installed as a stand-alone component.

Remember: Depending on your browser, you may see slightly different stepsused to install downloaded components such as Cognos Insight.

2. Click OK with the Open With IBM Cognos RCP Application Updater selectedon the provagent.cogrcp_insight dialog box.

3. If you see an Executable file warning, click OK to proceed with the installation.4. Click OK to dismiss the AllowSeparateNandCRules and

DistributedPlanningOutputDir configuration setting message.You do not need to edit those parameters until you begin working with theclients.See the IBM Cognos Insight User Guide on the TM1 10.1.0 Information Center(http://publib.boulder.ibm.com/infocenter/ctm1/v10r1m0/index.jsp) fordetails about creating Cognos Insight workspaces and using Cognos Insight asa client for contributing to applications.

Use Cognos TM1 Application WebThe IBM Cognos TM1 Application Web is a web-based client used to contribute toplanning applications and to work with IBM Cognos TM1 Websheets.

Before you begin

You need a planning application before you can use the Cognos TM1 ApplicationWeb client. The application designer identifies which clients can be used with aparticular application.

Tip: You can see which clients the designer made available for an application byright-clicking a node of the application when it is displayed in the IBM CognosTM1 Applications portal.

Chapter 6. Cognos TM1 single-computer installation 59

Page 72: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. In the Cognos TM1 Applications portal, right-click a node in a planning

application.2. Select TM1 Contributor client to launch the Cognos TM1 Application Web

client.See the IBM Cognos TM1 Applications Guide found on the Cognos TM1 10.1.0Information Center (http://publib.boulder.ibm.com/infocenter/ctm1/v10r1m0/index.jsp) for details on how to contribute to an application using the CognosTM1 Application Web client.

Other Cognos TM1 componentsThe IBM Cognos TM1 installation makes many other components available andhas many other ways to customize the installation.

See the following the documentation and components for details about other waysto install, deploy, and configure Cognos TM1:v IBM Cognos TM1 Operations Console - The IBM Cognos TM1 Operations

Console is a tool used by administrators to monitor the activity of TM1 serverson your network. See the IBM Cognos TM1 Operations Console Guide for moreinformation.

v TM1 Business Intelligence (BI) Interoperability - Installs optional componentsthat provide interaction between IBM Cognos TM1 and IBM Cognos BusinessIntelligence (BI). Provides support for Cognos TM1 Viewer Portlets, accessingCognos TM1 data from Cognos BI queries, reports, and dashboards,provisioning Cognos TM1 clients from the Cognos BI Gateway, and linking toIBM Cognos TM1 Applications from Cognos BI. See the IBM Cognos TM1Installation and Configuration Guide for more information.

v IBM Cognos TM1 Package Connector - Use this to import IBM CognosFramework Manager packages. See the IBM Cognos TM1 TurboIntegrator Guidefor more information.

See the comprehensive IBM Cognos TM1 Installation and Configuration Guide fordetails on these additional components and on other ways to install and deployCognos TM1.

Configuring client computers to export Cognos TM1 data in PDFformat

To export IBM Cognos TM1 data to Adobe PDF format from IBM Cognos TM1client applications running in Microsoft Windows, set PDFCamp as your defaultprinter and ensure that the Windows service for the IBM Cognos TM1 ExcelService is running as a specific user account. These steps apply to IBM CognosTM1 Perspectives, IBM Cognos TM1 Architect, and IBM Cognos TM1 Web.

Before you begin

Verify that PDFCamp is installed correctly by confirming that PDFCamp PrinterDriver exists in the Windows Printers and Faxes configuration.

Procedure1. Configure the default printer:

a. In Windows, open the Printers and Faxes configuration window.

60 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 73: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

b. Right-click PDFCamp Printer Driver and select Set as Default Printer.2. Ensure that the Windows service for the Cognos TM1 Excel Service is running

as a specific user account and not as Local System account.a. On the web server where Cognos TM1 Web is running, open Windows

Services.b. Locate the entry for IBM Cognos TM1 Excel Service.c. Right-click IBM Cognos TM1 Excel Service and select Properties.d. Enter a user and password for an existing Windows user with the

appropriate rights.e. Restart the service and close Windows Services.

For more details, see “User accounts for running Cognos TM1 services” and“Changing Cognos TM1 services to run as a specific user account onWindows”.

Chapter 6. Cognos TM1 single-computer installation 61

Page 74: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

62 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 75: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 7. Cognos TM1 Server installation

Use this section to install and configure the IBM Cognos TM1 Admin Server andIBM Cognos TM1 Server on a dedicated computer running either the MicrosoftWindows, UNIX, or Linux operating system.

The Cognos TM1 Admin Server can reside on the same computer as the CognosTM1 Server or another computer on your network.

The server components can be installed on either 32-bit or 64-bit computersrunning the Microsoft Windows operating system. For UNIX or Linux operatingsystems, only 64-bit computers are supported.

For more details on deployment scenarios and options, see “Deploying CognosTM1 Admin Server and TM1 Server” on page 34.

Server components

The Cognos TM1 server components include the following:v Cognos TM1 Admin Server - requiredv Cognos TM1 Server - requiredv Cognos TM1 Tools - optional

These components are grouped together under the TM1 Application Tier in theinstallation program.

IBM Cognos Configuration

By default, IBM Cognos Configuration is also installed with the requiredcomponents on Windows, UNIX, and Linux as the primary tool for managing theCognos TM1 Admin Server and Cognos TM1 Server. This tool provides a userinterface for stopping and starting the server components.

Installing Cognos TM1 Server on WindowsYou can install the Cognos TM1 server components on either 32-bit or 64-bitcomputers running the Microsoft Windows operating system. Use this type ofinstallation to install and run the Cognos TM1 server on a dedicated computer thatremote users can access.Related concepts:“Upgrading Cognos TM1 Server on Windows” on page 47You can upgrade the Cognos TM1 server components on either 32-bit or 64-bitcomputers running the Microsoft Windows operating system.

Install Cognos TM1 Server components on WindowsInstall the IBM Cognos TM1 Server components on a computer that uses MicrosoftWindows.

Procedure1. Choose the installation program that matches the type of computer being used

for the Cognos TM1 Server:

© Copyright IBM Corp. 2007, 2012 63

Page 76: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Cognos TM1 32-bit for Windowsv Cognos TM1 64-bit for Windows

2. On Microsoft Windows Vista, Windows 7 or Windows Server 2008 operatingsystem software, right-click the issetup.exe command and click Run asAdministrator. For other operating systems, double-click the issetup.exe file tostart the installation wizard.

3. Follow the directions in the installation wizard and advance to the ComponentSelection page.

4. Unselect all the components. By default, all components are initially selected.5. Expand the TM1 Application Tier and select the following components:

v TM1 Server

v TM1 Admin Server

v TM1 Tools - Optional6. Follow the directions in the installation wizard to complete the installation.7. In the Finish page of the installation wizard, click Finish.

Use Cognos Configuration to start Cognos TM1 servers onWindows

Before you can use the Cognos TM1 Server, you need to start the IBM Cognos TM1Admin Server in IBM Cognos Configuration. Servers that are running in aMicrosoft Windows environment are referred to as "services."

About this task

By default, Cognos Configuration registers TM1 server components to run asWindows services using the predefined Local System account. However, the TM1components should be run as a specific user.

Important: Change the following Cognos TM1 services that are created by CognosConfiguration so that the services run under a specific user account on MicrosoftWindows:v Cognos TM1 Admin Serverv Cognos TM1 Serverv Cognos TM1 Excel service

For details, see, “User accounts for running Cognos TM1 services on Windows” onpage 17.

Procedure1. If it is not already running, start the configuration tool by clicking Start > All

Programs > IBM Cognos TM1 > IBM Cognos Configuration.

Remember: Right-click and use Run as Administrator on Windows Vista,Windows 7, and Windows Server 2008 operating system software.

2. In the Cognos Configuration Explorer pane, expand Local Configuration >Environment.

3. Right-click each server that you want to start and select Start:a. TM1 Admin Server

Tip: The Cognos Configuration tool prompts you to save any edits made tothe configuration settings. This process will take longer the first time you

64 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 77: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

save a setting as the cryptographic settings and other actions take place forthe first time. Click Yes in response to the message asking you to save thesettings. You will also see this type of message when you close CognosConfiguration.

4. Expand the Data Access > TM1 Server node and right-click each Cognos TM1sample database server that you want to start and select Start. For example,start the provided sample databases:a. SData

b. Planning Sample

c. GO_New_Stores

5. Click File > Save.6. Edit the entries for the Cognos TM1 components in Windows Services so that

they run under a specific user account.For details, see, “Changing Cognos TM1 services to run as a specific useraccount on Windows” on page 141.

Installing Cognos TM1 Server on UNIX or LinuxYou can install the Cognos TM1 server components on a 64-bit computer runningeither a UNIX or Linux operating system. Use this type of installation to installand run the Cognos TM1 server on a dedicated computer that remote users canaccess.

Managing components after installing

After completing the installation, you can use IBM Cognos Configuration tomanage the servers you want to run. You can also use the start and stop scriptsthat are provided with the installation.

Accessing and viewing data

To view and interact with the data stored in a Cognos TM1 server running on aUNIX system, use one of the Cognos TM1 clients on a computer running MicrosoftWindows.

Tip: You can use Cognos TM1 Architect on a computer running MicrosoftWindows to remotely log into a server running on a UNIX system.Related concepts:“Upgrading Cognos TM1 Server on UNIX or Linux” on page 47You can upgrade the Cognos TM1 server components on a 64-bit computerrunning either a UNIX or Linux operating system.

Install Cognos TM1 Server components on UNIX or Linuxoperating systems

Use the installation wizard to select the server components for installation and theinstall location on your computer.

For a complete list of supported UNIX and Linux operating systems, click the IBMCognos TM1 Cognos TM1 Software Environments web page.

Chapter 7. Cognos TM1 Server installation 65

Page 78: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Before you begin

When installing Cognos TM1 on UNIX or Linux operating systems, configure thecomponents to run as a user with appropriate permissions for Cognos TM1binaries and TM1 databases..

To prepare to install Cognos TM1, you should complete the tasks described in thefollowing checklist:v Familiarize yourself with Cognos TM1 terms and concepts.

See the IBM Cognos TM1 Users Guide and the IBM Cognos TM1 Developers Guide.v Determine which components you want to install and how they should be

distributed across your hardware environment.

Remember: Only the Cognos TM1 Admin Server and Cognos TM1 Server canrun on UNIX. You cannot run Cognos TM1 clients or Cognos TM1 Web onUNIX.For details on how to design the optimal TM1 environment, see Chapter 3,“Architecture,” on page 21 and Chapter 4, “Deployment,” on page 33.

v Determine your hardware and software requirements.Refer to the IBM Cognos TM1 Information Center for hardware and softwarerequirements.If you plan to import data from another relational database, install yourdatabase software first.If you are running Oracle on UNIX, install the appropriate UNIX client softwarefor your Oracle database on the UNIX machine. Use the Oracle NetworkConfiguration Assistant to specify a local net service name.

v Check the X-server software on your UNIX machine.To run the Graphical User Interface UNIX Installation Wizard, X-server softwaremust be installed on the machine that will host your TM1 components. Youmust have X-server client software installed on the machine from which you runthe TM1 Installation Wizard. If X-server software is not installed on the UNIXmachine, run the console installation.If you do not use X-server software, you must use an unattended installation.For more information, see Appendix D, “Setting up unattended installations andconfigurations,” on page 269.

v Install and configure the Cognos TM1 components to run as a user withappropriate permissions for Cognos TM1 binaries and TM1 databases.

Procedure1. Go to the location where the installation files were downloaded and extracted,

or insert the product disk.2. Go to the operating system directory and then type

./issetup

3. Follow the directions in the installation wizard and copy the required files toyour computer.

4. Select the components you want to install. By default, all components will beinstalled.

5. In the Finish page of the installation wizard, click Finish.

Update your Java environmentTo be able to start IBM Cognos Configuration on UNIX and Linux operatingsystems you must set the JAVA_HOME environment variable.

66 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 79: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure

Ensure that the JAVA_HOME environment variable is set to a valid JRE location.

Start Cognos Configuration on UNIX or Linux operating systemsUse IBM Cognos Configuration to configure your Cognos TM1 components and tostart and stop services.

Before you begin

You must have set the JAVA_HOME environment variable before you can start IBMCognos Configuration.

Procedure

Go to the install_location/bin64 directory and then type./cogconfig.sh

Starting a Cognos TM1 Server on UNIXYou can use IBM Cognos Configuration to start and stop your Cognos TM1 serverson UNIX. You can also use the start and stop scripts that are provided with theinstallation.

About this task

On UNIX, you can also use the following commands and scripts to start and stopCognos TM1 server components. See "Starting a UNIX TM1 Server" and "Stoppinga UNIX TM1 Server" in the IBM Cognos TM1 Operation Guide for more details.v startup_tm1admsrv.sh - start Cognos TM1 Admin Serverv shutdown_tm1admsrv.sh- shutdown Cognos TM1 Admin Serverv startup_tm1s.sh- start Cognos TM1 Serverv shutdown_tm1s.sh- shutdown Cognos TM1 Serverv tm1srvstop.exe - utility for stopping a Cognos TM1 Server

Procedure1. Start IBM Cognos Configuration.2. In the Explorer window, click Local Configuration > Environment.3. Right-click Cognos TM1 Admin Server, and click Start.4. Under Data Access > Cognos TM1 Server, right-click a server, and click Start.

Running Cognos TM1 on IBM AIXThis section contains technical considerations about running Cognos TM1 on theIBM AIX® operating system.

Setting IBM AIX memory resource limits for Cognos TM1If you are running IBM Cognos TM1 on IBM AIX, check the AIX memory resourcelimits to see how much memory is available for Cognos TM1.

Cognos TM1 is configured to make use of the maximum amount of memoryavailable to the IBM AIX operating system as allowed by the AIX hard limitmemory resource setting. To check the current hard limit on AIX, use the AIXulimit command as follows:

Chapter 7. Cognos TM1 Server installation 67

Page 80: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

ulimit -d -H

If you have root user authority, you can use this command to change the hardlimit. For more information about using the ulimit command, see the AIXdocumentation.

Using IBM AIX commands that do not support file names forCognos TM1 Control ObjectsSome commands in the IBM AIX operating system, such as sysck, do not workwith IBM Cognos TM1 control object file names because these file names start withthe } character.

For example, Cognos TM1 control objects typically have file names like}Clients.dim, }Groups.dim or }ClientsGroups.cub.

This issue applies for all standard IBM AIX commands that read file names fromstdin, including AIX commands and tools that backup data. These AIX commandsfail and produce an error when the command is used with these Cognos TM1 files.

Cognos TM1 Object Names and Character Encoding forCognos TM1 Servers on UNIX and Windows Systems

The following guidelines are related to ensuring correct and consistent characterencoding in your Cognos TM1 object names for objects such as cubes, views,dimensions, and subsets.

Moving Cognos TM1 Databases Between Windows and UNIXSystemsDo not move and use Cognos TM1 database files from a Microsoft Windowssystem to a UNIX system (or from UNIX to Windows) when your Cognos TM1object names contain non-ASCII characters (characters beyond the original 128ASCII character set).

This scenario is an issue because of the possible incompatible character encodingor mapping between these two platforms. The Windows operating system storesdirectory and file names in UTF-16 character encoding, while the UNIX operatingsystem can store names using different character encodings, depending on whichlocale is currently being used.

For example, Cognos TM1 object names for cubes and dimensions that includenon-ASCII characters would not display correctly in Cognos TM1 clientapplications if the Cognos TM1 database files were copied from one platform andrun on another where different character encoding is used.

Use the same locale as the UNIX system when starting a CognosTM1 Server with non-ASCII characters in the nameIf your Cognos TM1 object names (for cubes, views, dimensions, subsets, etc.)include non-ASCII characters, use the same locale when starting up a Cognos TM1server on a UNIX system.

This ensures that Cognos TM1 object names and the related Cognos TM1 directoryand file names on the UNIX system always use the same character encoding.Starting the Cognos TM1 server under a different locale than previously usedcould cause Cognos TM1 object names to display incorrectly if the names wereoriginally created and stored in a different locale.

68 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 81: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

For example, Cognos TM1 object names for cubes and dimensions that are savedwhen the server is running under the en_US locale might not display correctly ifthe server is re-started using the ja_JP locale.

Creating a new empty Cognos TM1 server in Cognos ConfigurationYou can use IBM Cognos Configuration to create a new empty Cognos TM1 server.

About this task

These steps create the tms.cfg configuration file and other required files for a newempty Cognos TM1 Server. Perform these steps only on an empty directory thatdoes not contain any other files.

Tip: If you want to add an existing TM1 Server to Cognos Configuration, see“Adding an existing Cognos TM1 server in Cognos Configuration” on page 70.

Procedure1. Use your operating system to create an empty folder for the new Cognos TM1

Server files.2. Open IBM Cognos Configuration.3. In the Explorer panel, under Data Access, right click TM1 Server, and click

New Resource > TM1 Server Instances.4. In the Name box, enter a name for your server.5. In the Type box, select TM1 Server instance and click OK.

The new server is added under the TM1 Server node and the properties for itare displayed in the TM1 Server instances - Resource Properties list.

6. In the Resource Properties list, click the box to the right of the TM1 Serverconfiguration path and click the edit icon.

7. Enter or browse to the path for the empty folder where you want to create thenew Cognos TM1 server.

Tip: Do not include the file name in this path. You only need to select thefolder.

8. Click Select.9. Click File > Save.

A new tms.cfg file is automatically created in the folder. Values for thefollowing configuration parameters are automatically added to the file.v The ServerName parameter is set to the server name that you specified.v The DataBaseDirectory parameter is set to the data directory that you

specified.v The PortNumber parameter is set to a random auto-generated port number.

10. If you are using this database with Cognos TM1 Applications, edit the tms.cfgfile with the required parameter values. For details, see “Configuring aCognos TM1 Server to work with Cognos TM1 Applications” on page 91.

11. In the Cognos Configuration Explorer panel, right-click the new server andclick Start.The basic files for the new Cognos TM1 server are created in the folder.

12. To test the new Cognos TM1 server, start Cognos TM1 Architect and log in tothe database with user name admin and no password.

Chapter 7. Cognos TM1 Server installation 69

Page 82: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Adding an existing Cognos TM1 server in Cognos ConfigurationYou can manage an existing Cognos TM1 server by adding it to IBM CognosConfiguration.

Before you begin

This procedure requires that you have an existing Cognos TM1 data directory witha valid tm1s.cfg file.

Procedure1. Open IBM Cognos Configuration.2. In the Explorer panel, under Data Access, right click TM1 Server, and click

New Resource > TM1 Server Instances.3. In the Name box, enter the same name that is set for the ServerName

parameter in the tm1s.cfg file.4. In the Type box, select TM1 Server instance and click OK.

The new server is added under the TM1 Server node and the properties for itare displayed in the TM1 Server instances - Resource Properties list.

5. In the Resource Properties list, click the box to the right of the TM1 Serverconfiguration path and click the edit icon.

6. Enter or browse to the path for the existing Cognos TM1 data directory.

Tip: Do not include the file name in this path. You only need to select thefolder.

7. Click Select.8. Click File > Save.9. In the Cognos Configuration Explorer panel, right-click the new server and

click Start.10. To test this Cognos TM1 server, start Cognos TM1 Architect and log in to the

database.

Specifying the location of the Cognos TM1 Admin HostYou specify the location of the IBM Cognos TM1 Admin Host differently for clients(user interfaces) and remote servers.

About this task

The Admin Host is the computer where the Cognos TM1 Admin Server is running.

Procedure1. To specify the Admin Host referenced by clients such as Cognos TM1 Architect

or Cognos TM1 Perspectives:v Change the Tm1p.ini file by using the Cognos TM1 Options menu in Server

Explorer.v You can also manually edit the AdminHost parameter in the Tm1p.ini client

configuration file.For more information, see Appendix C, “The Tm1p.ini Client ConfigurationFile,” on page 259.

2. To specify the Admin Host with which remote servers register, use one of thefollowing methods:

70 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 83: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Edit the AdminHost parameter in the Tm1s.cfg file.v Use the -v command-line parameter when you bring up the Windows

version of the Cognos TM1 server .For information, see Appendix B, “The Tm1s.cfg Server Configuration File,” onpage 219.

Specifying multiple Cognos TM1 Admin HostsYou can configure an IBM Cognos TM1 client to reference multiple Admin Hostsby separating host names with semicolons.

About this task

A client that specifies multiple Admin Hosts can access any Cognos TM1 serversthat are registered with the Cognos TM1 Admin Servers on the specified hosts.

Procedure

To specify multiple Admin Hosts referenced by clients such as Cognos TM1Architect or Cognos TM1 Perspectives, separate the host names with semicolons:v Change the Tm1p.ini file by using the Cognos TM1 Options menu in Server

Explorer.v You can also manually edit the AdminHost parameter in the Tm1p.ini client

configuration file.

For more information, see Appendix C, “The Tm1p.ini Client Configuration File,”on page 259.

Chapter 7. Cognos TM1 Server installation 71

Page 84: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

72 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 85: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 8. Cognos TM1 Web installation

You can install IBM Cognos TM1 Web on a computer that is separate from thecomputer where you installed the Cognos TM1 server and other Cognos TM1components.

Cognos TM1 Web must be installed on a web server running Microsoft InternetInformation Services (IIS).

After you have installed the Cognos TM1 Web server on the separate computer,edit the web.config file to identify the remote computer where the Cognos TM1Admin Server is running.

For details about Cognos TM1 Web architecture and deployment, see:v “Cognos TM1 Web architecture” on page 26v “Deploying Cognos TM1 Web” on page 35

Checklist for installing Cognos TM1 Web

The following items are required.1. Verify prerequisite software for Cognos TM1 Web has been installed on the web

server.2. Enable the IIS 6 Management Compatibility option to run Cognos TM1 Web

with IIS 7 on Windows Vista, Windows 7, and Windows Server 2008 by .3. Install Cognos TM1 Web.4. Use Cognos Configuration to start the Cognos TM1 Excel service.5. Configure the Cognos TM1 Excel Service to run as a specific user in Windows

Services.6. Edit Cognos TM1 Web's web.config file to support a multiple computer

environment.7. Configure the web server and client computers so that users can export Cognos

TM1 data to PDF format from Cognos TM1 Web.8. Run and test Cognos TM1 Web from your network environment.Related concepts:“Upgrading Cognos TM1 Web” on page 48If you have IBM Cognos TM1 Web on a computer that is separate from thecomputer where you installed the Cognos TM1 server then do these steps toupgrade the web server.

Install prerequisite software for Cognos TM1 WebYou need some prerequisite software on the web server before you install IBMCognos TM1 Web.

Before you begin

See Cognos TM1 10.1.0 Software Environments (www.ibm.com/support/docview.wss?uid=swg27021976) for the latest information about prerequisitesoftware.

© Copyright IBM Corp. 2007, 2012 73

Page 86: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Install or confirm that you have:

v Microsoft Internet Information Services (IIS) web server software.If you have this software already installed, the IBM Cognos TM1 installationconfigures IBM Cognos TM1 Web to run with your existing IIS installation.This software is used by Cognos TM1 Perspectives or Cognos TM1 Architect.

2. Install or confirm that you have:v Microsoft .NET Framework 3.5 Service Pack 1v Microsoft Chart Controls for Microsoft .NET Framework 3.5This software is used by Cognos TM1 Web and Cognos TM1 ApplicationServer.

Configure IIS 7 to run Cognos TM1 Web on Windows Vista, Windows7, and Windows Server 2008

Before you install Cognos TM1 Web on Windows Vista, Windows 7, or WindowsServer 2008, enable the Internet Information Services (IIS) 6 ManagementCompatibility option in the operating system.

About this task

If the IIS 6 Management Compatibility option is not enabled, the required virtualdirectories for Cognos TM1 Web will not be created during the install process.

For details on enabling this option, search the Microsoft web site for “IIS 6Management Compatibility”.

Procedure

Enable IIS 6 Management Compatibility:v On Windows Vista and Windows 7, use the Turn Windows features on/off tool

(available from Windows Control Panel, Programs) to enable the InternetInformation Services, Web Management Tools options and sub-options, includingthe IIS 6 Management Compatibility option.

v On Windows Server 2008, use the Windows Server Manager tool to enable theIIS 6 Management Compatibility option and sub-options for the Web Server (IIS)role service.

Install and configure Cognos TM1 WebThese describe the install steps for IBM Cognos TM1 Web.

About this task

When IBM Cognos TM1 Web is installed on a separate computer, edit theweb.config file to identify the separate computer to the web server software.

Procedure1. Run the installation program that matches the type of computer being used

for Cognos TM1 Web:v 32-bit for Windowsv 64-bit for Windows

74 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 87: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

2. On Microsoft Windows Vista, Windows 7 or Windows Server 2008 operatingsystem software, right-click the issetup.exe command and click Run asAdministrator. For other operating systems, double-click the issetup.exe file.

3. Select only the Web Application Tier > TM1 Web component. Deselect all theother components.

4. Follow the prompts in the installation wizard to complete the installation.5. Start IBM Cognos Configuration.

Attention: If you installed the product from the Program Files (x86)directory on a computer running Windows Vista, Windows 7, or WindowsServer 2008 operating system software, start IBM Cognos Configuration as anAdministrator.

6. Right-click TM1 Excel service and click Start.This registers the Cognos TM1 Excel Service to run as a Windows service.

7. Configure the Cognos TM1 Excel Service to run as a specific user in WindowsServices.a. In Cognos Configuration, right-click TM1 Excel service and select Stop.b. Open Windows Services and locate the entry for IBM Cognos TM1 Excel

Service.c. Right-click IBM Cognos TM1 Excel Service and select Properties.d. Enter a user and password for an existing Windows user with the

appropriate rights.e. Close Windows Services.f. In Cognos Configuration, start the TM1 Excel service.

For more details, see “User accounts for running Cognos TM1 services onWindows” on page 17 and “Changing Cognos TM1 services to run as aspecific user account on Windows” on page 141

8. Use a text editor to update the AdminHostName and TM1ServerName parametersin the Cognos TM1 Web web.config file.These parameters enable Cognos TM1 Web to locate the Cognos TM1 AdminServer and Cognos TM1 servers in your network.You can find the web.config file in:<Cognos TM1_installation_location>/TM1Web.See “Configuring the Login Page using AdminHostName andTM1ServerName” on page 76 for details on these parameters.

9. To enable users to export Cognos TM1 data to PDF format from Cognos TM1Web, ensure that the client computers are correctly configured. For details, see“Configuring client computers to export Cognos TM1 data in PDF format” onpage 60.

10. Confirm that Cognos TM1 Web is running by entering the URL for CognosTM1 Web in a web browser. For example:http://localhost/tm1web

On a remote computer, replace localhost with the name or IP address of thecomputer where Cognos TM1 Web is running.

11. See the following topic for details on configuring additional advanced optionsfor Cognos TM1 Web:

Chapter 8. Cognos TM1 Web installation 75

Page 88: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Configuring the Login Page using AdminHostName andTM1ServerName

The AdminHostName and TM1ServerName parameters control whether or not theIBM Cognos TM1 Web login page prompts the user to enter values for the TM1Admin Host and TM1 server.

If you set a value for either of these parameters in the Web.config file, then thelogin process uses the specified value and does not prompt the user for thisinformation.

AdminHostName Parameter

This parameter specifies the name of the Admin Host on which a TM1 AdminServer is running. Edit the AdminHostName parameter in the Web.config fileusing the following format:<add key="AdminHostName" value="HostName"/>

where HostName can be one of the following values:v If HostName is blank (default value), then the login page displays the Admin

Host prompt.v If HostName is set to the name of a valid TM1 Admin Host, then IBM Cognos

TM1 Web uses that Admin Host for the login process and does not prompt theuser.

TM1ServerName Parameter

This parameter sets the name of the TM1 server. Edit the TM1ServerNameparameter in the Web.config file using the following format:<add key="TM1ServerName" value="ServerName"/>

where ServerName can be one of the following values:v If ServerName is blank (default value), then the TM1 server prompt is displayed

on the IBM Cognos TM1 Web login page, as shown below.v If ServerName is set to a valid TM1 server name, then the login page does not

display a prompt for either the Admin Host or the TM1 server.v If the AdminSvrSSLCertID parameter is incorrectly configured, the server name

pull-down displays as empty and an error is logged in the TM1Web.config file.See "Running TM1 in Secure Mode using SSL" in the IBM Cognos TM1 OperationGuide for more information.

After the user enters a valid User Name and Password, IBM Cognos TM1 Web willlogin to the TM1 server specified by the TM1ServerName parameter in theWeb.config file.

For example, the TM1ServerName parameter could be set to planning sample, asshown in the following code.<add key="TM1ServerName" value="planning sample" />

76 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 89: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 9. Cognos TM1 Applications installation

You can install the web application server components for IBM Cognos TM1Applications on a separate, dedicated computer so that users in a networkenvironment can access the program. These components include the Cognos TM1Applications Server and the Cognos TM1 Application Gateway.

The Cognos TM1 Applications Server requires deployment on a Java-based webapplication server. When installing Cognos TM1 Applications, first determinewhich of the following web application servers you want to use:v the provided Apache Tomcat web application serverv your own installation of Apache Tomcatv your own installation of IBM Websphere Application Server

For details about Cognos TM1 Applications architecture and deployment, see:v “Cognos TM1 Applications architecture” on page 29v “Deploying Cognos TM1 Applications” on page 35

Deploying with the provided version of Tomcat

The fastest and easiest way to install and deploy Cognos TM1 Application Serveris to use the version of Apache Tomcat that is provided and installed with the IBMCognos TM1 installation program. This way uses Cognos Configuration to startand stop the Cognos TM1 Application Server.

For details, see “Installing Cognos TM1 Applications with the provided ApacheTomcat” on page 78.

Deploying to your own web application server

To deploy Cognos TM1 Applications Server with your own instance of aJava-based web application server, use IBM Cognos Configuration to first createthe pmpsvc.war web application archive file, and then manually deploy the file.

For details, see the following topics:v “Install Cognos TM1 Applications with your own installation of Apache Tomcat

web application server” on page 81v “Install Cognos TM1 Applications with your own installation of IBM

Websphere” on page 85

Cognos TM1 Applications with x64 Windows

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

© Copyright IBM Corp. 2007, 2012 77

Page 90: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Microsoft IIS and Cognos TM1 Web

In additional to requiring a Java-based web application server, Cognos TM1Applications also requires Microsoft Internet Information Services (IIS) to supportthe Cognos TM1 Applications Web client. For more details, see “ConfiguringCognos TM1 Applications with Microsoft IIS” on page 157

Installing Cognos TM1 Applications with the provided Apache TomcatYou can install Cognos TM1 Applications on a separate computer and deploy itwith the instance of Apache Tomcat that is provided with the installation.

This installation is intended for an environment where the Cognos TM1 AdminServer and Cognos TM1 Server are running on another computer.

Installing Cognos TM1 ApplicationsThis topic provides the steps to install the required files for IBM Cognos TM1Applications on a separate computer.

About this task

Use one of the following installation programs to install Cognos TM1 Applications:v IBM Cognos TM1 32-bit for Windowsv IBM Cognos TM1 64-bit for Windows

Remember: If you plan to use the Cognos TM1 Web client with Cognos TM1Applications, you need an installation of Cognos TM1 Web on either the samecomputer or different computer in your network. To install Cognos TM1 Web on adifferent computer, see Chapter 8, “Cognos TM1 Web installation,” on page 73

Procedure1. If you are installing Cognos TM1 Web on the same computer, install the

prerequisite software.For details, see “Install prerequisite software for Cognos TM1 Web” on page 73.

2. On Microsoft Windows Vista, Windows 7 or Windows Server 2008 operatingsystem software, right-click the issetup.exe command and click Run asAdministrator. For other operating systems, double-click the issetup.exe file.

3. In the installation program select only the following components:v TM1 Application Gateway

v TM1 Application Server

v TM1 Web - This component is optional. Select this to install Cognos TM1Web on the same computer as Cognos TM1 Applications.

4. Follow the prompts to complete the installation.

Deploying the Cognos TM1 Application Server with theprovided Tomcat web application server

The IBM Cognos TM1 Application Server runs in the Apache Tomcat webapplication server that is provided with the installation. Use Cognos Configurationto deploy and start Apache Tomcat before using Cognos TM1 Applications.

Procedure1. Click Start > All Programs > IBM Cognos TM1 > IBM Cognos Configuration.

78 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 91: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

If you installed the product from the Program Files (x86) directory on acomputer running Windows Vista, Windows 7, or Windows 2008 operatingsystem software, start IBM Cognos Configuration as an Administrator.

2. In the Cognos Configuration Explorer panel, expand the Local Configuration >Environment node, right-click TM1 Application Server and select Start.This will start the provided version of Tomcat and then deploy and start theCognos TM1 Application server.

3. Click File > Save and close IBM Cognos Configuration.

Configuring authentication security for Cognos TM1Applications

For the IBM Cognos TM1 servers used with Cognos TM1 Applications, use eitherTM1 standard security authentication or IBM Cognos security.

About this task

Configure the authentication login mode using the IntegratedSecurityModeparameter in the Tm1s.cfg file of each Cognos TM1 server that you want to use.

Cognos TM1 Applications is compatible only with the following TM1 securityauthentication modes:v Authentication mode 1 - TM1 standard security authenticationv Authentication mode 5 - IBM Cognos security

Important: Do not use a combination of different security authentication modes forthe same installation of Cognos TM1 Applications.

For best practice, determine the security mode before you configure Cognos TM1Applications to use a Cognos TM1 server and use that same security mode withany additional servers you add.

For more details about security authentication and the IntegratedSecurityModeparameter, see:v “Authentication security” on page 163v “IntegratedSecurityMode” on page 234

Procedure1. Open the file TM1 server data directory/Tm1s.cfg

2. Set the IntegratedSecurityMode parameter for the Cognos TM1 Server.v To use Cognos TM1 standard security authentication, set

IntegratedSecurityMode=1

v To use IBM Cognos security, set IntegratedSecurityMode=5For details about using IBM Cognos security, see:v “Using Cognos TM1 Applications with Cognos Business Intelligence

Security” on page 153v “Using Cognos security with Cognos TM1 ” on page 186

3. Save and close the Tm1s.cfg file.4. Restart the Cognos TM1 Server.5. Repeat these steps for any other Cognos TM1 Server you want to use with

Cognos TM1 Applications.

Chapter 9. Cognos TM1 Applications installation 79

Page 92: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Configuring the server and client environment for CognosTM1 Applications

Before you use IBM Cognos TM1 Applications, you need to specify the CognosTM1 Admin Host, Cognos TM1 Server, and client user interfaces that you want touse. The first time that you start Cognos TM1 Applications, the program promptsyou to configure these options.

Before you begin

Ensure that the Cognos TM1 Admin Server and at least one Cognos TM1 Server isrunning on the local computer or a remote computer that you can access.

Ensure that each Cognos TM1 Server that you want to use is configured with therequired parameter values. For details, see “Configuring a Cognos TM1 Server towork with Cognos TM1 Applications” on page 91.

If you plan to use the Cognos TM1 Web client, ensure that Microsoft InternetInformation Services web server is configured to host Cognos TM1 Web content.

Procedure1. Start and log in to Cognos TM1 Applications:

a. In a web browser, type the URL for Cognos TM1 Applications:http://localhost:9510/pmpsvc

b. Replace localhost with the name of the computer where the Cognos TM1Application Server is installed.

2. Open the Cognos TM1 Application Configuration page:v If this is the first time that Cognos TM1 Applications has been started since

the installation, the Cognos TM1 Application Configuration web page opens.v If Cognos TM1 Applications has already been configured, you are prompted

for a user name and password and then can open the configuration page by

clicking the Administer IBM Cognos TM1 Applications icon on thetoolbar of the Cognos TM1 Applications main page.

3. In the Admin Host field, enter the name or IP address of the computer wherethe Cognos TM1 Admin Server is running.

Note: The Admin Host and Server Name fields appear blank if you have notstarted the Cognos TM1 Admin Server and at least one Cognos TM1 server.

4. In the Server Name field, enter the name of the Cognos TM1 Server that youwant to use with Cognos TM1 Application.For example, the sample Cognos TM1 server is named GO_new_stores.Click the Refresh button to refresh the list of available servers.

5. Select the data contribution clients that you want to use with Cognos TM1Applications.These clients will be available when you create applications with IBM CognosTM1 Performance Modeler.v Include Cognos Insight - Connected - IBM Cognos Insight client using real

time processing with the Cognos TM1 server.v Include Cognos Insight - Distributed - IBM Cognos Insight client with local

processing of data. Data is updated to the Cognos TM1 server only when acommit data action is performed.

80 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 93: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Include TM1 Application Web - Default client. Processing is in real timewith the server. This option uses the data grid and charting clientinfrastructure from Cognos TM1 Web and requires that you enter a value forthe TM1 Application Web URL option.

6. If you selected the Include TM1 Application Web option, enter a value for theTM1 Application Web URL option.This URL points to the contributor.aspx file on the Microsoft InternetInformation Services (IIS) web server that is hosting Cognos TM1 Web.For example: http://WebServer/TM1Web/contributor.aspxwhere WebServer is the name of the computer where Cognos TM1 Web isinstalled.

7. Click OK.8. If prompted, enter the username and password for the server and click Login.

Tip: Use admin and apple for the user name and password if you are using oneof the installed sample databases.The Cognos TM1 Applications main page displays. This page appears blankuntil you build and deploy applications inside of Cognos TM1 Applications.For more details, see the IBM Cognos Performance Modeler and IBM CognosInsight documentation.

Results

The following message indicates that the Cognos TM1 server that you are using isnot properly configured for use with Cognos TM1 Applications:

The new server can be added but it may not be configured with all theoptions required by IBM Cognos TM1 Applications.

For information on how to configure this server, see “Configuring a Cognos TM1Server to work with Cognos TM1 Applications” on page 91.

Install Cognos TM1 Applications with your own installation of ApacheTomcat web application server

This section describes how to install Cognos TM1 Applications on a separatecomputer and deploy it with your own installation of Apache Tomcat.

This installation is intended for an environment where the TM1 Admin Server andTM1 Server are running on another computer.

Installing Cognos TM1 ApplicationsThis topic provides the steps to install the required files for IBM Cognos TM1Applications on a separate computer.

About this task

Use one of the following installation programs to install Cognos TM1 Applications:v IBM Cognos TM1 32-bit for Windowsv IBM Cognos TM1 64-bit for Windows

Remember: If you plan to use the Cognos TM1 Web client with Cognos TM1Applications, you need an installation of Cognos TM1 Web on either the same

Chapter 9. Cognos TM1 Applications installation 81

Page 94: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

computer or different computer in your network. To install Cognos TM1 Web on adifferent computer, see Chapter 8, “Cognos TM1 Web installation,” on page 73

Procedure1. If you are installing Cognos TM1 Web on the same computer, install the

prerequisite software.For details, see “Install prerequisite software for Cognos TM1 Web” on page 73.

2. On Microsoft Windows Vista, Windows 7 or Windows Server 2008 operatingsystem software, right-click the issetup.exe command and click Run asAdministrator. For other operating systems, double-click the issetup.exe file.

3. In the installation program select only the following components:v TM1 Application Gateway

v TM1 Application Server

v TM1 Web - This component is optional. Select this to install Cognos TM1Web on the same computer as Cognos TM1 Applications.

4. Follow the prompts to complete the installation.

Use IBM Cognos Configuration to build an application file fora Tomcat server

You use IBM Cognos Configuration to build the application file to deploy to yourApache Tomcat server.

About this task

You can create a Web archive (WAR) file or an Enterprise archive (EAR) file. Forinformation about WAR and EAR files and which is supported by your applicationserver, see the documentation for your application server.

Procedure1. Click Start > All Programs > IBM Cognos TM1 > IBM Cognos Configuration.2. Click Action > Build Application File.3. Check the application server type Apache Tomcat. Click Next.4. Select the file type: WAR file. The default location is <your installation

location>\ibm\cognos\TM1\pmpsvc.war. Click Next.5. Wait for the Build Application Wizard to complete the processes. Click Finish.

What to do next

You can deploy the application file to your application server. For informationabout deploying applications, see your application server documentation.

Configuring authentication security for Cognos TM1Applications

For the IBM Cognos TM1 servers used with Cognos TM1 Applications, use eitherTM1 standard security authentication or IBM Cognos security.

About this task

Configure the authentication login mode using the IntegratedSecurityModeparameter in the Tm1s.cfg file of each Cognos TM1 server that you want to use.

82 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 95: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos TM1 Applications is compatible only with the following TM1 securityauthentication modes:v Authentication mode 1 - TM1 standard security authenticationv Authentication mode 5 - IBM Cognos security

Important: Do not use a combination of different security authentication modes forthe same installation of Cognos TM1 Applications.

For best practice, determine the security mode before you configure Cognos TM1Applications to use a Cognos TM1 server and use that same security mode withany additional servers you add.

For more details about security authentication and the IntegratedSecurityModeparameter, see:v “Authentication security” on page 163v “IntegratedSecurityMode” on page 234

Procedure1. Open the file TM1 server data directory/Tm1s.cfg

2. Set the IntegratedSecurityMode parameter for the Cognos TM1 Server.v To use Cognos TM1 standard security authentication, set

IntegratedSecurityMode=1

v To use IBM Cognos security, set IntegratedSecurityMode=5For details about using IBM Cognos security, see:v “Using Cognos TM1 Applications with Cognos Business Intelligence

Security” on page 153v “Using Cognos security with Cognos TM1 ” on page 186

3. Save and close the Tm1s.cfg file.4. Restart the Cognos TM1 Server.5. Repeat these steps for any other Cognos TM1 Server you want to use with

Cognos TM1 Applications.

Configuring the server and client environment for CognosTM1 Applications

Before you use IBM Cognos TM1 Applications, you need to specify the CognosTM1 Admin Host, Cognos TM1 Server, and client user interfaces that you want touse. The first time that you start Cognos TM1 Applications, the program promptsyou to configure these options.

Before you begin

Ensure that the Cognos TM1 Admin Server and at least one Cognos TM1 Server isrunning on the local computer or a remote computer that you can access.

Ensure that each Cognos TM1 Server that you want to use is configured with therequired parameter values. For details, see “Configuring a Cognos TM1 Server towork with Cognos TM1 Applications” on page 91.

If you plan to use the Cognos TM1 Web client, ensure that Microsoft InternetInformation Services web server is configured to host Cognos TM1 Web content.

Chapter 9. Cognos TM1 Applications installation 83

Page 96: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Start and log in to Cognos TM1 Applications:

a. In a web browser, type the URL for Cognos TM1 Applications:http://localhost:9510/pmpsvc

b. Replace localhost with the name of the computer where the Cognos TM1Application Server is installed.

2. Open the Cognos TM1 Application Configuration page:v If this is the first time that Cognos TM1 Applications has been started since

the installation, the Cognos TM1 Application Configuration web page opens.v If Cognos TM1 Applications has already been configured, you are prompted

for a user name and password and then can open the configuration page by

clicking the Administer IBM Cognos TM1 Applications icon on thetoolbar of the Cognos TM1 Applications main page.

3. In the Admin Host field, enter the name or IP address of the computer wherethe Cognos TM1 Admin Server is running.

Note: The Admin Host and Server Name fields appear blank if you have notstarted the Cognos TM1 Admin Server and at least one Cognos TM1 server.

4. In the Server Name field, enter the name of the Cognos TM1 Server that youwant to use with Cognos TM1 Application.For example, the sample Cognos TM1 server is named GO_new_stores.Click the Refresh button to refresh the list of available servers.

5. Select the data contribution clients that you want to use with Cognos TM1Applications.These clients will be available when you create applications with IBM CognosTM1 Performance Modeler.v Include Cognos Insight - Connected - IBM Cognos Insight client using real

time processing with the Cognos TM1 server.v Include Cognos Insight - Distributed - IBM Cognos Insight client with local

processing of data. Data is updated to the Cognos TM1 server only when acommit data action is performed.

v Include TM1 Application Web - Default client. Processing is in real timewith the server. This option uses the data grid and charting clientinfrastructure from Cognos TM1 Web and requires that you enter a value forthe TM1 Application Web URL option.

6. If you selected the Include TM1 Application Web option, enter a value for theTM1 Application Web URL option.This URL points to the contributor.aspx file on the Microsoft InternetInformation Services (IIS) web server that is hosting Cognos TM1 Web.For example: http://WebServer/TM1Web/contributor.aspxwhere WebServer is the name of the computer where Cognos TM1 Web isinstalled.

7. Click OK.8. If prompted, enter the username and password for the server and click Login.

Tip: Use admin and apple for the user name and password if you are using oneof the installed sample databases.

84 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 97: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The Cognos TM1 Applications main page displays. This page appears blankuntil you build and deploy applications inside of Cognos TM1 Applications.For more details, see the IBM Cognos Performance Modeler and IBM CognosInsight documentation.

Results

The following message indicates that the Cognos TM1 server that you are using isnot properly configured for use with Cognos TM1 Applications:

The new server can be added but it may not be configured with all theoptions required by IBM Cognos TM1 Applications.

For information on how to configure this server, see “Configuring a Cognos TM1Server to work with Cognos TM1 Applications” on page 91.

Install Cognos TM1 Applications with your own installation of IBMWebsphere

This section describes how to install Cognos TM1 Applications on a separatecomputer and deploy it with your own installation of IBM Websphere.

This installation is intended for an environment where the TM1 Admin Server andTM1 Server are running on another computer.

Installing Cognos TM1 ApplicationsThis topic provides the steps to install the required files for IBM Cognos TM1Applications on a separate computer.

About this task

Use one of the following installation programs to install Cognos TM1 Applications:v IBM Cognos TM1 32-bit for Windowsv IBM Cognos TM1 64-bit for Windows

Remember: If you plan to use the Cognos TM1 Web client with Cognos TM1Applications, you need an installation of Cognos TM1 Web on either the samecomputer or different computer in your network. To install Cognos TM1 Web on adifferent computer, see Chapter 8, “Cognos TM1 Web installation,” on page 73

Procedure1. If you are installing Cognos TM1 Web on the same computer, install the

prerequisite software.For details, see “Install prerequisite software for Cognos TM1 Web” on page 73.

2. On Microsoft Windows Vista, Windows 7 or Windows Server 2008 operatingsystem software, right-click the issetup.exe command and click Run asAdministrator. For other operating systems, double-click the issetup.exe file.

3. In the installation program select only the following components:v TM1 Application Gateway

v TM1 Application Server

v TM1 Web - This component is optional. Select this to install Cognos TM1Web on the same computer as Cognos TM1 Applications.

Chapter 9. Cognos TM1 Applications installation 85

Page 98: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

4. Follow the prompts to complete the installation.

Using IBM Cognos Configuration to build an application filefor a IBM Websphere

You use IBM Cognos Configuration to build the application file to deploy to yourIBM Websphere server.

About this task

You can create a Web archive (WAR) file or an Enterprise archive (EAR) file. Forinformation about WAR and EAR files and which is supported by your applicationserver, see the documentation for your application server.

Procedure1. Click Start > All Programs > IBM Cognos TM1 > IBM Cognos Configuration.2. Click Action > Build Application File.3. Check the Application server type IBM Websphere. Click Next.4. Select the file type: WAR file. The default location is <your installation

location>\ibm\cognos\TM1\pmpsvc.war. Click Next.5. Wait for the Build Application Wizard to complete the processes. Click Finish.

What to do next

You can deploy the application file to your application server. For informationabout deploying applications, see your application server documentation.

Deploy Cognos TM1 Application Server with WebSphereApplication Server

Use the IBM WebSphere Administrative Console to deploy and run Cognos TM1Applications with the WebSphere Application Server.

Procedure1. Start the WebSphere Application Server.

In Microsoft Windows, click Start > Programs > IBM WebSphere >Application Server > Start the server.A command window opens and displays the startup progress. After thestartup process has completed, the command window will display themessage, Server started. You can minimize this command window, but do notclose it. This window must remain open while WebSphere is running.

2. Open the WebSphere Administrative Console.In Windows, click Start, Programs, IBM WebSphere, Application Server,Administrative console.Enter your WebSphere user name and password, or use the WebSpheredefault user name, system, and password, manager.After a successful login, the WebSphere Administrative Console page opens.

3. In the Console Navigation pane, locate the Applications section and clickDeploy New.The Install New Applications page opens.

4. Click the Browse button next to the Archive text box to locate and select theCognos TM1 Applications file, pmpsvc.war, that you generated using the BuildApplication File command in Cognos Configuration.

86 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 99: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

5. Click Open after selecting the pmpsvc.war file.6. Keep the other deployment options set to their default values as follows:

v The Plan field should be blank.v The Start app after install check box should be selected.v The Redeploy application check box should not be selected.

7. Click Install.WebSphere installs the Cognos TM1 Application Web application. This processmay take a few minutes to complete. When complete, the following messagesare displayed:The application was successfully deployed.

The application was successfully started.

8. To confirm the installation, click Web App WARs in the Applications sectionof the Console Navigation pane.The Installed Web Applications page opens.Cognos TM1 Applications is listed with a link in the URL column as /pmpsvc.This link provides the full URL to launch the application. For example:https://localhost:8443/pmpsvc

9. To open Cognos TM1 Applications, click the /pmpsvc link.10. To manage the Cognos TM1 Application Web application, use the WebSphere

links for Stop, Restart and Uninstall.

Troubleshooting Deployment with IBM WebSphereIf the TM1 Applications deployment fails with a Java heap space error message, tryadjusting the JAVA_OPTS parameter in the WebSphere setenv.bat file.

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

Procedure1. Open the WebSphere setenv.bat file.

The typical location for this file is:C:\Program Files\IBM\WebSphere\AppServer\bin

2. Add or edit the following line as follows:set JAVA_OPTS=-Xmx512M

3. Restart WebSphere.In Windows, click Start > Programs > IBM WebSphere > Application Serverand then start or stop the server.

Configuring authentication security for Cognos TM1Applications

For the IBM Cognos TM1 servers used with Cognos TM1 Applications, use eitherTM1 standard security authentication or IBM Cognos security.

About this task

Configure the authentication login mode using the IntegratedSecurityModeparameter in the Tm1s.cfg file of each Cognos TM1 server that you want to use.

Cognos TM1 Applications is compatible only with the following TM1 securityauthentication modes:

Chapter 9. Cognos TM1 Applications installation 87

Page 100: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Authentication mode 1 - TM1 standard security authenticationv Authentication mode 5 - IBM Cognos security

Important: Do not use a combination of different security authentication modes forthe same installation of Cognos TM1 Applications.

For best practice, determine the security mode before you configure Cognos TM1Applications to use a Cognos TM1 server and use that same security mode withany additional servers you add.

For more details about security authentication and the IntegratedSecurityModeparameter, see:v “Authentication security” on page 163v “IntegratedSecurityMode” on page 234

Procedure1. Open the file TM1 server data directory/Tm1s.cfg

2. Set the IntegratedSecurityMode parameter for the Cognos TM1 Server.v To use Cognos TM1 standard security authentication, set

IntegratedSecurityMode=1

v To use IBM Cognos security, set IntegratedSecurityMode=5For details about using IBM Cognos security, see:v “Using Cognos TM1 Applications with Cognos Business Intelligence

Security” on page 153v “Using Cognos security with Cognos TM1 ” on page 186

3. Save and close the Tm1s.cfg file.4. Restart the Cognos TM1 Server.5. Repeat these steps for any other Cognos TM1 Server you want to use with

Cognos TM1 Applications.

Configuring the server and client environment for CognosTM1 Applications

Before you use IBM Cognos TM1 Applications, you need to specify the CognosTM1 Admin Host, Cognos TM1 Server, and client user interfaces that you want touse. The first time that you start Cognos TM1 Applications, the program promptsyou to configure these options.

Before you begin

Ensure that the Cognos TM1 Admin Server and at least one Cognos TM1 Server isrunning on the local computer or a remote computer that you can access.

Ensure that each Cognos TM1 Server that you want to use is configured with therequired parameter values. For details, see “Configuring a Cognos TM1 Server towork with Cognos TM1 Applications” on page 91.

If you plan to use the Cognos TM1 Web client, ensure that Microsoft InternetInformation Services web server is configured to host Cognos TM1 Web content.

88 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 101: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Start and log in to Cognos TM1 Applications:

a. In a web browser, type the URL for Cognos TM1 Applications:http://localhost:9510/pmpsvc

b. Replace localhost with the name of the computer where the Cognos TM1Application Server is installed.

2. Open the Cognos TM1 Application Configuration page:v If this is the first time that Cognos TM1 Applications has been started since

the installation, the Cognos TM1 Application Configuration web page opens.v If Cognos TM1 Applications has already been configured, you are prompted

for a user name and password and then can open the configuration page by

clicking the Administer IBM Cognos TM1 Applications icon on thetoolbar of the Cognos TM1 Applications main page.

3. In the Admin Host field, enter the name or IP address of the computer wherethe Cognos TM1 Admin Server is running.

Note: The Admin Host and Server Name fields appear blank if you have notstarted the Cognos TM1 Admin Server and at least one Cognos TM1 server.

4. In the Server Name field, enter the name of the Cognos TM1 Server that youwant to use with Cognos TM1 Application.For example, the sample Cognos TM1 server is named GO_new_stores.Click the Refresh button to refresh the list of available servers.

5. Select the data contribution clients that you want to use with Cognos TM1Applications.These clients will be available when you create applications with IBM CognosTM1 Performance Modeler.v Include Cognos Insight - Connected - IBM Cognos Insight client using real

time processing with the Cognos TM1 server.v Include Cognos Insight - Distributed - IBM Cognos Insight client with local

processing of data. Data is updated to the Cognos TM1 server only when acommit data action is performed.

v Include TM1 Application Web - Default client. Processing is in real timewith the server. This option uses the data grid and charting clientinfrastructure from Cognos TM1 Web and requires that you enter a value forthe TM1 Application Web URL option.

6. If you selected the Include TM1 Application Web option, enter a value for theTM1 Application Web URL option.This URL points to the contributor.aspx file on the Microsoft InternetInformation Services (IIS) web server that is hosting Cognos TM1 Web.For example: http://WebServer/TM1Web/contributor.aspxwhere WebServer is the name of the computer where Cognos TM1 Web isinstalled.

7. Click OK.8. If prompted, enter the username and password for the server and click Login.

Tip: Use admin and apple for the user name and password if you are using oneof the installed sample databases.

Chapter 9. Cognos TM1 Applications installation 89

Page 102: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The Cognos TM1 Applications main page displays. This page appears blankuntil you build and deploy applications inside of Cognos TM1 Applications.For more details, see the IBM Cognos Performance Modeler and IBM CognosInsight documentation.

Results

The following message indicates that the Cognos TM1 server that you are using isnot properly configured for use with Cognos TM1 Applications:

The new server can be added but it may not be configured with all theoptions required by IBM Cognos TM1 Applications.

For information on how to configure this server, see “Configuring a Cognos TM1Server to work with Cognos TM1 Applications” on page 91.

Determining the URL startup link for Cognos TM1 ApplicationsThe exact link to start and log on to Cognos TM1 Applications depends on whichweb server you are running and how it is configured.

Link Parameters

Use the following format for the URL to log in to Cognos TM1 Applications.

https://WebServer:PortNumber/pmpsvc

Table 15. Cognos TM1 Applications - URL parameters

Parameter Description

WebServer Can be one of the following:

The keyword localhost if you are currently logged on to the Webserver that is running Cognos TM1 Applications.

The machine name or domain name of the Web server hosting theCognos TM1 Application Web application.

The IP address of the Web server hosting the Cognos TM1Application Web application.

PortNumber The port number you configured with web application server.

IBM WebSphere - Click the Web Server link in the WebSphereAdministrative Console to view and edit port settings.

Apache Tomcat - Open the Apache Tomcat server.xml file in thefollowing location to view and edit the port settings:

C:\Program Files\Apache Software Foundation\Tomcat6.0\conf\server.xml.

90 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 103: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Link Examples

Table 16. Cognos TM1 Applications - link examples

Web ApplicationServer Header

Apache Tomcatprovided with theinstallation

The default link when using the provided version of Tomcat is:

http://localhost:9510/pmpsvc

Apache Tomcat The usual link for Cognos TM1 Applications with Apache Tomcatis:

http://localhost:8085/pmpsvc

IBM WebSphereApplication Server

The usual link for Cognos TM1 Applications running on IBMWebSphere Application Server is:

https://localhost:8443/pmpsvc

Configuring a Cognos TM1 Server to work with Cognos TM1Applications

Before using the IBM Cognos TM1 Server with IBM Cognos TM1 Applications, editthe server's configuration file to include the required parameters and values.

About this task

The following configuration parameters in the Cognos TM1 Server Tm1s.cfg filesupport different subcomponents of Cognos TM1 Applications.v AllowSeparateNandCRules parameter - supports Cognos TM1 Performance

Modeler with Cognos TM1 Applications.See “AllowSeparateNandCRules” on page 221.

v DistributedPlanningOutputDir parameter - supports Cognos Insight -Distributed client with Cognos TM1 Applications.See “DistributedPlanningOutputDir” on page 231.

Procedure1. Open the Cognos TM1 Server configuration file, Tm1s.cfg.2. To support Cognos TM1 Performance Modeler, edit or add the following line:

AllowSeparateNandCRules=T

3. To support the Cognos Insight – Distributed client, edit or add the followingline:DistributedPlanningOutputDir=.\tunit

4. Save the Tm1s.cfg.5. Restart the Cognos TM1 Server.6. Repeat these steps for any other Cognos TM1 Server you want to use with

Cognos TM1 Applications.

Chapter 9. Cognos TM1 Applications installation 91

Page 104: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

92 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 105: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 10. Cognos TM1 client installation

You can install IBM Cognos TM1 client components using the Cognos TM1 serverinstallation program or the Cognos TM1 client installation program.

You can install the following client components:v Cognos TM1 Perspectivesv Cognos TM1 Architectv Cognos TM1 Performance Modelerv Cognos InsightRelated concepts:“Upgrading Cognos TM1 Architect and Perspectives clients” on page 47You can upgrade IBM Cognos TM1 client components using the Cognos TM1server installation program or the Cognos TM1 client installation program.

Installing Cognos TM1 PerspectivesYou can install IBM Cognos TM1 Perspectives by performing the following steps.

Before you begin

Before you install IBM Cognos TM1 Performance Modeler, complete the followingtasks:1. Install the software that is necessary for you to run Cognos TM1 Perspectives.

For more information, see “Install the prerequisite software” on page 53.2. Ensure that the Cognos TM1 Admin Server and the Cognos TM1 Server that

you want to connect to are running on an accessible computer in your network.For details, see Chapter 7, “Cognos TM1 Server installation,” on page 63.

3. Ensure that users have access to the Cognos TM1 servers that they need to userunning under that Cognos TM1 Admin Server. As a Cognos TM1administrator, you must set up a user name and password for each user beforea user can access that server.

About this task

The following steps install Cognos TM1 Perspectives on a single computer,configure it to locate a Cognos TM1 Administration Server on your network, andthen connect to a server. You can also create an unattended installation.

Attention: If you are upgrading and leave your old Tm1p.ini client configurationfiles in place, you might need to update the directory path in the file for theAdminSvrSSLCertAuthority parameter. For example, if you are using the defaultCognos TM1 SSL certificate, manually change the value for this parameter to thenew install path C:\Program Files\IBM\cognos\tm1\bin\ssl\applixca.pem.

Procedure1. Install Cognos TM1 Perspectives:

a. On Microsoft Windows Vista, Windows 7 or Windows Server 2008operating system software, right-click the issetup.exe command and clickRun as Administrator. For other operating systems, double-click the

© Copyright IBM Corp. 2007, 2012 93

Page 106: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

issetup.exe file on the IBM Cognos TM1 client installation disk or from thelocation where the Cognos TM1 client installation files were downloadedand extracted.

b. On the Component Selection page, expand TM1 Client Tier, expandDeveloper Tier, and select the Perspectives check box.Leave all the other check boxes unselected.

c. Follow the prompts and click Finish to complete the installation.2. Run Cognos TM1 Perspectives:

a. Click Start > IBM Cognos TM1 > Perspectives for MS Excel. If thecomponent does not start, ensure that the servers you started with CognosConfiguration are still running.

b. Click Enable Macros when the security warning displays.3. Configure Cognos TM1 Perspectives to locate a Cognos TM1 Admin Server:

a. In Microsoft Excel, click TM1 > Options. The TM1 Options dialog boxopens.

b. In the Admin Host field, specify the name of the computer on which theCognos TM1 Admin Server is running. If you want to access serversregistered on different Admin Servers, use a semicolon to separate the nameof each Admin Host. You must enter a name, not an IP address, in theAdmin Host field.

c. Click OK.d. When prompted about disconnecting from currently accessed servers, click

Yes if you want to access a new list of servers. Servers available throughAdmin Server on the specified Admin Host appear. If you want to continueto see the current list of remote servers during this session, click No.

4. Double-click a Cognos TM1 Server to log in.For either Planning Sample or SData, use these login credentials:v User name: admin

v Password: apple

Tip: To load Cognos TM1 Perspectives automatically whenever you startMicrosoft Excel, add TM1_location/Tm1p.xla to Microsoft Excel's add-in toollist, where TM1_location is the file directory where Cognos TM1 is installed.After completing this step, "TM1" displays on the Microsoft Excel menu bar.

5. If you want to install Cognos TM1 Perspectives on multiple computers, use theprevious steps to create an unattended installation that can. For details, seeAppendix D, “Setting up unattended installations and configurations,” on page269.

Installing Cognos TM1 ArchitectYou can install IBM Cognos TM1 Architect by performing the following steps.

Before you begin

Before you install Cognos TM1 Architect, complete the following tasks:v Install the software that is necessary for you to run Cognos TM1 Architect. For

more information, see “Install the prerequisite software” on page 53.v Ensure that the Cognos TM1 Admin Server and the Cognos TM1 Server that you

want to connect to are running on an accessible computer in your network. Fordetails, see Chapter 7, “Cognos TM1 Server installation,” on page 63.

94 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 107: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Ensure that users have access to the Cognos TM1 servers that they need to userunning under that Cognos TM1 Admin Server. As a Cognos TM1 administrator,you must set up a user name and password for each user before a user canaccess that server.

About this task

You can configure IBM Cognos TM1 Architect to locate a Cognos TM1Administration Server on your network, and then connect to a server. You can alsocreate an unattended installation.

Attention: If you are upgrading and leave your old Tm1p.ini client configurationfiles in place, you might need to update the directory path in the file for theAdminSvrSSLCertAuthority parameter. For example, if you are using the defaultCognos TM1 SSL certificate, manually change the value for this parameter to thenew install path C:\Program Files\IBM\cognos\tm1\bin\ssl\applixca.pem.

Procedure1. Install Cognos TM1 Architect:

a. On Microsoft Windows Vista, Windows 7, or Windows Server 2008operating system software, right-click the issetup.exe command and clickRun as Administrator. For other operating systems, double-click theissetup.exe file on the IBM Cognos TM1 client installation disk or from thelocation where the IBM Cognos TM1 client installation files weredownloaded and extracted.

b. On the Component Selection page, expand TM1 Client Tier, expandDeveloper Tier, and select the Architect check box. Leave all the othercheck boxes unselected.

c. Follow the prompts and click Finish to complete the installation.2. Run Cognos TM1 Architect:

a. Click Start > IBM Cognos TM1 > Architect. If the component does notstart, ensure that the servers you started with Cognos Configuration are stillrunning.

3. Configure Cognos TM1 Architect to locate a Cognos TM1 Admin Server:a. Open Server Explorer.b. Select TM1.c. Click File > TM1 Options.d. In the Admin Host field, specify the name of the computer on which the

TM1 Admin Server is running. You must enter a name, not an IP address, inthe Admin Host field.

Tip: If you want to access servers registered on different Admin Servers,use a semicolon to separate the name of each Admin Host.

e. Click OK.f. When prompted about disconnecting from currently accessed servers, click

Yes if you want to access a new list of servers. Servers available throughAdmin Server on the specified Admin Host appear. If you want to continueto see the current list of remote servers during this session, click No.

4. Double-click a Cognos TM1 Server to log in.For either Planning Sample or SData, use these login credentials:v User name: admin

v Password: apple

Chapter 10. Cognos TM1 client installation 95

Page 108: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

5. If you want to install Cognos TM1 Architect on multiple computers, use theprevious steps to create an unattended installation. For details, see Appendix D,“Setting up unattended installations and configurations,” on page 269.

Installing Cognos TM1 Performance ModelerYou can choose different ways to distribute and install IBM Cognos TM1Performance Modeler across multiple computers.

The following table summarizes the different ways to distribute and install CognosTM1 Performance Modeler across multiple computers.

Table 17. Multiple computer installation options for Cognos TM1 Performance Modeler

Installation option Description

“Installing Cognos TM1Performance Modeler using theinstallation program”

Administrators or end users can install Cognos TM1Performance Modeler on a single computer using theIBM Cognos TM1 Client-only installation program.

Optionally, use these steps to create an unattendedinstallation to install Cognos TM1 Performance Modeleron multiple computers.

“Installing Cognos TM1Performance Modeler from theCognos Applications Portal” onpage 97

As a prerequisite, an administrator must install CognosTM1 Applications.

This allows Cognos TM1 users to install Cognos TM1Performance Modeler onto their computers the first timethat they launch it from the IBM Cognos ApplicationsPortal. This is called a provisioned installation.

For more information about publishing workspaces, seethe IBM Cognos TM1 Performance Modeler User Guide.

“Remotely installing CognosTM1 Performance Modeler onmultiple computers” on page 97

An administrator can use third-party network installationtools to push Cognos TM1 Performance Modeler out tomultiple remote client systems.

Installing Cognos TM1 Performance Modeler using theinstallation program

You can interactively install a stand-alone version of IBM Cognos TM1Performance Modeler on one or more computers.

Procedure1. Double-click the issetup.exe file on the IBM Cognos TM1 client installation disk

or from the location where the IBM Cognos TM1 client installation files weredownloaded and extracted.

2. On the Component Selection page, expand TM1 Client Tier, expandDeveloper Tier, and select the Performance Modeler check box. Leave all theother check boxes unselected.

3. Follow the prompts and click Finish to complete the installation.4. To test the installation, open Cognos TM1 Performance Modeler from Start >

Programs > IBM Cognos TM1 Performance Modeler.5. If you want to install the program on multiple computers, use the previous

steps to create an unattended installation that can. For details, see Appendix D,“Setting up unattended installations and configurations,” on page 269.

96 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 109: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Installing Cognos TM1 Performance Modeler from the CognosApplications Portal

You can install IBM Cognos TM1 Performance Modeler the first time you run thecomponent from the IBM Cognos Applications portal.

Before you begin

Before you install Cognos TM1 Performance Modeler from the CognosApplications portal, the administrator must install Cognos TM1 Applications.

Procedure1. In a web browser, type the Cognos Applications portal URI:

For example, http://localhost:9510/pmpsvca. Replace localhost with the name of the computer where the Cognos

Applications Portal is installed.b. If required, change the port number if you used a different value in IBM

Cognos Configuration for the TM1 Application Gateway URI property.

2. From the Cognos Applications portal, click the Open Performance Modelericon.If this is the first time you have used Cognos TM1 Performance Modeler, theInstall Now icon displays to indicate that you are about to install the CognosTM1 Performance Modeler client to your computer.

3. Click Install Now.4. Click Finish to complete the installation.

What to do next

For information on using IBM Cognos TM1 Performance Modeler, see the IBMCognos TM1 Performance Modeler User Guide.

Remotely installing Cognos TM1 Performance Modeler onmultiple computers

As an administrator, you can push the IBM Cognos TM1 Performance Modelerinstallation to users automatically. First, you make the Cognos TM1 PerformanceModeler installer file available in a shared folder on your network. You can thenuse an application such as Microsoft Active Directory to automatically install theclient application to authenticated users.

About this task

Cognos TM1 Performance Modeler is installed using an installer file that you putin a shared location. You can use Active Directory to install Cognos TM1Performance Modeler directly to users' computers.

Use the PerformanceModeler.msi file to install Cognos TM1 Performance Modeler.This file is installed to the following location when you install the Cognos TM1Application Gateway component:

tm1 location\webapps\pmpsvc\rcp_installs

Chapter 10. Cognos TM1 client installation 97

Page 110: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

You can use the PerformanceModeler.msi file with Windows Installer commandline options and also use Active Directory or other software management tools topush the install out to remote computers.

Command line options

The PerformanceModeler.msi file is a standard Microsoft Windows Installer file.You can use the PerformanceModeler.msi file with Windows Installer commandline options and also use Active Directory or other software management tools topush the install out to remote computers.

The following table lists some of the property values that administrators can use toinstall the PerformanceModeler.msi file. For complete details, see the Microsoftdeveloper web site for documentation about the "Windows Installer Guide" and"Windows Installer Property Reference".

Table 18. Property values for Cognos TM1 Performance Modeler

Property Value Description

ALLUSERS=1Installs the MSI for all users.

This property value ensures that the registryentries for Cognos TM1 Performance Modelerare located in HKEY_LOCAL_MACHINE.Note: You must use this property with theTARGETDIR property.

ALLUSERS=""

(default value)

Installs the MSI only for the user who isrunning the installation. Only that user willhave access to the application

TARGETDIR="Performance Modeler_install location" Specifies the install location for the MSI.

For example, TARGETDIR="C:\Program Files"

98 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 111: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 18. Property values for Cognos TM1 Performance Modeler (continued)

Property Value Description

TARGETDIR=

(default value)

When used with ALLUSERS=""

On Windows XP, the install location is

C:\Documents and Settings\username\Application Data\IBM\Cognos TM1 PerformanceModeler

On Windows 7, the install location is

C:\Users\username\AppData\Roaming\IBM\Cognos TM1 Performance Modeler

When used with ALLUSERS=1

On Windows XP, the install location is

C:\Documents and Settings\AllUsers\Application Data\IBM\Cognos TM1Performance Modeler

On Windows 7, the install location is

C:\Program Data\IBM\Cognos TM1 PerformanceModeler

NOUPDATE=YesPrevents Cognos TM1 Performance Modelerusers from receiving automatic updates.

This value is recommended when end users donot have write access to the application installlocation. Auto-updating requires that CognosTM1 Performance Modeler users can write tothe location specified, or defaulted to, by theTARGETDIR property.

NOUPDATE=No

(default value)

Allows Cognos TM1 Performance Modelerusers to receive automatic updates.

An example is shown in the following steps.

Procedure1. Open a command prompt, and navigate to the location of the

PerformanceModeler.msi file.2. To install Cognos TM1 Performance Modeler for all users, type the following

commandPerformanceModeler.msi TARGETDIR="install_location" ALLUSERS=1

Installing Cognos InsightYou can choose different ways to distribute and install IBM Cognos Insight acrossmultiple computers.

Chapter 10. Cognos TM1 client installation 99

Page 112: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Depending on your computer network environment and business needs, you caninstall the application, allow users to install as needed, or remotely push theapplication out.

The following table summarizes the different ways to distribute and install IBMCognos Insight across multiple computers.

Table 19. Multiple computer installation options for Cognos Insight

Installation option Description

“Installing Cognos Insight usingthe installation program”

Administrators or end users can install CognosInsight on a single computer using the IBM CognosTM1 Client-only installation program.

Optionally, use these steps to create an unattendedinstallation to install Cognos Insight on multiplecomputers.

“Installing Cognos Insight from theCognos Applications Portal” onpage 101

As a prerequisite, an administrator must installCognos TM1 Applications.

This allows Cognos TM1 users to install CognosInsight onto their computers the first time that theylaunch it from the IBM Cognos Applications Portal.This is called a provisioned installation.

A provisioned installation allows a Cognos Insightuser to publish workspaces to the IBM CognosApplications Portal. For more information aboutpublishing workspaces, see the IBM Cognos InsightUser Guide.

“Remotely installing CognosInsight on multiple computers” onpage 101

An administrator can use third-party networkinstallation tools to push Cognos Insight out tomultiple remote client systems.

Installing Cognos Insight using the installation programYou can interactively install a stand-alone version of IBM Cognos Insight on one ormore computers.

Procedure1. On Microsoft Windows Vista, Windows 7, or Windows Server 2008 operating

system software, right-click the issetup.exe command and click Run asAdministrator. For other operating systems, double-click the issetup.exe fileon the IBM Cognos TM1 client installation disk or from the location where theIBM Cognos TM1 client installation files were downloaded and extracted.

2. On the Component Selection page, expand TM1 Client Tier and select theCognos Insight check box. Leave all the other check boxes unselected.

3. Follow the prompts and click Finish to complete the installation.4. To test the installation, open Cognos Insight from Start > Programs > IBM

Cognos Insight > IBM Cognos Insight.5. To install the program on multiple computers, use the previous steps to create

an unattended installation. For details, see Appendix D, “Setting up unattendedinstallations and configurations,” on page 269.

100 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 113: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Installing Cognos Insight from the Cognos Applications PortalYou can install IBM Cognos Insight the first time you run the component from theIBM Cognos Applications portal.

Before you begin

Before you install Cognos Insight from Cognos Connection, the administrator mustinstall Cognos TM1 Applications.

Procedure1. In a web browser, type the Cognos Applications portal URI:

For example, http://localhost:9510/pmpsvca. Replace localhost with the name of the computer where the Cognos

Applications Portal is installed.b. If required, change the port number if you used a different value in IBM

Cognos Configuration for the TM1 Application Gateway URI property.2. From the Cognos Applications portal, click the Open Cognos Insight icon.

If this is the first time you have used Cognos Insight, the Install Now icondisplays to indicate that you are about to install the Cognos Insight client toyour computer.

3. Click Install Now.4. Click Finish to complete the installation.

What to do next

Cognos Insight is now installed in a folder on your computer. You will be able torun and use Cognos Insight in the following ways:v You can launch Cognos Insight using the Open Cognos Insight button in

Cognos TM1 Applications.v You can launch the Cognos Insight client by right-clicking a node of an

application that has been configured to use Cognos Insight.Cognos Insight is available as a client from an application only if you configuredthe client environment for Cognos TM1 Applications to use the Cognos InsightDistributed or Connected client.

v You can launch Cognos Insight as a stand-alone product from the WindowsStart > Programs > IBM Cognos Insight menu.

Remotely installing Cognos Insight on multiple computersAs an administrator, you can push the IBM Cognos Insight installation to usersautomatically. First, you make the Cognos Insight installer file available in a sharedfolder on your network. You can then use an application such as Microsoft ActiveDirectory to automatically install the client application to authenticated users.

About this task

Cognos Insight is installed using an installer file that you put in a shared location.You can use Active Directory to install Cognos Insight directly to users' computers.

Use the CognosInsight.msi file to install Cognos Insight. This file is installed to thefollowing location when you install the IBM Cognos TM1 Application Gatewaycomponent:

Chapter 10. Cognos TM1 client installation 101

Page 114: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

tm1 location\webapps\pmpsvc\rcp_installs

You can use the CognosInsight.msi file with Windows Installer command lineoptions and also use Active Directory or other software management tools to pushthe install out to remote computers.

Command line options

The CognosInsight.msi file is a standard Microsoft Windows Installer file. You canuse the CognosInsight.msi file with Windows Installer command line options andalso use Active Directory or other software management tools to push the installout to remote computers.

The following table lists some property values that administrators can use to installthe CognosInsight.msi file. For complete details, see the Microsoft developer website for documentation about the "Windows Installer Guide" and "WindowsInstaller Property Reference".

Table 20. Property values for Cognos Insight

Property Value Description

ALLUSERS=1Installs the MSI for all users.

This property value ensures that theregistry entries for Cognos Insight arelocated in HKEY_LOCAL_MACHINE.Note: You must use this property withthe TARGETDIR property.

ALLUSERS=""

(default value)

Installs the MSI only for the user who isrunning the installation. Only that userwill have access to the application

TARGETDIR="CognosInsight_install location"Specifies the install location for the MSI.

For example, TARGETDIR="C:\ProgramFiles"

102 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 115: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 20. Property values for Cognos Insight (continued)

Property Value Description

TARGETDIR=

(default value)

When used with ALLUSERS=""

On Windows XP, the install location is

C:\Documents and Settings\username\Application Data\IBM\Cognos Insight

On Windows 7, the install location is

C:\Users\username\AppData\Roaming\IBM\Cognos Insight

When used with ALLUSERS=1

On Windows XP, the install location is

C:\Documents and Settings\AllUsers\Application Data\IBM\CognosInsight

On Windows 7, the install location is

C:\Program Data\IBM\Cognos Insight

NOUPDATE=YesPrevents Cognos Insight users fromreceiving automatic updates.

This value is recommended when endusers do not have write access to theapplication install location. Auto-updatingrequires that Cognos Insight users canwrite to the location specified, ordefaulted to, by the TARGETDIRproperty.

NOUPDATE=No

(default value)

Allows Cognos Insight users to receiveautomatic updates.

An example is shown in the following steps.

Procedure1. Open a command prompt, and navigate to the location of the

CognosInsight.msi file.2. To install Cognos Insight for all users, type the following command

CognosInsight.msi TARGETDIR="install_location" ALLUSERS=1

Chapter 10. Cognos TM1 client installation 103

Page 116: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

104 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 117: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 11. Cognos TM1 sample databases installation

IBM Cognos TM1 samples illustrate product features and technical and businessbest practices. You can also use them for learning the product, testing, andtroubleshooting.

Cognos TM1 samples overview

Cognos TM1 samples are available for a variety of uses and are optimized fordifferent clients. Some of the samples are ready to use right after installation whileothers require extra steps to use them. By default Cognos TM1 samples areinstalled in two different locations. If selected in the installation wizard, theproduct samples are installed as follows:

SData, Planning Sample, and GO_New_Stores

These samples are installed by default in the tm1_location\samples\tm1location.

SData and Planning Sample were specifically designed to be used withCognos TM1.

To use them, start each sample database in Cognos Configuration afterinstallation.

GO_New_Stores is designed to highlight Cognos TM1 Applications and canalso be used with Cognos Insight and Cognos TM1 Performance Modeler.

See“Using the SData sample” on page 106, “Using the Planning Sampledatabase” on page 106, and “Using the GO_New_Stores sample” on page106 for details.

PData, Rules_Guide_Data, TI_Data

These samples are also designed specifically for Cognos TM1, however touse them you must first add each server in Cognos Configuration and thenstart them individually. They are installed into the tm1_location\samples\tm1 location.

GO_Contributor.zip, FinanceFact.zip, greatoutdoors.zip, andGreatOutdoorsSales.zip

These samples are installed to the tm1_location\webcontent\samples\datasources\cubes\amdtool directory.

The GreatOutdoorsSales.zip samples require you to restore a database andconnect to the database using an OLAP data source. The database files areinstalled with the samples, and are provided for IBM DB2®, Microsoft SQLServer, and Oracle databases.

The other samples are based on .csv files for their content and do notrequire a database to be restored.

Human Resource and Order samples in .csv format are installed for useby Cognos Insight.

See “Set up the Great Outdoors Company sample” on page 108, “Using theTM1 server samples based on the sample database” on page 109, and“Setting up Great Outdoors Sales sample” on page 115 for details.

© Copyright IBM Corp. 2007, 2012 105

Page 118: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Balance sheet.cdd, HumanResources.cdd, Income-Debt Analysis.cdd, andOrders.cdd.

A set of .cdd samples have been specifically designed for use with CognosInsight workspace builder. These samples are available through the IBMCognos Insight Information Center (http://publib.boulder.ibm.com/infocenter/cinsight/v10r1m0).

On UNIX, use the ./startup_tm1s.sh command to start sample database servers.See "Starting a UNIX TM1 Server" and "Stopping a UNIX TM1 Server" in the IBMCognos TM1 Operation Guide for more details.

Using the SData sampleThe Sdata sample includes data optimized for use with Cognos TM1.

About this task

SData is selected as a default component and is installed by default into thesample database location.

For example C:/Program Files/IBM/cognos/tm1/samples/tm1/SData

Procedure1. Run Cognos TM1 Architect.2. In Cognos Configuration right click and start the SData database.3. Double-click TM1 to open the sample database.4. Log into the sample database using the default username of admin and

password of apple.

Using the Planning Sample databaseThe Planning Sample or PlanSamp sample includes data optimized for use withCognos TM1.

About this task

Planning Sample is selected as a default component and is installed by default intothe sample database location.

For example C:/Program Files/IBM/cognos/tm1/samples/tm1/PlanSamp

Procedure1. Run Cognos TM1 Architect.2. In Cognos Configuration right click and start the Planning Sample database.3. Double-click TM1 to open the sample database.4. Log into the sample database using the default username of admin and

password of apple.

Using the GO_New_Stores sampleThe GO_New_Stores sample includes data optimized for IBM Cognos TM1Applications, Cognos Insight, and Cognos TM1 Performance Modeler.

106 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 119: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Before you begin

Before starting GO_New_Stores verify that you do not have any earlier versions ofthat service in your Microsoft Windows services listing. Use sc deleteGO_New_Stores in a command window to remove any earlier instances.

These instructions assume Cognos TM1 and at least one sample database otherthan GO_New_Stores is already running. See Chapter 6, “Cognos TM1single-computer installation,” on page 53 for details on installing Cognos TM1.

Procedure1. In Cognos Configuration, select Local Configuration, click the <click to edit

button> and then click Add.a. Type StandaloneCertificateAuthority in the Name box.b. Type True in the Value box.c. Click OK.

2. In Cognos Configuration, right-click GO_New_Stores and click Start. ClickClose on the confirmation message after the server has started.

3. Test the sample database in IBM Cognos TM1 Architect:a. Run Cognos TM1 Architect.b. Expand the TM1 node and double-click GO_New_Stores to open the

sample database.c. Log into the sample database using the default username of admin and

password of apple.4. Test the sample database in Cognos TM1 Applications and Cognos TM1

Performance Modeler:

Tip: Ensure that both your web server and IBM Cognos TM1 Applications arerunning.a. Open a web browser and enter http://localhost:9510/pmpsvc or the web

server URL that you use to open Cognos TM1 Applications.b. In the Cognos TM1 Application Configuration page, accept the defaults by

clicking OK.

Tip: By default all clients are selected here for use with the GO_New_Storessample. You can limit the clients available by unselecting them here.

c. Log into the sample database using the default username of admin andpassword of apple.

d. To work with the GO_New_Stores sample in Cognos TM1 PerformanceModeler, click the Open IBM Cognos TM1 Performance Modeler icon. Ifyou are prompted to install Cognos TM1 Performance Modeler, follow theinstructions in the install wizard to install it now.

Set up the GO Contributor sampleThe GO Contributor sample uses .csv files. To use the sample you must modifythe tm1s.cfg file and then add the server using IBM Cognos Configuration.

Procedure1. On the computer where you installed the TM1 server component, go to the

tm1_location\webcontent\samples\datasources\cubes\amdtool folder.2. Extract the contents of the GO_Contributor.zip file.

Chapter 11. Cognos TM1 sample databases installation 107

Page 120: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

3. In the folder where you extracted the Go_Contributor.zip file, go to the DataFiles folder, and open the tm1s.cfg file in a text editor.a. Ensure that the DatabaseDirectory location, the LoggingDirectory location,

and the DistributedPlanningOutputDir use the correct path for the DataFiles folder location where you extracted the Go_Contributor.zip file.

b. Save and close the file.4. Open IBM Cognos Configuration.5. In the Explorer panel, under Data Access, right click TM1 Server, and click

New Resource > TM1 Server Instances.a. In the Name box, enter GO Contributor.b. For the TM1 Server configuration path value, enter the path to the Data

Files folder where you extracted the Go_Contributor.zip file.For example, tm1_location\webcontent\samples\datasources\cubes\amdtool\GO_Contributor\Data Files

c. In the Explorer panel, right-click GO Contributor and click Start.6. Test that the new GO Contributor server is available to Architect.

a. Open Architect.b. Double click the GO Contributor server.c. In the Server Login box, enter admin in the UserName box and apple in the

Password box.7. Test that the new GO Contributor server is available in the IBM Cognos

Applications portal.a. Open the portal by typing the following: http://server_name:9510/pmpsvc.b. Click the Administer IBM Cognos Application icon on the far right hand

sidec. Under Server Names, click Add.d. Type the server name in Admin Host and then click the Refresh button.e. Select the GO Contributor sample you just added, and click OK.

Set up the Great Outdoors Company sampleThe Great Outdoors Company sample uses .csv files. To use the sample you mustmodify the tm1s.cfg file and then add the server using IBMCognos Configuration.

Procedure1. On the computer where you installed the TM1 server component, go to the

tm1_location\webcontent\samples\datasources\cubes\amdtool folder.2. Extract the contents of the greatoutdoors.zip file.3. In the folder where you extracted the greatoutdoors.zip file, go to the

DataFiles folder, and open the tm1s.cfg file in a text editor.a. Ensure that the DatabaseDirectory location and the LoggingDirectory

location use the correct path for the DataFiles folder location where youextracted the greatoutdoors.zip file.

b. Save and close the file.4. Open IBM Cognos Configuration.5. In the Explorer panel, under Data Access, right click TM1 Server, and click

New Resource > TM1 Server Instances.a. In the Name box, enter GreatOutdoors.

108 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 121: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

b. For the TM1 Server configuration path value, enter the path to theDataFiles folder where you extracted the greatoutdoors.zip file.For example, tm1_location\webcontent\samples\datasources\cubes\amdtool\GreatOutdoors\DataFiles

c. In the Explorer panel, right-click GreatOutdoors and click Start.6. Test that the new GreatOutdoors server is available to Architect.

a. Open Architect.b. Double click the GreatOutdoors server.c. In the Server Login box, enter admin in the UserName box and apple in the

Password box.7. Test that the new GreatOutdoors server is available in the IBM Cognos

Applications portal.a. Open the portal by typing the following: http://server_name:9510/pmpsvc.b. Click the Administer IBM Cognos Application icon on the far right hand

sidec. Under Server Names, click Add.d. Type the server name in Admin Host and then click the Refresh button.e. Select the GreatOutdoors sample you just added, and click OK.

Using the TM1 server samples based on the sample databaseThe Great Outdoors Sales sample uses data from a database. To use this sampleyou must restore the database, create an ODBC connection to the database, andthen add the sample server to your system.

The database is provided for IBM DB2, Microsoft SQL Server, and Oracle.

The sample database and the Cognos TM1 server using the database are installedwith Cognos TM1 server in the tm1_location/webcontent/samples/datasourcesfolder.

When you create your ODBC connection, use GOSALESDW as the data source name.On Microsoft Windows operating systems, create the ODBC connection as aSystem DSN.

Restoring backup files for IBM DB2Use the script that is provided to restore sample databases on IBM DB2.

To set up the sample database, you must extract the GS_DB tar.gz file, customize aconfiguration file, and run the setup script.

Procedure1. Go to the tm1_location/webcontent/samples/datasources folder.2. Extract the GS_DB.tar.gz file and retain the original directory structure.

If you use WinZip to extract the GS_DB.tar.gz file on a Microsoft Windowsoperating system, ensure that the TAR file smart CR/LF conversion option isnot selected.

3. On Linux and UNIX operating systems, modify the file permissions on thesetupGSDB.sh file so that it is executable.For example,chmod u+x setupGSDB.sh

Chapter 11. Cognos TM1 sample databases installation 109

Page 122: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

4. If you want to change the sample configuration file to use settings other thanthe default values, edit the GOSalesConfig file.The configuration file on Windows is GOSalesConfig.bat. The configuration fileon Linux and UNIX is GOSalesConfig.sh.The GOSalesConfig configuration file contains the default configuration optionsthat are used when creating the GOSALES data. The default configurationsettings are listed in the following table

Table 21. Default configuration settings for GOSALES data

Configuration Setting Default Description

GOSALES_INST GS_DB Used to set the name or aliasof the database.

GOSALES_CREATEDB Optional: Causes an existingdatabase with the samename to be dropped.

GOSALES_DB_TERRITORY US When creating a databasethis is the territory of theUTF-8 database that iscreated.

GOSALES_BP

GOSALES_TS

GOSALES_BP

GOSALES_TS

Optional: Enter the bufferpool and tablespace name, ifthese are to be created by thescript.

GOSALES_GRANTEES GOSALES, DB2ADMIN Enter the list of users, groupsor PUBLIC that will haveCONTROL permissions forthe GOSALES, GOSALESHR,GOSALESMR andGOSALESRT schemas. Thisstring needs to follow thesyntax of the GRANTcommand.

GOSALESDW_GRANTEES GOSALESDW

DB2ADMIN

Enter the list of users, groupsor PUBLIC that will haveCONTROL permissions forthe GOSALESDW schema.

GOSALES_DPF N Change to 'Y' if installing adatabase partitionedenvironment (DPF)

GOSALES_SCHEMA

GOSALESHR_SCHEMA

GOSALESMR_SCHEMA

GOSALESRT_SCHEMA

GOSALESDW_SCHEMA

GOSALES

GOSALESHR

GOSALESMR

GOSALESRT

GOSALESDW

Enter the names to be usedfor each schema.

By default, the GS_DB database name is used and permissions are granted tothe DB2ADMIN (Linux, UNIX, Windows) and GOSALES users.

5. To run the setupGSDB script in interactive mode, run following command:v On Windows computers, in an IBM DB2 command window, change to the

GS_DB\win directory and run the setupGSDB.bat script.

110 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 123: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v On UNIX computers, from a shell prompt, source the db2profile, change tothe GS_DB/unix directory, and run the setupGSDB.sh script.

The script displays a summary of your choices before you commit to changesto your environment. If you approve the choices, press Enter.

6. To run the setupGSDB script from the command line, run the followingcommand:v On Windows computers, run the setupGSDB.bat script.v On UNIX computers, run the setupGSDB.sh script.You can run the setupGSDB script with the following options:

Option Description

-createdb Creates the database. This option drops anyexisting database with the same name. Itcreates the required buffer pool and tablespace.

-database database name Specifies the name of the database. Thisvalue overrides the default value of GS_DB.

-userid administration_user_ID Specifies the name of the DB2 administratoruser ID that is used to create the database.

-password administration_user_ID Specifies the password for the DB2administrator user ID.

-noprompt Indicates that no prompt will display. Thisoption runs the script in silent mode. Anymissing information causes the script to fail.You will not be prompted for anyconfirmations.

For example, if you are an IBM DB2 administrator and want to create thedefault GS_DB database on the local node, use the following command:setupGSDB -createDB -noprompt

If you want to create the tables in an existing database named SAMPLE, andyou want to use the administrator user ID db2admin, run the followingcommand:setupGSDB -database SAMPLE -userid db2admin

The script prompts you for the password when it connects to the database. Thescript will replace any tables that already exist in the database, unless youchoose to drop the database.

7. If the GS_DB sample database is installed on a remote server in yourenvironment, you can link to it by cataloguing the remote database on yourlocal computer and then running the setup script locally.a. If the sample database does not yet exist on the remote server, create it by

using CREATE DATABASE command.The database requires a UTF-8 codeset and a default table space with apagesize of 16 KB or larger. For example, on the remote server, create thedatabase by running the following command:CREATEDATABASE GS_DB USING CODESET UTF-8 TERRITORY US PAGESIZE 16k

b. On your local computer, catalog the remote database by using the followingcommand:db2catalog tcpip node nodename remote ipaddr server port_numberdb2 catalog database GS_DB as GS_DB at node nodename

Chapter 11. Cognos TM1 sample databases installation 111

Page 124: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

c. On your local computer, run the following command:setupGSDB -database GS_DB -userid administration_user_ID

You are prompted for a password to connect to the database.

Restoring backup files for OracleUse the scripts that are installed with TM1 to quickly and conveniently restorebackup files for sample databases in Oracle.

About this task

To set up the sample database, you must extract the GS_DB_ORA.tar.gz, file,customize a configuration file, and run the setup script.

Procedure1. Go to the tm1_location/webcontent/samples/datasources.2. Extract the GS_DB_ORA.tar.gz file and retain the original directory structure.3. On Linux and UNIX operating systems, modify the file permissions on the

setupGSDB.sh file so that it is executable:chmod u+x setupGSDB.sh

4. Ensure that the user ID used to set up the Oracle database has authority tocreate users and run the import utility.

5. Optional - If you want to change the sample configuration file to use settingsother than the default values, edit the GOSalesConfig file.The configuration file on Windows is GOSalesConfig.bat. The configuration fileon UNIX is GOSalesConfig.sh.The GOSalesConfig configuration file contains the default configuration optionsthat are used when creating the GOSALES data. The default configurationsettings are listed in the following table

Table 22. Default configuration settings for GOSALES data

Configuration Setting Default Description

GOSALES_IMP_CMD imp If necessary can bemodified to specify thecomplete path to thecorrect version of theimport utility.

GOSALES_INST Oracle host string.

GOSALES_TS GOSALES_TS If users are created byscripts, used to enter thetablespace name to assignto users.

GOSALES_CREATE_TS Optional: Used to createthe default tablespace forusers.

GOSALES_TEMP_TS If users are created byscripts, used to name atemporary tablespace toassign to users. Leaveblank to use the defaulttemporary tablespace.

112 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 125: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 22. Default configuration settings for GOSALES data (continued)

Configuration Setting Default Description

GOSALES_SCHEMA

GOSALES_SCHEMA_PW

GOSALES

GOSALESPW

Used to enter the usernameand password for theGOSALES user. You will beprompted for a password ifnot entered.

GOSALESHR_SCHEMA

GOSALESHR_SCHEMA_PW

GOSALESHR

GOSALESHRPW

Used to enter the usernameand password for theGOSALESHR user. You willbe prompted for apassword if not entered.

GOSALESMR_SCHEMA

GOSALESMR_SCHEMA_PW

GOSALESMR

GOSALESMRPW

Used to enter the usernameand password for theGOSALESMR user. Youwill be prompted for apassword if not entered.

GOSALESSRT_SCHEMA

GOSALESRT_SCHEMA_PW

GOSALESRT

GOSALESRTPW

Used to enter the usernameand password for theGOSALESRT user. You willbe prompted for apassword if not entered.

GOSALESDW_SCHEMA

GOSALESDW_SCHEMA_PW

GOSALESDW

GOSALESDWPW

Used to enter the usernameand password for theGOSALESDW user. Youwill be prompted for apassword if not entered.

GOSALES_GRANTEES GOSALES Used to enter the users thatwill have SELECT, INSERT,DELETE, UPDATE, andALTER permissions forGOSALES, GOSALESHR,GOSALESMR andGOSALESRT schemas.

Note: The owner of theGOSALES_SCHEMA willalways be granted SELECT,INSERT, DELETE, UPDATEand ALTER privilege on allschemas.

GOSALESDW_GRANTEES GOSALESDW Used to enter the users thatwill have SELECT, INSERT,DELETE, UPDATE andALTER permissions forGOSALESDW schema.

6. To run the setupGSDB script in interactive mode, run following command:v On Windows computers, in a DOS command window, change to the

GS_DB_ORA\win directory and run the setupGSDB.bat script.v On UNIX computers, from a shell prompt, change to the GS_DB_ORA/unix

directory, and run the setupGSDB.sh script.Press Enter to proceed. The script displays a summary of your choices beforeyou commit to changes to your environment. If you approve the choices, pressEnter and the script makes the changes

Chapter 11. Cognos TM1 sample databases installation 113

Page 126: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

7. To run the setupGSDB script from the command line, run the followingcommand:v On Windows computers, run the setupGSDB.bat script.v On UNIX computers, run the setupGSDB.sh script.You can run the setupGSDB script with the following options:

Option Description

-createdb Creates the database. This option drops anyexisting database with the same name. Itcreates the required buffer pool and tablespace.

-database database name Specifies the name of the database. Thisvalue overrides the default value of GS_DB.

-userid administration_user_ID Specifies the name of the DB2 administratoruser ID that is used to create the database.

-password administration_user_ID Specifies the password for the DB2administrator user ID.

-noprompt Indicates that no prompt will display. Thisoption runs the script in silent mode. Anymissing information causes the script to fail.You will not be prompted for anyconfirmations.

For example, if you are an Oracle administrator and want to create the defaultsample database schemas, run the following command:setupGSDB -createDB -noprompt

You want to create the tables in the existing schemas specified in theconfiguration file, and you want to use the administrator user ID sys. run thefollowing command:setupGSDB -YourOracleInstance-userid sys -sysdba

The script prompts you for the password when it connects to the Oracleinstance. The script deletes any existing tables or views in the specifiedschemas and replaces them.

Restoring backup files for Microsoft SQL ServerUse the Microsoft SQL Server database management tool to quickly andconveniently restore backup files for sample databases.

Procedure1. On the computer where you installed TM1 server, go to the following directory:

tm1_location/webcontent/samples/datasource/Source files/sqlserver

2. If required, copy the backup files for the samples databases to your databasebackup directory.

3. Restore the database from a device, and ensure that the restore locations arecorrect for the .ldf and .mdf database files.For more information, see the Microsoft SQL Server documentation or the IBMCognos Knowledge Base on the IBM Cognos Customer Center.

4. Create at least one user who has select permissions for all the tables in therestored databases.

114 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 127: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Setting up Great Outdoors Sales sampleThe Great Outdoors Sales sample uses data from the database you restored.

Procedure1. Create an ODBC data source connection to the restored database.

Use GOSALESDW as the data source name. On Windows operating systems, createthe ODBC connection as a System DSN.

2. On the computer where you installed the TM1 server component, go to thetm1_location\webcontent\samples\datasources\cubes\amdtool folder.

3. Extract the contents of the GreatOutdoorsSales.zip file.4. In the folder where you extracted the GreatOutdoorsSales.zip file, go to the

DataFiles folder, and open the tm1s.cfg file in a text editor.a. Ensure that the DatabaseDirectory location and the LoggingDirectory

location use the correct path for the location where you extracted theGreatOutdoorsSales.zip file.

b. Save and close the file.5. Open IBM Cognos Configuration.6. In the Explorer panel, under Data Access, right click TM1 Server, and click

New Resource > TM1 Server Instances.a. In the Name box, enter GreatOutdoorsSales.b. For the TM1 Server configuration path value, enter the path to the

DataFiles folder where you extracted the GreatOutdoorsSales.zip file.For example, tm1_location\webcontent\samples\datasources\cubes\amdtool\GreatOutdoorsSales\DataFiles

c. In the Explorer panel, right-click GreatOutdoorSales and click Start.7. Test that the new GreatOutdoorsSales server is available to Architect.

a. Open Architect.b. Double click the GreatOutdoorsSales server.c. In the Server Login box, enter admin in the UserName box and apple in the

Password box.8. Test that the new GreatOutdoorsSales server is available in the IBM Cognos

Applications portal.a. Open the portal by typing the following: http://server_name:9510/pmpsvc.b. Click the Administer IBM Cognos Application icon on the far right hand

sidec. Under Server Names, click Add.d. Type the server name in Admin Host and then click the Refresh button.e. Select the GreatOutdoorsSales sample you just added, and click OK.

Chapter 11. Cognos TM1 sample databases installation 115

Page 128: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

116 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 129: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 12. Installing the Cognos TM1 Operations Console

The IBM Cognos TM1 Operations Console is a Java-based web application thatenables Cognos TM1 administrators to monitor and take action on Cognos TM1server activity.

Before you begin

The Cognos TM1 Operations Console is deployed on a Java-based web applicationserver such as the version of Apache Tomcat supplied with the Cognos TM1installation. You can instead use your own version of Apache Tomcat. Determinewhich way you want to install.

Before installing the Cognos TM1 Operations Console:v Ensure that the Cognos TM1 prerequisite software is installed.v Ensure that theCognos TM1 Admin Server and the Cognos TM1 server that you

want to monitor are installed and running.v Ensure that you can start Cognos TM1 Architect and can log in as an

administrator to the Cognos TM1 server that you want to monitor.v Ensure that Apache Tomcat is installed and running.

The Cognos TM1 Operation Console is selected by default during installation. Youcan instead choose to install it on a computer separate from the computer used forthe Cognos TM1 server by deselecting it during the standard installation, thenrunning the installation on the separate computer and selecting only the CognosTM1 Operations Console.

Procedure1. On Microsoft Windows Vista, Windows 7 or Windows Server 2008 operating

system software, right-click the issetup.exe command and click Run asAdministrator. For other operating systems, double-click the issetup.exe fileon the IBMCognosTM1 installation disk or from the location where theCognosTM1 installation files were downloaded and extracted.

2. Select and install the Web Application Tier > Cognos TM1 OperationsConsole component.

Remember: Install IBM Cognos TM1 components in a directory that containsonly ASCII characters in the path name. Some Windows web servers do notsupport non-ASCII characters in directory names.

What to do next

Follow the instructions for the webserver software you want to use with theCognos TM1 Operations Console:v “Using the provided Apache Tomcat with the Cognos TM1 Operations Console”

on page 118v “Using your own version of Apache Tomcat” on page 121v “Using Websphere 7.0 and 8.0” on page 125

© Copyright IBM Corp. 2007, 2012 117

Page 130: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Using the provided Apache Tomcat with the Cognos TM1 OperationsConsole

Use the following set of steps to install the IBM Cognos TM1 Operations Console ifyou are using the version of Apache Tomcat provided with Cognos TM1 .

Add certificates to the JRE keystoreThe IBM Cognos TM1 Operations Console requires a certificate in the JavaRuntime Environment (JRE) keystore.

Procedure1. Run the Java keytool command to import the certificate into the keystore.

a. Open a command prompt and change to the following directory:<location> \bin\jre\6.0\bin

where <location> is the file directory where Cognos TM1 is installed.CAUTION:On 64-bit computers, be sure to add the certificates to the bin64 folder.

b. Run the following command line. For formatting purposes the command isshown here with line breaks but you should enter the command all on oneline.keytool -import -file "C:\<location>\bin\ssl\applixca.pem"-keystore "C:\<location>\bin\jre\6.0\lib\security\cacerts"-storepass "changeit"

For 64-bit installations, target the 64-bit folder when dealing with thecertificates. For example, this sample command targets the 64-bit jre:cd C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\jre\6.0\bin

The following command is an example used on 64-bit systems. Forformatting purposes this command is shown with line breaks but youshould enter the command all on one line.keytool -import -file "C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\ssl\applixca.pem" -keystore "C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\jre\6.0\lib\security\cacerts" -storepass "changeit"

If you do not correctly target the 64-bit locations for certificates whenrunning a 64-bit installation, you receive a warning message indicating thatyou cannot contact the servers.

c. Enter yes when prompted to trust or add the certificate.

The following message displays: Certificate was added to keystore

2. You may need to restart Apache Tomcat to have the change take effect.

Remember: Re-add certificates any time you re-install Cognos TM1 .

Deploy Cognos TM1 Operations Console with the providedversion of Apache Tomcat

Use the IBM Cognos Configuration tool to deploy the IBM Cognos TM1Operations Console with the version of Apache Tomcat provided with the CognosTM1 installation. The Cognos TM1 Operations Console uses the same version ofTomcat as the IBM Cognos TM1 Application Server.

118 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 131: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Before you begin

If you installed the product from the Program Files (x86) directory on a computerrunning Microsoft Windows Vista, Windows 7, or Windows 2008 operating systemsoftware, start IBM Cognos Configuration as an Administrator.

Procedure1. Click Start > All Programs > IBM Cognos TM1 > IBM Cognos Configuration.2. Right-click TM1 Applications and click Start.

This step starts the version of Tomcat provided with Cognos TM1 , andautomatically deploys the Cognos TM1 Operations Console.

3. Save the configuration data by clicking File > Save.4. Close Cognos Configuration by clicking File > Exit.

Create a user group for the Cognos TM1 Operations ConsoleThe IBM Cognos TM1 Operations Console requires a designated Cognos TM1 usergroup that you create in Cognos TM1 Architect.

Procedure1. Run Cognos TM1 Architect.

Remember: If the TM1 Admin server and the server you want to monitor havenot been started yet, use Cognos Configuration to start them before runningCognos TM1 Architect.

2. In Cognos TM1 Architect, double-click TM1 to see the servers that are runningand available to you.

3. Double-click the server you want to monitor and log into it with the usernameand password for that server.

4. Right-click the server and select Security > Clients and groups to add a newuser group specifically for the Cognos TM1 Operations Console.

5. Select Groups > Add new group and enter a group name, such as monitor oranother easily-identifiable name for the Cognos TM1 Operations Consolegroup.You may need to scroll the window to see the new group that you have justadded.

6. Click OK.7. Assign a user to the new group:

Only these users will be able to log into the Cognos TM1 Operations Console.v For administrator-type users, assign them to the new group and also to the

built-in SecurityAdmin, and/or the ADMIN group.v If you want the monitoring user to be a standard user, assign that user to the

new group and to the Cognos TM1 DataAdmin group.See the IBM Cognos TM1 Operation Guide for details on assigning securitygroups in Cognos TM1 .

8. Click OK to return to the Server Explorer. You can close Cognos TM1 Architect.

Edit the OpsConfig.xml fileThe IBM Cognos TM1 Operations Console uses an XML file to identify the usergroup, server, and admin host to use. Before you can run the Cognos TM1

Chapter 12. Installing the Cognos TM1 Operations Console 119

Page 132: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Operations Console, you need to update this configuration file with theinformation that describes your new monitoring group.

Before you begin

Ensure that you added and configured a designated user group in Cognos TM1Architect specifically for the Cognos TM1 Operations Console.

Procedure1. Edit the OpsConfig.xml file using an XML or text editor.

v For the Apache Tomcat provided with the Cognos TM1 installation, the file islocated here:TM1_location\webapps\tm1operationsconsole\WEB-INF\configuration

v If you are using your own version of Apache Tomcat, the file is located here:C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\tm1operationsconsole\WEB-INF\configuration

2. Update the OpsConfig.xml file with the adminhost, server, and group names.The following sample OpsConfig.xml file is configured for the sdata sampleCognos TM1 server running on the local computer with a user group named"monitor."<ops>

<adminhost name="localhost"><server name = "sdata">

<group>monitor</group></server>

</adminhost></ops>

3. Save and close the OpsConfig.xml file.

Configure Microsoft Internet Explorer 8 for the Cognos TM1Operations Console

You need to do some additional configuration to use the Microsoft InternetExplorer 8 web browser with the IBM Cognos TM1 Operations Console.

Procedure1. In Internet Explorer 8, enable the option to refresh web pages with every visit.2. Disable the options for script debugging.

For more information, see your Microsoft Internet Explorer documentation.

Start and log into the Cognos TM1 Operations ConsoleTo run the IBM Cognos TM1 Operations Console enter the URL that identifies theport and server name for the component.

Procedure1. In a web browser, type the following web address:

http://server_name:port_number/tm1operationsconsole

wherev server_name is the computer where the Cognos TM1 Operations Console and

your web application server are installed.

120 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 133: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Tip: You can use the keyword localhost if you are currently logged on tothe Web server that is running Cognos TM1 Application Web. Or you canuse the machine name, domain name, or IP address of the Web serverhosting the application.

v port_number is the port number where your web application server isrunning. For the version of Apache Tomcat that is provided with the CognosTM1 installation, the default port number is 9510.

Tip: For a different version of Apache Tomcat, open the Apache Tomcatserver.xml file in the C:\Program Files\Apache Software Foundation\Tomcat6.0\conf\ location to determine the port setting that your version of Tomcatis using.

2. On the log in page, enter values for the following fields, and then click Log In.v TM1 Admin Host

v Server Name

v Group Name

v User Name

v Password Name

Tip: If you receive the error message No server specified in OpsConfig.xml,check the following:v Ensure that the Cognos TM1 server you configured in the OpsConfig.xml file

is running.v Ensure that you performed the steps to add the certificates to the Java

Runtime Environment (JRE) keystore for the Cognos TM1 OperationsConsole.

v Ensure that your entered the name of the Cognos TM1 Operations Consoleuser group accurately in the OpsConfig.xml file.

See the IBM Cognos TM1 Operations Console Guide to begin using the CognosTM1 Operations Console.

Using your own version of Apache TomcatUse the following set of steps if you are using your own version of ApacheTomcat.

Verify JRE user environment variableCognos TM1 Operations Console needs the classpath user environment variableset.

If you are using your own installation of Apache Tomcat, verify that you have thefollowing Windows user environment variable for the JRE path.v Variable name: classpathv Variable value: .;C:\Program Files\Java\jre6\bin

If you are using the Tomcat provided with the Cognos TM1 installation, thevariable is set for you.

Add certificates to the JRE keystoreThe IBM Cognos TM1 Operations Console requires a certificate in the JavaRuntime Environment (JRE) keystore.

Chapter 12. Installing the Cognos TM1 Operations Console 121

Page 134: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Run the Java keytool command to import the certificate into the keystore.

a. Open a command prompt and change to the following directory:<location> \bin\jre\6.0\bin

where <location> is the file directory where Cognos TM1 is installed.CAUTION:On 64-bit computers, be sure to add the certificates to the bin64 folder.

b. Run the following command line. For formatting purposes the command isshown here with line breaks but you should enter the command all on oneline.keytool -import -file "C:\<location>\bin\ssl\applixca.pem"-keystore "C:\<location>\bin\jre\6.0\lib\security\cacerts"-storepass "changeit"

For 64-bit installations, target the 64-bit folder when dealing with thecertificates. For example, this sample command targets the 64-bit jre:cd C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\jre\6.0\bin

The following command is an example used on 64-bit systems. Forformatting purposes this command is shown with line breaks but youshould enter the command all on one line.keytool -import -file "C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\ssl\applixca.pem" -keystore "C:\Program Files (x86)\ibm\cognos\TM1_64\bin64\jre\6.0\lib\security\cacerts" -storepass "changeit"

If you do not correctly target the 64-bit locations for certificates whenrunning a 64-bit installation, you receive a warning message indicating thatyou cannot contact the servers.

c. Enter yes when prompted to trust or add the certificate.

The following message displays: Certificate was added to keystore

2. You may need to restart Apache Tomcat to have the change take effect.

Remember: Re-add certificates any time you re-install Cognos TM1 .

Deploy the Cognos TM1 Operations ConsoleBefore you can start using the IBM Cognos TM1 Operations Console, you mustdeploy it to Apache Tomcat.

Before you beginv Start an instance of Apache Tomcat on the computer where you want to deploy

the Cognos TM1 Operations Console.v Ensure that you can access the Apache Tomcat Manager console.v If you have not used Tomcat Manager before, add a user and role to the

tomcat-users.xml file before you can log in. For more information, see yourApache Tomcat documentation.

Procedure1. With Apache Tomcat running, click Start > Programs > Tomcat Manager. Enter

the username and password if they are required by your Apache Tomcatinstance.

2. In Tomcat Manager, scroll down to the Deploy section and locate the WAR fileto deploy subsection.

122 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 135: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

CAUTION:If an earlier version of the Cognos TM1 Operations Console has already beendeployed, use the undeploy option in Tomcat Manager to undeploy theearlier version.

3. Click Browse to locate the Cognos TM1 Operations Console web applicationarchive file, tm1operationsconsole.war. The typical location of this file isinstall_location/webapps/tm1operationsconsole.war

4. Click OK.5. In Tomcat Manager, click Deploy.

When the deployment is complete, the Cognos TM1 Operations Consoledisplays as /tm1operationsconsole in the Applications section of TomcatManager.

Create a user group for the Cognos TM1 Operations ConsoleThe IBM Cognos TM1 Operations Console requires a designated Cognos TM1 usergroup that you create in Cognos TM1 Architect.

Procedure1. Run Cognos TM1 Architect.

Remember: If the TM1 Admin server and the server you want to monitor havenot been started yet, use Cognos Configuration to start them before runningCognos TM1 Architect.

2. In Cognos TM1 Architect, double-click TM1 to see the servers that are runningand available to you.

3. Double-click the server you want to monitor and log into it with the usernameand password for that server.

4. Right-click the server and select Security > Clients and groups to add a newuser group specifically for the Cognos TM1 Operations Console.

5. Select Groups > Add new group and enter a group name, such as monitor oranother easily-identifiable name for the Cognos TM1 Operations Consolegroup.You may need to scroll the window to see the new group that you have justadded.

6. Click OK.7. Assign a user to the new group:

Only these users will be able to log into the Cognos TM1 Operations Console.v For administrator-type users, assign them to the new group and also to the

built-in SecurityAdmin, and/or the ADMIN group.v If you want the monitoring user to be a standard user, assign that user to the

new group and to the Cognos TM1 DataAdmin group.See the IBM Cognos TM1 Operation Guide for details on assigning securitygroups in Cognos TM1 .

8. Click OK to return to the Server Explorer. You can close Cognos TM1 Architect.

Edit the OpsConfig.xml fileThe IBM Cognos TM1 Operations Console uses an XML file to identify the usergroup, server, and admin host to use. Before you can run the Cognos TM1Operations Console, you need to update this configuration file with theinformation that describes your new monitoring group.

Chapter 12. Installing the Cognos TM1 Operations Console 123

Page 136: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Before you begin

Ensure that you added and configured a designated user group in Cognos TM1Architect specifically for the Cognos TM1 Operations Console.

Procedure1. Edit the OpsConfig.xml file using an XML or text editor.

v For the Apache Tomcat provided with the Cognos TM1 installation, the file islocated here:TM1_location\webapps\tm1operationsconsole\WEB-INF\configuration

v If you are using your own version of Apache Tomcat, the file is located here:C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\tm1operationsconsole\WEB-INF\configuration

2. Update the OpsConfig.xml file with the adminhost, server, and group names.The following sample OpsConfig.xml file is configured for the sdata sampleCognos TM1 server running on the local computer with a user group named"monitor."<ops>

<adminhost name="localhost"><server name = "sdata">

<group>monitor</group></server>

</adminhost></ops>

3. Save and close the OpsConfig.xml file.

Configure Microsoft Internet Explorer 8 for the Cognos TM1Operations Console

You need to do some additional configuration to use the Microsoft InternetExplorer 8 web browser with the IBM Cognos TM1 Operations Console.

Procedure1. In Internet Explorer 8, enable the option to refresh web pages with every visit.2. Disable the options for script debugging.

For more information, see your Microsoft Internet Explorer documentation.

Start and log into the Cognos TM1 Operations ConsoleTo run the IBM Cognos TM1 Operations Console enter the URL that identifies theport and server name for the component.

Procedure1. In a web browser, type the following web address:

http://server_name:port_number/tm1operationsconsole

wherev server_name is the computer where the Cognos TM1 Operations Console and

your web application server are installed.

Tip: You can use the keyword localhost if you are currently logged on tothe Web server that is running Cognos TM1 Application Web. Or you canuse the machine name, domain name, or IP address of the Web serverhosting the application.

124 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 137: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v port_number is the port number where your web application server isrunning. For the version of Apache Tomcat that is provided with the CognosTM1 installation, the default port number is 9510.

Tip: For a different version of Apache Tomcat, open the Apache Tomcatserver.xml file in the C:\Program Files\Apache Software Foundation\Tomcat6.0\conf\ location to determine the port setting that your version of Tomcatis using.

2. On the log in page, enter values for the following fields, and then click Log In.v TM1 Admin Host

v Server Name

v Group Name

v User Name

v Password Name

Tip: If you receive the error message No server specified in OpsConfig.xml,check the following:v Ensure that the Cognos TM1 server you configured in the OpsConfig.xml file

is running.v Ensure that you performed the steps to add the certificates to the Java

Runtime Environment (JRE) keystore for the Cognos TM1 OperationsConsole.

v Ensure that your entered the name of the Cognos TM1 Operations Consoleuser group accurately in the OpsConfig.xml file.

See the IBM Cognos TM1 Operations Console Guide to begin using the CognosTM1 Operations Console.

Using Websphere 7.0 and 8.0You can install the IBM Cognos TM1 Operation Console on Websphere.

Import Websphere certificatesFollow these steps to import the certificates you need to run the IBM Cognos TM1Operations Console on IBM Websphere.

Procedure1. Open the Websphere Admin Console.2. In Websphere Administration Console, go to Security > SSL certificates and

key management Configuration settings, select Manage endpoint securityconfigurations .

3. Select the appropriate Outbound Configuration to get to the cell, then clickNode.

4. At Related Items, click Key stores and certificates and clickNodeDefaultTrustStore keystore.

5. At Additional Properties, click Signer certificates and Retrieve from Port.

6. Define the Cognos TM1 Admin settings.a. Hostname: Enter the name of the computer where the Cognos TM1 Admin

Server is running.b. Port: 5498c. Alias: <an alias for this field>.

Chapter 12. Installing the Cognos TM1 Operations Console 125

Page 138: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

d. Click Retrieve Signer Information.e. Verify that the certificate information is for a certificate that you can trust.f. Click Apply and Save to save the Master Configuration.

7. After you have successfully saved the Master Configuration for the CognosTM1 Admin server, use the same screen to define the settings for the CognosTM1 Server:a. Hostname: Enter the name of the computer where Cognos TM1 is running.b. Port: enter the port number listed in this server's tm1s.cfg file.c. Alias: <an alias for this field>.

d. Click Retrieve Signer Information.

e. Verify that the certificate information is for a certificate that you can trust.f. Click Apply and Save to save the Master Configuration again.

Deploying Cognos TM1 Operations Console on WebsphereFollow these steps to deploy the IBM Cognos TM1 Operations Console on an IBMWebsphere web server.

Before you begin

See the Websphere documentation for details on using IBM Websphere.

Before deploying, ensure that the Cognos TM1 Operations Console was installedwhen you installed Cognos TM1 . Cognos TM1 Operations Console is a WebApplication component that is selected by default. If you did not install it, you canre-run the installation and select only the Cognos TM1 Operations Console toinstall only that component.

After installation, determine the location of the tm1operations.war file which isusually in C:/<installation_location>/webapps

Procedure1. Open and log into the Websphere Administrative Console.2. In the right pane under Applications , click New Application > New

Enterprise Application.3. Specify the address of the tm1operationsconsole.war file and click Next.4. Select Fast path and click Next.5. In Select Install Applications, accept the defaults by clicking Next.6. In Map Module to Servers, select the server(s) where you want to install the

modules that are in your application and click Next.7. In Map Virtual Hosts For Web Modules, specify the virtual host where you

want to install the Web modules that are in your application and click Next.8. In Map Context Roots For Web Modules, enter the Context Root as

/tm1operationsconsole

9. Click Save to save the Master Configuration.10. Add a monitoring user group in Cognos TM1 . See “Create a user group for

the Cognos TM1 Operations Console” on page 119 for details.11. Edit the OpsConfig.xml file. See “Edit the OpsConfig.xml file” on page 119 for

details.

126 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 139: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Starting the Cognos TM1 Operations Console on WebsphereAfter adding certificates and deploying the IBM Cognos TM1 Operations Console,start it from a web browser.

Procedure1. In the Websphere Enterprise Application, check the tm1operationsconsole.war

2. Click Start.3. Open a web browser.4. Enter the URL for the Cognos TM1 Operations Console, for example,

http://localhost:9080/tm1operationsconsole/

Chapter 12. Installing the Cognos TM1 Operations Console 127

Page 140: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

128 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 141: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 13. Cognos TM1 tools installation

A set of Cognos tools and utilities are installed when the TM1 Application Tier >TM1 Tools component is selected during installation.

These tools are optional components that you can choose not to install byunselecting the TM1 Tools component during installation. These tools are installedin <TM1_location>/bin

The tools installed in this group include:v TM1RunTI

TM1RunTI is a command line interface tool that can initiate a TM1TurboIntegrator (TI) process from within any application capable of issuingoperating system commands.Location: <TM1_location>/binFilename: tm1runti.exeSee the "Editing Advanced Procedures" chapter of the IBM Cognos TM1TurboIntegrator Guide.

v tm1xfer

The tm1xfer utility compresses and moves IBM Cognos TM1 server objects fromone platform to another platform while preserving mixed case names for objectson both Microsoft Windows and UNIX platforms.Location: <TM1_location>/binFilename: tm1xfer.cmd and tm1xfer.jar

See the "Tools and Utilities" chapter of the IBM Cognos TM1 Operation Guide.

Other tools available for Cognos TM1 include:v Cognos TM1 Operations Console

The Cognos TM1 Operations Console can monitor multiple TM1 servers andprovides extensive formatting capabilities for log files. The Cognos TM1Operations Console has its own component that can be selected in theinstallation. See the IBM Cognos TM1 Operations Console Guide for details.

v TM1 Top

TM1 Top monitors a single Cognos TM1 server. Installed by default. See the"System Performance and Monitoring" chapter of the IBM Cognos TM1 OperationGuide for details.

v odbc_test

The odbc_test tool is used to diagnose and test an IBM Cognos TM1 ODBCconnection on UNIX. See the "Tools and Utilities" chapter of the IBM CognosTM1 Operation Guide for details.

© Copyright IBM Corp. 2007, 2012 129

Page 142: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

130 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 143: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 14. Cognos TM1 and Cognos Business Intelligenceinteroperability installation

Use the IBM Cognos TM1 Business Intelligence (BI) interoperability installationprogram to integrate IBM Cognos TM1 into an existing IBM Cognos BIenvironment. This installation program installs components that support CognosTM1 Viewer Portlets in Cognos BI dashboards, provisioning IBM Cognos Insightfrom the Cognos BI Gateway, and linking to IBM Cognos TM1 Applications fromCognos BI.

Installation requirements

Review the following considerations and requirements before installing:v The Cognos TM1 BI interoperability features are supported with IBM Cognos BI

10.1.1.v You must install the Cognos TM1 BI interoperability files into an existing

installation of Cognos BI.v The default installation location is: c:\Program Files\IBM\cognos\c10

v You must have the TM1_PATH environment variable specified before connecting toCognos TM1 under a UNIX environment.

Components and functionality

The Cognos TM1 BI interoperability installation program installs the followingcomponents and functionality. You must install the Cognos TM1 BI interoperabilityinstallation program into all Cognos BI Gateway and Cognos BI Application Serverlocations to enable these features.v TM1 Application Tier

Installs the required files for Cognos TM1 Viewer Portlets that enable IBMCognos Connection pages to access TM1 cube views and websheets.

v Web Application Tier

– Installs copies of the installation files for IBM Cognos Insight so this clientcan be provisioned from the Cognos BI Gateway.

– Installs the required files that provide linking to Cognos TM1 Applicationsfrom Cognos BI.

Attention: To enable Cognos BI reporting against Cognos TM1 data sources, usemust use the Cognos TM1 10.1 Client installation program to install the requiredCognos TM1 APIs option into an adjacent directory on all Cognos BI servers thatare running report services on Microsoft Windows. This applies to newinstallations of Cognos TM1 10.1 and existing Cognos TM1 10.1 installations thatsubsequently set up Cognos BI. For details, see “Enabling Cognos BI reporting onCognos TM1 data sources” on page 133.

Install Cognos TM1 BI interoperabilityFollow these steps to install the IBM Cognos TM1 BI interoperability installation.

© Copyright IBM Corp. 2007, 2012 131

Page 144: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

About this task

This installation program installs the required files under the same directory whereyour existing Cognos components are installed. For example, if your existingCognos components are installed in C:\Program Files\IBM\cognos\c10, you shouldinstall the interoperability files in this same location.

The Cognos TM1 Viewer Portlets need to be installed on all Cognos computers in areporting environment.

Procedure1. Stop the IBM Cognos service.2. Double-click the issetup.exe file for the IBM Cognos TM1 BI interoperability

installation program.3. Follow the directions in the installation wizard and select the components that

you want to install:v TM1 Application Tier

v TM1 Contributor Gateway

Note: For a description of the features installed with each component, seeChapter 14, “Cognos TM1 and Cognos Business Intelligence interoperabilityinstallation,” on page 131.

4. Review the installation summary and then click Next.5. On the Finish page, view the log files if required and then click Finish.6. Perform the additional configuration steps for the interoperability functionality

that you want to enable.For example,v “Configure Cognos TM1 BI interoperability to use IBM Cognos Security”v “Configure Cognos BI for Cognos TM1 Viewer Portlets”

7. Restart the IBM Cognos service.

Configure Cognos TM1 BI interoperability to use IBM Cognos SecurityIf you want to use IBM Cognos components to show Cognos TM1 cubes orCognos TM1 Websheets without having to log in to Cognos TM1, you mustconfigure the Cognos TM1 server to use IBM Cognos security.

For more information, see the “Using Cognos security with Cognos TM1 ” on page186 section in this guide.

Configure Cognos BI for Cognos TM1 Viewer PortletsIf you secured your Cognos TM1 data servers with IBM Cognos security, you mustspecify the location of the computers that are running Cognos TM1 Web so userscan access Cognos TM1 cube views and websheets from the Cognos TM1 ViewerPortlets.

About this task

The Cognos variables_TM1.xml file needs to include the name of the web serverrunning Cognos TM1 Web when Cognos TM1 Viewer Portlets are connecting to aCognos TM1 Server using Cognos security authentication. In this scenario, the

132 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 145: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

variables_TM1.xml file is referenced by the Cognos TM1 Server configuration file,tm1s.cfg.

Procedure1. In the Cognos_BI_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 Cognos TM1 Web isrunning.

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

4. Save the file.

Uninstall Cognos TM1 BI interoperabilityIf you no longer require IBM Cognos TM1 BI interoperability or you are planningto upgrade to a newer release, uninstall the interoperability components.

Procedure1. From the Start menu, click Programs > IBM Cognos 10, Uninstall IBM Cognos

TM1 BI Interoperability > Uninstall IBM Cognos TM1 BI Interoperability.2. On the Uninstall Language Selection page, select the language for the

uninstallation wizard and then click Next.3. Select IBM Cognos TM1 BI Interoperability and click Next.4. When the uninstallation is complete, click Finish.

Some files and folders remain on the computer until you remove themmanually. If you plan to upgrade, do not delete the files and folders.

Enabling Cognos BI reporting on Cognos TM1 data sourcesTo enable Cognos BI reporting against Cognos TM1 data sources, use the CognosTM1 Client installation program to install the required Cognos TM1 API files on allCognos BI servers that are running report services on Microsoft Windows.

About this task

These steps apply to new installations of Cognos TM1 10.1 and existing CognosTM1 10.1 installations that subsequently set up Cognos BI.

Procedure1. Run the IBM Cognos TM1 Client installation program:

v On Microsoft Windows Vista, Windows 7, or Windows Server 2008 operatingsystem software, right-click the issetup.exe command and click Run asAdministrator.

v For other Windows operating systems, double-click the issetup.exe file.2. On the Installation Location page, select an adjacent directory on the Cognos

BI server that is running report services on Microsoft Windows.

Chapter 14. Cognos TM1 and Cognos Business Intelligence interoperability installation 133

Page 146: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

3. On the Component Selection page, expand TM1 Client Tier, and select thefollowing option:TM1 APIs

Leave all the other check boxes unselected.4. Follow the prompts and click Finish to complete the installation.

134 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 147: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 15. Cognos TM1 Package Connector installation

IBM Cognos TM1 supports connectivity to IBM Cognos Business Intelligence (BI)packages against certain data sources.

See the supported software page on the Cognos TM1 10.1.0 Information Center(http://publib.boulder.ibm.com/infocenter/ctm1/v10r1m0/index.jsp) for details onthe supported datasources.

See the "Importing Data Using the IBM Cognos TM1 Package Connector" chapterin the IBM Cognos TM1 TurboIntegrator Guide for more information about using theCognos TM1 Package Connector.

The Cognos TM1 Package Connector is an optional component available as aseparate CD or download from the main Cognos TM1 installation.

Cognos TM1 Package Connector requirementsRefer to the IBM Cognos Business Intelligence and IBM Cognos TM1 InformationCenters for more details on the supported platforms, versions, and requirements.

The Cognos TM1 Package Connector requires the following components:v Cognos TM1 9.5.1 or later.

The Cognos TM1 Package Connector must be installed on both the Cognos TM1server and the administrative client machines where TurboIntegrator processesare being created for any datasource you are using.

v IBM Cognos Business Intelligence Server. See the Cognos BI Information Centerfor specific versions supported.

v IBM Cognos Framework Manager for package creation.v If your datasource is SAP, then SAP Business Warehouse is required. See the

Information Center for specific versions supported.v 32-bit database client software is required on all platforms where the Cognos

TM1 Package Connector is installed for the specific data source being used. ForSAP BW, this requires the SAP GUI or the SAP RFCSDK library files and DLLs.See “Enabling connectivity to SAP from Cognos TM1” on page 136.

Installing the Cognos TM1 Package ConnectorFollow these steps to install the IBM Cognos TM1 Package Connector:

Procedure1. Insert the Cognos TM1 Package Connector disc into the Cognos TM1 server

machine.2. Run issetup.exe found in the system folder for your operating system, for

example win32.This launches the Cognos Installer.

3. Complete the installation prompts as appropriate for your installation.You can install the product to an existing Cognos BI compatible folder. You donot need to create a separate Cognos BI location for the Cognos TM1 PackageConnector.

© Copyright IBM Corp. 2007, 2012 135

Page 148: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

4. On the Finish screen, select the Start IBM Cognos Configuration check box tolaunch the configuration window automatically. If you prefer, you can leavethis box unchecked and launch the Cognos Configuration manually after youhave installed.

Installing the Cognos TM1 Package Connector on Windows 7or Vista

By default, the temp directory for the IBM Cognos TM1 Package Connector inCognos Configuration is in the Program Files location.

Microsoft Vista or Windows 7 applications are not allowed to write in the ProgramFiles location. This can result in an error when choosing the Cognos TM1 PackageConnector from Cognos TM1 Perspectives on Windows 7 and Vista.

To avoid this problem, choose Run as Administrator when running MicrosoftExcel. Or, in the Cognos Configuration for Cognos TM1 Package Connector youcan change the Temporary files location setting to a directory that is writable bythe user.

Enabling connectivity to SAP from Cognos TM1To enable connectivity to the SAP server requires the 32-bit SAP RFCSDK libraryfiles and DLLs on both the IBM Cognos TM1 Admin Client and the IBM CognosTM1 server.

To obtain these files on Microsoft Windows, install the SAP GUI. For UNIX see“Installing the Cognos TM1 Package Connector on UNIX” on page 138.

Configuring the Cognos TM1 Package ConnectorOnce you have installed the IBM Cognos Business Intelligence (BI) TM1 PackageConnector, you have access to the IBM Configuration tool.

If the Cognos Configuration tool did not launch automatically, you can use theStart Menu, IBM Cognos, IBM Cognos Configuration option to launch it.

Procedure1. Launch or open Cognos Configuration.2. Select the Environment node on the Local Configuration Explorer window. The

current settings for URI display.3. Set the Gateway URI to point to the Cognos BI server where packages are

deployed.The Gateway URI is in the form ofhttp[s]://<host IP address>:<port>/<BI_SERVER_virtual_dir>/cgi-bin/cognos.cgi.

See the IBM Cognos TM1 Operation Guide or the Cognos BI documentation formore information on URIs.

4. Enter the URI in the Value column of the Other URI settings node.The Dispatch URI is in the form ofhttp[s]://<host IP address>:<port>/p2pd/servlet/dispatch.

5. Once the URI is set, Save the configuration.

136 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 149: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The configuration progress window checks the status of your entries. When itis complete, click Close. If you encountered an error, check your settings andre-enter the values.

6. Close the Cognos Configuration window.

Setting the environment variableOn Microsoft Windows, after you have installed the IBM Cognos TM1 PackageConnector, the TM1_PACKAGE_CONNECTOR system environment variable is setto the installation directory specified in the installation, for example C:\ProgramFiles\ibm\Cognos\c10\bin.

You can change this location if necessary by editing the variable or creating asystem environment variable.

The system variable is created by the most recent installation of the Cognos TM1Package Connector. If Cognos TM1 Package Connector10 and Cognos TM1Package Connector8 are co-installed on the same computer, the most recentinstallation would take effect based on the system variable setup done by theinstallation.

The default Microsoft Windows installation location for Cognos TM1 PackageConnector10 is C:\program Files\ibm\cognos\c10 while Cognos TM1 PackageConnector8 is C:\program Files\ibm\Cognos\c8.

Setting the Cognos TM1 server configuration parameter(optional)

For the IBM Cognos TM1 TurboIntegrator process to run on the Cognos TM1server, add the CognosTM1InterfacePath parameter to the TM1 server configurationfile (tm1s.cfg) for the Cognos TM1 server where your data will reside after theimport from the Cognos Business Intelligence (BI) package.

Attention: The following information applies only when using a MIcrosoftWindows operating system.

The value of CognosTM1InterfacePath tells the Cognos TM1 Server where to findthe Cognos TM1 Package Connector. This is not needed if theTM1_PACKAGE_CONNECTOR environment variable is defined. If this parameteris defined, it overrides the TM1_PACKAGE_CONNECTOR environment variable.

Enter the Cognos TM1 Package Connector location into the Cognos TM1 servertm1s.cfg file where the Cognos TM1 Package Connector is installed, for example:CognosTM1InterfacePath=C:\Program Files\ibm\cognos\c10\bin

Remember:

CognosTM1InterfacePath variable is required only when using the Cognos TM1Package Connector on UNIX (AIX, Solaris, Linux,).

The TM1_Package_CONNECTOR is a system environmental variable that identifiesthe Cognos TM1 Package Connector installation location on a Windows operatingsystem.

Chapter 15. Cognos TM1 Package Connector installation 137

Page 150: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

cognosTM1InterfacePath is used in the Cognos TM1 server's tm1s.cfg on UNIX ,however if it is added to a TM1server's tm1s.cfg file on Windows, it can overwritethe value set in TM1_Package_Connector.

Cognos TM1 Package Connector on the client computerAfter you have installed and configured the IBM Cognos TM1 Package Connectoron the Cognos TM1 server, install and configure another copy on the admin clientcomputer. Use the same settings for both installations.

Running the TM1 Package ConnectorSee "Importing Data Using the IBM Cognos TM1 Package Connector" chapter ofthe IBM Cognos TM1 TurboIntegrator Guide for details on how to run the CognosTM1 Package Connector.

Installing the Cognos TM1 Package Connector on UNIXTo install the IBM Cognos TM1 Package Connector on UNIX follow the sameinstructions as for the Microsoft Windows installation making the followingadjustments:

Procedure1. Use 32 bit Java Standard Edition 6 (or 32-bit Java SE 6).2. Set the environment variable JAVA_HOME=<java_location> where <java_location>

is the 32-bit Java installation location.3. Copy the files at <Package_Connector_install_location>/bin/jre/6.0/lib/

ext* to JAVA_HOME/jre/lib/ext.4. Start cogconfig.sh from the <Package_Connector_install_location>/bin.5. Place the 32-bit SAP RFCSDK library files and DLLs on the UNIX machine.6. Set a locale that uses the UTF-8 code page to handle Unicode data. This is

optional.7. Configure the Cognos TM1 server by adding the parameter to the tm1s.cfg file:

CognosTM1InterfacePath=/<Package_Connector_install_location>/bin

8. Configure your environment to use the SAP DLLs and the Cognos TM1Package Connector:a. Include RFCSDK's lib directory in the search path of:, $LD_LIBRARY_PATH

or $LIBPATHb. Export (make public) these variables: $LIBPATH and $LD_LIBRARY_PATH

v Where the libraries are found is different on various UNIX platforms:Solaris and Linux: LD_LIBRARY_PATHHPUX: SHLIB_PATHAIX: LIBPATH

138 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 151: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 16. Cognos TM1 Workflow Installation

The IBM Cognos TM1 Workflow is an optional component of the IBM Cognos TM1installation.

See TM1 Workflow Instructions (http://www-01.ibm.com/support/docview.wss?uid=swg27023302) for complete instructions on how to install TM1Workflow.

The IBM Cognos TM1 Workflow Administrator Guide provides information onusing TM1 Workflow. You can find that manual on the IBM Cognos TM1 10.1.0Information Center (http://publib.boulder.ibm.com/infocenter/ctm1/v10r1m0/index.jsp).

© Copyright IBM Corp. 2007, 2012 139

Page 152: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

140 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 153: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 17. Advanced configuration

This section describes advanced configuration to customize IBM Cognos TM1 foryour specific business requirements and environment after you have completed theinitial installation steps.

Changing Cognos TM1 services to run as a specific user account onWindows

When using IBM Cognos Configuration to manage Cognos TM1 services, you needto change the default user account that runs the Microsoft Windows services forthe Cognos TM1 Server, Cognos TM1 Admin Server, and Cognos TM1 ExcelService. By default, Cognos Configuration registers these services under thepredefined Microsoft Windows Local System account. However, these servicesshould be changed to run as a specific user account.

Before you begin

Review the required account privileges for using a user account other than LocalSystem account. For details, see “User accounts for running Cognos TM1 serviceson Windows” on page 17.

About this task

Use Windows Services to change the user account for a Cognos TM1 componentthat is configured to run as a service.

Procedure1. Open IBM Cognos Configuration.2. Expand the Explorer > Local Configuration tree:

a. Expand the Local Configuration > Environment node.b. Expand the Data Access > TM1 Server node.

3. Right-click on each Cognos TM1 component you want to change and selectStop.v TM1 Admin Server

v TM1 Excel service

v Cognos TM1 Server name - the name for each server you have in CognosConfiguration.

Tip: You do not need to stop the TM1 Application Server component.4. Open Windows Services.5. Locate the Cognos TM1 component that you want to update and change the

user account for the Windows service that runs it:a. Right-click on the service, select Properties and then click the Log On tab.b. Enter a new user name and password for the service.c. Repeat these steps for any other Cognos TM1 component running as a

Windows service that you want to change.6. Close Windows Services.7. In Cognos Configuration, restart each service that you changed:

© Copyright IBM Corp. 2007, 2012 141

Page 154: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Right-click on the item and select Start.8. Close Cognos Configuration.

Cognos TM1 language configurationIBM Cognos TM1 automatically configures language for the Cognos TM1 Server,client user interfaces, and messages by detecting the current language of theoperating system user account or web browser where they are running. You canoverride this automatic configuration and configure Cognos TM1 to use a specificlanguage from any of the supported languages.

For details about supported languages, see “Cognos TM1 language codes” on page143.

Automatic detection of language

Cognos TM1 uses the following process to automatically detect and configurelanguage at runtime:1. The Cognos TM1 server and clients that run in Microsoft Windows try to detect

and use the language that is configured in the locale of the operating systemfor the current user. On Windows, this is configured with Regional andLanguage Options. The detected language will be used if it matches one of thesupported languages.

Important: By default, any Cognos TM1 Server that you start with IBM CognosConfiguration is initially configured to run as a Windows service using theWindows Local System reserved user account. If you want the Cognos TM1Server to use the language based on a specific user account, change the serviceto run as that user and configure the language for the user with the WindowsRegional and Language Options. For details, see “Changing Cognos TM1services to run as a specific user account on Windows” on page 141.

2. The server and client components also check for an override based on theCognos TM1 Language configuration parameter:v The server checks the Language parameter in the Tm1s.cfg configuration file.

If a valid language code is configured, that language is used for the servermessages.

v The client components check the Language parameter in the Tm1p.iniconfiguration file. If a valid language code is configured, that language isused in the user interface.

3. If the language configured in any of the above does not match a validsupported language, English is used.

Language configuration for Cognos TM1 components

Languages are set separately for the following Cognos TM1 components.

Table 23. Summary of language configuration for Cognos TM1 components

Component Language Configuration

Cognos TM1 Server Use the Language parameter in the Tm1s.cfg file toconfigure a specific language for a Cognos TM1 Server.

For details, see “Configuring language for the Cognos TM1server” on page 143

142 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 155: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 23. Summary of language configuration for Cognos TM1 components (continued)

Component Language Configuration

Cognos TM1 Architect,

Cognos TM1 Perspectives

Use the Language parameter in the Tm1p.ini file toconfigure a specific language for Cognos TM1 clients thatrun on Microsoft Windows.

For details, see “Configuring language for Cognos TM1clients on Windows” on page 144

Cognos TM1 Web Use the language settings in your web browser to select aspecific language for Cognos TM1 Web.

For details, see Configuring Language Settings in MicrosoftInternet Explorer

Cognos TM1 language codesThe following table summarizes the language codes for the supported languages inIBM Cognos TM1.

Language Code

Brazilian Portuguese bra

Croatian hry

Czech csy

Chinese (Simplified) sch

Chinese (Traditional) tch

Danish dan

German deu

Spanish esp

Finnish fin

French fra

Hungarian hun

Italian ita

Japanese jpn

Kazakh kaz

Korean kor

Norwegian nor

Polish pol

Romanian rom

Russian rus

Swedish sve

Turkish trk

Configuring language for the Cognos TM1 serverUse the Language parameter in the Tm1s.cfg file to configure a specific languagefor the IBM Cognos TM1 Server.

Chapter 17. Advanced configuration 143

Page 156: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

About this task

The Language configuration parameter for the Cognos TM1 Server controls thelanguage for messages generated by the server. The parameter also applies to theuser interface of the dialog box when you run the server as an application insteadof a Windows service.

For more details about the Cognos TM1 Server Language parameter, see Languageparameter in the Tm1s.cfg file.

Note: If you want the Cognos TM1 Server to use a language based on a useraccount instead of the Language parameter, change the Microsoft Windows servicethat runs the Cognos TM1 Server to run as a specific user. For details, see“Changing Cognos TM1 services to run as a specific user account on Windows” onpage 141.

Procedure1. Use a text editor to open the Cognos TM1 Server configuration file, Tm1s.cfg.

For location details, see “Location of the Tm1s.cfg File” on page 219.2. Edit or add the Language parameter with the language code you want to use.

For example:Language=deu

For a list of supported language codes, see “Cognos TM1 language codes” onpage 143.

3. Save and close the Tm1s.cfg file.4. Restart the Cognos TM1 Server.

Configuring language for Cognos TM1 clients on WindowsUse the Language parameter in the Tm1p.ini file to configure a specific languagefor IBM Cognos TM1 clients that run on Microsoft Windows such as Cognos TM1Architect and Cognos TM1 Perspectives.

About this task

For details about this parameter, see Language parameter in the Tm1p.ini file.

Note: The Language parameter for Cognos TM1 clients is separate from theparameter of the same name for the Cognos TM1 Server.

Procedure1. Use a text editor to open the Cognos TM1 client configuration file, Tm1p.ini.

For location details, see “Location of the Tm1p.ini File” on page 259.2. Edit or add the Language parameter with the language code you want to use.

For example:Language=sch

For a list of supported language codes, see “Cognos TM1 language codes” onpage 143.

3. Save and close the Tm1p.ini file.4. Restart the Cognos TM1 client.

144 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 157: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Configuring language in Internet Explorer for Cognos TM1Web

The language settings in Microsoft Internet Explorer determine which language isused in the IBM Cognos TM1 Web interface. In Microsoft Internet Explorer, changethe language settings to display your primary language in Cognos TM1 Web.

Changing default port numbers for Cognos TM1 Admin ServerIf you change the default values for the TM1 Admin Server host port number orthe TM1 Admin Server SSL port number in IBM Cognos Configuration, you needto manually update the new values in the UNIX and Microsoft Windows servicesfile across all the affected computers in your environment. This operating systemfile is not updated by Cognos TM1.

About this task

Update the operating system services file on any computer running Cognos TM1components that need to communicate with the Cognos TM1 Admin Server. Forexample:v Cognos TM1 Serverv Cognos TM1 desktop clients such as Cognos TM1 Architect or Cognos TM1

Perspectivesv Custom Cognos TM1 applications created with the Cognos TM1 API.v Cognos TM1 Web (web server only)

Procedure1. Locate and open the services file for the specific operating system.

v For UNIX, the typical location of the services file is:/etc/services

v For Windows, the typical location of the services file is:C:\WINDOWS\system32\drivers\etc\services

2. Add or edit the following entries in the services file with the new portnumbers. For example:tm1adminsvr 5400/tcp # Added by IBM Cognos TM1

tm1admsrv_ssl 5403/tcp # Added by IBM Cognos TM1

3. Save and close the file.4. Repeat these steps for each computer running Cognos TM1 components that

communicate with the Cognos TM1 Admin Server.

Configuring Cognos TM1 to use IPv6To use IBM Cognos TM1 with internet protocol version 6 (IPv6), you configure acombination of Cognos TM1 parameters and an operating system environmentvariable.

About this task

By default, Cognos TM1 uses IPv4.

You can configure Cognos TM1 to use one of the following modes to specify whichinternet protocol that you want Cognos TM1 to use with your network.

Chapter 17. Advanced configuration 145

Page 158: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

ipv4 Default setting. Used for IPv4 networks.

dual Used to transition from IPv4 to IPv6. Both protocols are supported.

ipv6 Used for IPv6 networks.

Procedure1. Configure the Cognos TM1 Admin Server:

a. On the computer where the Cognos TM1 Admin Server is running, openCognos Configuration.

b. Expand the Local Configuration > Environment node and click TM1Admin Server.

c. In the Component Properties pane, set the TM1 Admin Server IP supportoption to either Dual (IPv4 and IPv6), IPv4, or IPv6.

d. If needed, add the IPv6 address to the /etc/hosts operating system file onUNIX and Microsoft Windows. In some cases, depending on your networkenvironment and DNS configuration, you may need to perform thisadditional step to successfully run the Cognos TM1 Admin Server andCognos TM1 Server in IPv6 mode.

e. Add the TM1_IPVersion environment variable as described in step 3.2. Configure the Cognos TM1 Server:

a. On the computer where the Cognos TM1 Server is running, open thetm1s.cfg file.

b. Set the IPversion parameter to the IP mode that you want to use.For example, to specify that your network uses the IPv6 protocol, add theparameter as follows:IPVersion=ipv6

For more details, see “IPVersion” on page 236.c. If needed, add the IPv6 address to the /etc/hosts operating system file on

UNIX and Microsoft Windows.d. Add the TM1_IPVersion environment variable as described in step 3.

3. Add the TM1_IPVersion environment variable to the operating system for eachcomputer that communicates directly with the Cognos TM1 Admin Serverand/or TM1 Server.Use the following variable name and value format:TM1_IPVersion=ip_mode

where ip_mode can be one of the following values:v Dual

v IPv6

v IPv4

The TM1_IPVersion environment variable is required on any computer that isrunning any of the following Cognos TM1 components:v Cognos TM1 Admin Serverv Cognos TM1 Serverv Cognos TM1 administrator tools, such as TM1 Top or the tm1srvstop.exe

utility.v Cognos TM1 Web (web server only)v Cognos TM1 Application serverv Cognos TM1 clients:

– Cognos TM1 Architect

146 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 159: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

– Cognos TM1 Perspectives– Cognos Insight– Cognos TM1 Performance Modeler

v Custom applications that use the Cognos TM1 API.

Note: You do not need to set this environment variable on computers that useonly a web browser to access Cognos TM1 Web.

4. Restart any Cognos TM1 servers that you modified.5. Test the connection between your Cognos TM1 server and client applications.

Configuring client computers to export Cognos TM1 data in PDFformat

To export IBM Cognos TM1 data to Adobe PDF format from IBM Cognos TM1client applications running in Microsoft Windows, set PDFCamp as your defaultprinter and ensure that the Windows service for the IBM Cognos TM1 ExcelService is running as a specific user account. These steps apply to IBM CognosTM1 Perspectives, IBM Cognos TM1 Architect, and IBM Cognos TM1 Web.

Before you begin

Verify that PDFCamp is installed correctly by confirming that PDFCamp PrinterDriver exists in the Windows Printers and Faxes configuration.

Procedure1. Configure the default printer:

a. In Windows, open the Printers and Faxes configuration window.b. Right-click PDFCamp Printer Driver and select Set as Default Printer.

2. Ensure that the Windows service for the Cognos TM1 Excel Service is runningas a specific user account and not as Local System account.a. On the web server where Cognos TM1 Web is running, open Windows

Services.b. Locate the entry for IBM Cognos TM1 Excel Service.c. Right-click IBM Cognos TM1 Excel Service and select Properties.d. Enter a user and password for an existing Windows user with the

appropriate rights.e. Restart the service and close Windows Services.

For more details, see “User accounts for running Cognos TM1 services” and“Changing Cognos TM1 services to run as a specific user account onWindows”.

Cognos TM1 Web advanced configurationThis section describes additional configuration steps for IBM Cognos TM1 Webthat may be needed for your environment after you complete the initialinstallation.

Depending on your environment, you can perform additional configuration for theweb server that is running Cognos TM1 Web and for the web browsers that userswill use to connect to Cognos TM1 Web.

Chapter 17. Advanced configuration 147

Page 160: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Web browser configuration for Cognos TM1 Web

Users connect to Cognos TM1 Web using one of the supported web browsersrunning on their own computers. Some additional configuration may be required.See the following topics:v “Configuring language in Internet Explorer for Cognos TM1 Web” on page 145v “Displaying and Entering Numbers Based on Regional Settings” on page 149v “Configuring Internet Explorer for Cognos TM1 Web” on page 149v “Running Cognos TM1 Web in Firefox Web Browser” on page 150

Web server configuration for Cognos TM1 Web

If necessary, perform these additional steps on your web server to configure andrun Cognos TM1 Web.v “Running the 64-bit version of Cognos TM1 Web on Windows x64” on page 150v “Running the 64-bit version of Cognos TM1 Web on Windows x64” on page 150v “Running Cognos TM1 Web on a WAN Server and exporting Excel and PDF

files” on page 151

Configuring the Login Page using AdminHostName andTM1ServerName

The AdminHostName and TM1ServerName parameters control whether or not theIBM Cognos TM1 Web login page prompts the user to enter values for the TM1Admin Host and TM1 server.

If you set a value for either of these parameters in the Web.config file, then thelogin process uses the specified value and does not prompt the user for thisinformation.

AdminHostName Parameter

This parameter specifies the name of the Admin Host on which a TM1 AdminServer is running. Edit the AdminHostName parameter in the Web.config fileusing the following format:<add key="AdminHostName" value="HostName"/>

where HostName can be one of the following values:v If HostName is blank (default value), then the login page displays the Admin

Host prompt.v If HostName is set to the name of a valid TM1 Admin Host, then IBM Cognos

TM1 Web uses that Admin Host for the login process and does not prompt theuser.

TM1ServerName Parameter

This parameter sets the name of the TM1 server. Edit the TM1ServerNameparameter in the Web.config file using the following format:<add key="TM1ServerName" value="ServerName"/>

where ServerName can be one of the following values:v If ServerName is blank (default value), then the TM1 server prompt is displayed

on the IBM Cognos TM1 Web login page, as shown below.

148 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 161: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v If ServerName is set to a valid TM1 server name, then the login page does notdisplay a prompt for either the Admin Host or the TM1 server.

v If the AdminSvrSSLCertID parameter is incorrectly configured, the server namepull-down displays as empty and an error is logged in the TM1Web.config file.See "Running TM1 in Secure Mode using SSL" in the IBM Cognos TM1 OperationGuide for more information.

After the user enters a valid User Name and Password, IBM Cognos TM1 Web willlogin to the TM1 server specified by the TM1ServerName parameter in theWeb.config file.

For example, the TM1ServerName parameter could be set to planning sample, asshown in the following code.<add key="TM1ServerName" value="planning sample" />

Configuring language in Internet Explorer for Cognos TM1Web

The language settings in Microsoft Internet Explorer determine which language isused in the IBM Cognos TM1 Web interface. In Microsoft Internet Explorer, changethe language settings to display your primary language in Cognos TM1 Web.

Displaying and Entering Numbers Based on Regional SettingsIf you are running the IBM Cognos TM1 Web client in a language other than thelanguage of your operating system, you must ensure that your web browserlanguage and Microsoft Windows regional setting are set to the same value.

This will enable you to display and enter numbers in Cognos TM1 Web based on aspecific regional setting.

For example, if you have an English OS, but want to run Cognos TM1 Web inFrench, your browser language must be set to French and your computer's regionalsetting language must be set to French.

Windows Regional and Language Settings

Access the Windows regional settings by opening the Regional and LanguageOptions feature in the Windows Control Panel.

Web Browser Language Settings

Access the web browser language setting as described in the section “Configuringlanguage in Internet Explorer for Cognos TM1 Web” on page 145.

Configuring Internet Explorer for Cognos TM1 WebIf you are using IBM Cognos TM1 Web with Microsoft Internet Explorer, makesure you have this security setting enabled to allow Cognos TM1 Web dialogwindows to display correctly.

Change the security settings as follows:v Allow websites to open windows without address bars or status bars.v Allow script-initiated windows without size or position constraints.

Chapter 17. Advanced configuration 149

Page 162: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

If Internet Explorer is not configured correctly, some Cognos TM1 Web dialogs canappear truncated.

Running Cognos TM1 Web in Firefox Web BrowserThere are configuration concerns and limitations when running IBM Cognos TM1Web with the Mozilla Firefox 2.0 web browser on Microsoft Windows and AppleMac OS X systems.

Enabling the JavaScript Raise or Lower Windows OptionBy default, Mozilla Firefox 2.0 disables the JavaScript option for raising andlowering pop-up windows. IBM Cognos TM1 Web requires this option to beenabled to correctly control the display of Cognos TM1 pop-up windows, dialogboxes, and messages.

Zoom Functionality in WebsheetsThe zoom feature in IBM Cognos TM1 Websheets is not supported in MozillaFirefox on both Microsoft Windows and Apple Mac OS X systems.

When viewing Websheets in Firefox, the Zoom In, Zoom Out, and Normal Viewicons do not display.

Enabling the Display of Symbol and Wingdings FontsIf you use Symbol or Wingdings fonts, you must complete the following steps toconfigure Mozilla Firefox to display these fonts.

Procedure1. Open the Firefox fontEncoding.properties file in a text editor.

If you accepted the default installation directory when you installed Firefox, thefull path to this file is C:\Program Files\Mozilla Firefox\res\fonts\fontEncoding.properties.

2. Locate the following lines:# Symbol font

encoding.symbol.ttf = Adobe-Symbol-Encoding

3. Replace the above lines with the following:# Symbol font

#-- Enabling Symbol and other fonts for Mozilla on Windows

encoding.symbol.ttf = windows-1252

encoding.wingdings.ttf = windows-1252

encoding.wingdings2.ttf = windows-1252

encoding.wingdings3.ttf = windows-1252

encoding.webdings.ttf = windows-1252

4. Save the fontEncoding.properties file.

Running the 64-bit version of Cognos TM1 Web on Windowsx64

To run the 64-bit version of IBM Cognos TM1 Web on a Microsoft Windows x64system, you must:v Configure Microsoft Internet Information Services (IIS) to run in 64-bit mode.v Register the 64-bit version of Microsoft .NET Framework 3.5 SP1.

Switching IIS to 64-bit modeSwitch Microsoft IIS to 64-bit mode using these steps.

150 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 163: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Open a command prompt.2. Enter and run the following command:

cscript %SYSTEMDRIVE%\inetpub\adminscripts\adsutil.vbsSET W3SVC/AppPools/Enable32bitAppOnWin64 0

Registering the 64-bit version of .NET FrameworkRegister the 64-bit version of .NET Framework using these steps.

Procedure1. Make sure that the 64-bit version of Microsoft .NET Framework 3.5 SP1 is

installed on the Web server.2. Open a command prompt.3. Change to the following directory:

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

Note: IBM Cognos TM1 Web requires the Microsoft .NET Framework 3.5 SP1,however, .NET 2.0 remains on your system after upgrading .NET and isrequired for this step.

4. Enter and run the following command:aspnet_regiis.exe -i

Results

Your system is now configured to run the 64-bit version of Cognos TM1 Web.

For more information about running the 64-bit version of ASP.NET, see thefollowing Microsoft technical article:http://support.microsoft.com/?id=894435

Running Cognos TM1 Web on a WAN Server and exportingExcel and PDF files

If you are running IBM Cognos TM1 Web on a WAN (Wide Area Network) serverand want to allow users to export Microsoft Excel and PDF files from Cognos TM1Web, you need to configure specific security settings in Microsoft Internet Explorer.

Because a WAN server resides in the Internet zone, Internet Explorer applies adifferent security profile as compared to servers in the Local Intranet zone. Tosuccessfully export files from Cognos TM1 Web in a WAN environment, you mustadd the Cognos TM1 Web server as a trusted site in the security settings forInternet Explorer.

Adding Cognos TM1 Web as a trusted site in Internet Explorer

If you are using Microsoft Internet Explorer and running IBM Cognos TM1 Web ona WAN server, you must add the Cognos TM1 Web server as a trusted site andthen customize the security settings for trusted sites.

Adding Cognos TM1 Web as a trusted site in Internet ExplorerIf you are using Microsoft Internet Explorer and running IBM Cognos TM1 Web ona WAN server, you must add the Cognos TM1 Web server as a trusted site andthen customize the security settings for trusted sites.

Chapter 17. Advanced configuration 151

Page 164: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Open Microsoft Internet Explorer.2. Click Tools >Internet Options.

The Internet Options dialog opens.3. Click the Security tab.4. Click Trusted Sites and then click the Sites button.5. Enter the URL of the Cognos TM1 Web server in the Add this Web site to the

zone box.6. Click Add.7. Close the Trusted Sites dialog box.8. On the Security tab of the Internet Options dialog, click Trusted sites and then

click the Custom Level button.The Security Settings - Trusted Sites Zone dialog opens.

9. Locate the settings for Downloads and click Enable for the Automaticprompting for file downloads option.

10. Click OK.

Using ClearType on Cognos TM1 Web Server to EnhanceDisplay and Rendering of Websheets

To enhance the display of IBM Cognos TM1 Websheets, especially ones thatinclude a combination of frozen and unfrozen panes with wrapped text withincells, install the Microsoft ClearType Tuner on the Cognos TM1 Web server.

This tool helps Cognos TM1 Web maintain the same row height between frozenand unfrozen panes in Websheets. Installation on client systems is optional.

Installing and Activating ClearType Tuner

Procedure1. Download and install Microsoft ClearType Tuner from the Microsoft web site.2. After installation, open ClearType Tuning from the Microsoft Windows Control

Panel.3. Click the Introduction tab and make sure the Turn On ClearType option is

selected.4. Click the Advanced tab and then click the Set Sample Font button. Choose a

font for the text sample and then click OK.5. On the Advanced tab, click to enable the Apply all settings to defaults for

new users and system option.6. Click OK.

7. Restart your computer.

Configuring Cognos TM1 Web to Run in Windows VistaMicrosoft Windows Vista system is not a supported environment for developmentor live applications of IBM Cognos TM1 . However, you can run Cognos TM1 Weband view Websheets on a Windows Vista system for demonstration or personal useonly.

If you do not configure Windows Vista as explained in the following steps, CognosTM1 Web displays an error when you view Websheets or try to export data to aMicrosoft Excel spreadsheet.

152 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 165: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

This configuration is for users who want to log on to a computer runningWindows Vista and work directly with Cognos TM1 Web on that system. It is notintended for remotely accessing Cognos TM1 Web from a Web browser on anothercomputer.

Procedure1. Click Start, All Programs, Accessories, Run.

The Run dialog box opens2. In the Run dialog box, type dcomcnfg and then click OK.

The Windows Component Services tool opens.3. Expand the tree to the following node:

Console Root, Component Services, Computers, My Computer, DCOMConfig.

4. Under the DCOM Config node, scroll down and select the Microsoft ExcelApplication item.

5. Right-click on the Microsoft Excel Application item and then click Properties.The Properties dialog box opens.

6. Click the Identity tab and then click to enable the option, The interactive user.7. Click OK to close the Properties dialog box and then close the Component

Services window.

Cognos TM1 Applications advanced configurationYou can perform advanced configuration tasks to customize your installation of theIBM Cognos TM Application components.

Using Cognos TM1 Applications with Cognos BusinessIntelligence Security

You can configure IBM Cognos TM1 Applications to use IBM Cognos BusinessIntelligence (BI) security. This configuration requires users to log in to Cognos TM1Applications as a valid user that exists in the Cognos BI server.

When you use Cognos TM1 Applications with Cognos BI Security, the CognosTM1 Application Server can be hosted on a web application server in one of thefollowing ways:v On a different computer with the Apache Tomcat that was provided with the

Cognos TM1 installationv On a different computer with your own installation of Apache Tomcat or IBM

Websphere.v Optionally, you can deploy Cognos TM1 Applications with the Apache Tomcat

web server that is supplied with Cognos BI.

In all cases, you must edit the planning.html file and copy this file to the CognosBI server so that the Cognos BI server knows the location of the Cognos TM1Application Server.

Configuring Cognos TM1 Applications to use Cognos BusinessIntelligence SecurityTo configure IBM Cognos TM1 Applications to use IBM Cognos BusinessIntelligence (BI) security, you work with files on the computers hosting these twocomponents, plus the computer where the Cognos TM1 Server is running.

Chapter 17. Advanced configuration 153

Page 166: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Configure the Cognos TM1 server to use Cognos BI security.

For complete details, see “Using Cognos security with Cognos TM1 ” on page186.a. Shut down the Cognos TM1 server.b. Open the Tm1s.cfg configuration file in a text editor.c. Set the IntegratedSecurityMode parameter to 5 as follows:

IntegratedSecurityMode=5

d. Save and close Tm1s.cfg.e. Restart the Cognos TM1 server.

2. Edit the planning.html file.

Important: The values for the planningServices parameter in this file arerequired to ensure that the Cognos BI server only redirects users to approvedlocations. The location of the Cognos TM1 Application Server from where theuser logs in must be validated to be one of the approved locations in this file orelse the Cognos BI server will not redirect the user.a. Locate the planning.html file:

Cognos TM1 location\webapps\pmpsvc\gateway_files\planning.html

Tip: You might have to first expand the planning_gateway.zip file to accessthis file.

b. Open the file and locate the following lines:// Update the following to point to the location of the planningservice(s)

var planningServices = ["http://machine.company.com:9510"];

c. Set the planningServices parameter to the location of the Cognos TM1Application Server.v If you are running the Cognos TM1 Application Server with the Apache

Tomcat that is provided with the Cognos TM1 installation:var planningServices = ["http://web_server_address:9510"];

v If you are running the Cognos TM1 Application Server with the ApacheTomcat that is provided with the Cognos BI installation:var planningServices = ["http://web_server_address:9300"];

v If you are running the Cognos TM1 Application Server with your ownweb application server, use the location and port number for that system.

Tip:

If you are using the same Cognos BI server to authenticate differentinstances of Cognos TM1 Applications that are running on multiplecomputers, use a comma separated list with the fully qualified domainname (FQDN) for each computer. For example:

var planningServices = ["http://machine1.company.com:port_number","http://machine2.company.com:port_number"];

Tip:

154 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 167: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

If the Cognos TM1 Application Server is running on a web server thatbelongs to multiple domains, use a comma separated list to enter the fullyqualified domain name for each domain. For example:

var planningServices = ["http://computer_A.domain_1:port_number","http://computer_A.domain_2:port_number","http://computer_A.domain_3:port_number"];

d. Save and close the planning.html file.3. Copy the updated planning.html file and other required Cognos TM1

Applications files to the Cognos BI server.From the folder Cognos TM1 location\webapps\pmpsvc\gateway_files\

v Copy planning.html to C10 Install Dir\webcontent.v Copy variables_plan.xml to C10 Install Dir\templates\ps\portal.v Copy icon_active_application.gif to C10 Install Dir\webcontent\ps\

portal\images.4. Configure the session timeout parameters for Cognos TM1 Applications and

Cognos BI security to ensure the proper timeout detection.For details, see “Configuring session timeout values for Cognos TM1Applications and Cognos BI Security” on page 156.

5. Restart the Cognos BI server.6. Configure Cognos TM1 Applications with values for the IBM Cognos Gateway

URI and IBM Cognos Dispatcher URI .a. Open Cognos TM1 Applications using the format of the following link:

http://web_server_name:port_number/pmpsvc

For example: http://localhost:9510/pmpsvcb. Log in and open the Cognos TM1 Applications Configuration page:

v If you are running Cognos TM1 Applications for the first time, theConfiguration page opens after you log in.

v If you have already configured Cognos TM1 Applications, open theConfiguration page by clicking the Administer IBM Cognos TM1

Applications icon on the toolbar of the TM1 Applications portal page.c. On the TM1 Applications Configuration page, enter values for the

following Cognos TM1 and Cognos BI parameters:v Enter values in the TM1 Admin Host and Server Name fields and

configure the options for the data contribution clients that you want touse. For details, see “Configuring the server and client environment forCognos TM1 Applications” on page 80.

v Set the IBM Cognos Gateway URI parameter. For example:http://CognosServerName/ibmcognos/cgi-bin/cognos.cgi

v Set the IBM Cognos Dispatcher URI parameter. For example:http://CognosServerName:9300/p2pd/servlet/dispatch

Replace CognosServerName with the name of the system where the CognosBI web server is running.

7. To test the configuration, log in to Cognos TM1 Applications using a webbrowser on a remote computer. If you see the following error, review yoursettings for the planningServices parameter in the planning.html file on theCognos BI server.The planning service parameter was not specified or is not one of the configured locations

Chapter 17. Advanced configuration 155

Page 168: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Configuring session timeout values for Cognos TM1 Applicationsand Cognos BI SecurityWhen using IBM Cognos TM1 Applications with IBM Cognos Business Intelligencesecurity, set the pmpsvc session timeout to a value higher than the CAM sessiontimeout to ensure the proper timeout detection. If the Cognos TM1 Applications(pmpsvc) session timeout is set to a value lower than the Cognos BI security(CAM) session timeout, then Cognos TM1 Applications will not properly detect aCAM session termination and will not timeout.

About this task

To ensure that Cognos TM1 Applications can properly detect a CAM sessiontermination, set the pmpsvc session timeout to a value higher than the CAMsession timeout.v The pmpsvc session timeout is the number of seconds of inactivity after which

Cognos TM1 Applications terminates a user session. The default value is 3600seconds (1 hour).

v The CAM session timeout is the number of seconds of inactivity after whichCognos security terminates a user session. The default value is 3600 seconds (1hour).

Procedure1. Configure the pmpsvc session timeout parameter.

Enter a value for the timeout attribute of the service / session element in thepmpsvc_config.xml file. This file is located in the WEB-INF/configurationdirectory.For example:v When Cognos TM1 Applications is deployed with the Apache Tomcat that is

provided with the Cognos TM1 installation, the pmpsvc_config.xml file ishere:Cognos_TM1_install_location\webapps\pmpsvc\WEB-INF\configuration

v When Cognos TM1 Applications is deployed with a separate version ofApache Tomcat, the file is here:C:\Program Files\Apache Software Foundation\Tomcat version_number\webapps\pmpsvc\WEB-INF\configuration

Use the format for the service / session / timeout attribute as defined in theXML schema definition file pmpsvc_config.xsd located in the same directory

2. Configure the CAM session timeout using IBM Cognos Configuration.Enter a value in the Inactivity timeout in seconds field in theSecurity/Authentication section of Cognos Configuration.

Deploying Cognos TM1 Applications on the Cognos BI webserver

You can deploy IBM Cognos TM1 Applications on the IBM Cognos BI web server.This configuration uses the version of Apache Tomcat installed by Cognos BI.

Procedure1. Use IBM Cognos Configuration to build the application file that deploys to the

Cognos BI web server.For details, see “Use IBM Cognos Configuration to build an application file fora Tomcat server” on page 82.

156 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 169: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

2. Copy and deploy the following Cognos TM1 Applications files to the CognosBI web server.

Copy from TM1 Install Dir To C10 Install Dir

The application file you generated withCognos Configuration:pmpsvc.war

C:\Program Files\IBM\cognos\tm1\webapps

\webapps

Cognos TM1 location\webapps\pmpsvc\gateway_files\planning.htmlNote: You might have to first expand theplanning_gateway.zip file to access thegateway files.

\webcontent

Cognos TM1 location\webapps\pmpsvc\gateway_files\variables_plan.xml

\templates\ps\portal

Cognos TM1 location\webapps\pmpsvc\gateway_files\icon_active_application.gif

\webcontent\ps\portal\images

3. Restart the Cognos server.4. Open Cognos TM1 Applications using the format of the following link:

http://Cognosx_ServerName:9300/pmpsvc

where x is the version of BI you are using.5. Log in and open the Cognos TM1 Applications Configuration page:

v If you are running Cognos TM1 Applications for the first time, theConfiguration page opens after you log in.

v If you have already configured Cognos TM1 Applications, you can re-openthe Configuration page by clicking the Administer IBM Cognos TM1

Applications button on the toolbar of the TM1 Applications portal page.6. On the TM1 Applications Configuration page, enter values for the following

Cognos TM1 and Cognos BI parameters:v Enter values in the TM1 Admin Host, Server Name and TM1 Web Client

URL fields. For details, see “Configuring the server and client environmentfor Cognos TM1 Applications” on page 80.

v Set the IBM Cognos Gateway URI parameter to:http://Cognosx_ServerName/cognos_dir/cgi-bin/cognos.cgi

v Set the IBM Cognos Dispatcher URI parameter to:http://Cognosx_ServerName:9300/p2pd/servlet/dispatch

Replace Cognosx_ServerName with the name of the system where the IBMCognos BI Web server is running.

Results

Cognos TM1 Applications is now configured to use both Cognos security and theinstance of Apache Tomcat Web server that is supplied with IBM Cognos.

Configuring Cognos TM1 Applications with Microsoft IISIBM Cognos TM1 Applications uses IBM Cognos TM1 Web and Microsoft InternetInformation Services (IIS) to support the Cognos TM1 Application Web client. TheCognos TM1 Application Web client enables users to view and edit planning

Chapter 17. Advanced configuration 157

Page 170: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

application data in grid format. If you want to allow users to use Cognos TM1Application Web, configure this option in Cognos TM1 Applications.

About this task

When you install Cognos TM1 Web, the required files for the Cognos TM1Application Web client are copied to the Cognos TM1 Web installation location.

The main file for Cognos TM1 Application Web is:

contributor.aspx

The install location is:

TM1_install_location\TM1Web

Configure the Cognos TM1 Application Web URL parameter in Cognos TM1Applications to point to the contributor.aspx file in this location.

Procedure1. Use the Cognos TM1 Application Configuration page to set the Cognos TM1

Web Client URL parameter:v If you are running Cognos TM1 Applications for the first time, use the

Configuration page that opens when you start the program.For more details, see “Configuring the server and client environment forCognos TM1 Applications” on page 80.

v If you are already using Cognos TM1 Applications, you can re-open theConfiguration page by clicking the Administer IBM Cognos TM1

Applications button on the toolbar in Cognos TM1 Applications.2. In the TM1 Web Client URL field, enter the URL location of the

contributor.aspx file.For example:http://WebServer/TM1Web/contributor.aspx

Configuring Cognos TM1 Applications to use Multiple CognosTM1 Servers

When you start IBM Cognos TM1 Applications for the first time, you can enteronly one Cognos TM1 server with which you want to work.

To enter additional servers, use the Cognos TM1 Applications Configuration pageavailable from the Cognos TM1 Applications portal page.

Important: In order to use multiple Cognos TM1 servers in Cognos TM1Applications, they must all use the same security authentication (either CognosTM1 standard authentication or Cognos BI security) and include the sameadministrator user name and password. For details, see “Security considerationsfor Cognos TM1 Applications” on page 35.

After adding multiple Cognos TM1 servers, they are available when you use IBMCognos TM1 Performance Modeler to design your planning applications.

For more details, see the IBM Cognos TM1 Performance Modeler User Guide.

158 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 171: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Log in to Cognos TM1 Applications.2. On the toolbar of the Cognos TM1 Applications portal page, click the

Administer Cognos TM1 Applications button .The IBM Cognos TM1 Applications Configuration page opens

3. In the Server Names section, click Add.The Add Server dialog box opens.

4. Enter values for the following:v Admin Host - Specifies the computer name or IP address of the Admin

Host on which the Cognos TM1 Admin Server is running.v Server Name - Sets the name of the Cognos TM1 server to use with Cognos

TM1 Applications. For example: planning sample.Click the Refresh button to update the Server Name list with the availableservers for the Admin Host you entered.

5. After entering the server information, click OK.The Admin Host and Cognos TM1 server name you entered are added to theServer Names section.

6. To add more servers, click Add and repeat the steps.7. When you are finished adding TM1 servers, click OK on the IBM Cognos TM1

Applications Configuration page.

Results

The Cognos TM1 servers you added can now be used to design your planningapplications.

Font for Cognos TM1 Applications Export to PDFThe font to use for the PDF export in IBM Cognos TM1 Applications can bespecified using the SyncfusionPDFExportFont web.config parameter.

If this parameter is not specified, the system detects the locale the user is in andselects an appropriate font. If the locale is not Chinese or Japanese, Arial is used.Use this setting to override the language used when exporting in Cognos TM1Applications.

Configuring Cognos TM1 TurboIntegrator function security inInsight

When you open an IBM Cognos Insight workspace that has been shared throughIBM Cognos Connection, you may want to restrict the execution of someTurboIntegrator functions, particularly those that can destroy or modify data files.

Several TurboIntegrator functions exist that can write files, delete files, and executecommands. When you receive a shared Insight workspace, it is possible thatTurboIntegrator processes within the workspace could include functions thatperform undesirable actions. To prevent processes from performing potentiallyharmful actions, your Insight installation includes a configuration file namedTMIFunctions.cfg, which can be used to prevent or restrict the execution ofTurboIntegrator functions.

Any TurboIntegrator function can be entirely prevented from executing. TheASCIIOutput, TextOutput, and ASCIIDelete functions can also be configured to run

Chapter 17. Advanced configuration 159

Page 172: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

in restricted mode. When a function runs in restricted mode, it is limited to actingupon files within the TM1 server data directory and its subdirectories.

When you install IBM Cognos Insight, a default version of TM1Functions.cfg iscreated in C:\Documents and Settings\<user>\Application Data\IBM\CognosInsight\bins\bin_xxxx. <user> is the username under which you installed Insightand xxxx is the version of your installation.

The default version of TM1Functions.cfg appears as follows:ExecuteCommand=0AsciiOutput=1TextOutput=1AsciiDelete=1

When a function is set to 0 in TM1Functions.cfg, the function is prevented fromexecuting. Any attempt to execute that function will cause TurboIntegrator tothrow a security exception.

When a function is set to 1 in TM1Functions.cfg, the function runs in restrictedmode. Only the ASCIIOutput, TextOutput, and ASCIIDelete functions can be set torun in restricted mode.

When a function is not present in TM1Functions.cfg, it runs completelyunrestricted.

Examples of functions running in restricted mode

When a function is configured to run in restricted mode, any relative path passedas an argument to the function is assumed to be rooted in the TM1 server datadirectory and is allowed. Any absolute path to a directory above the TM1 serverdata directory prevents the function from executing and causes a securityexception to be thrown at runtime.

For example, assume AsciiDelete=1 in TM1Functions.cfg. In this case, the function

ASCIIDelete('logs\sample.log’);

is allowed and deletes the file sample.log from the logs subdirectory of the TM1server data directory.

However, the function

ASCIIDelete('c:\autoexec.bat’);

will not execute and will cause a security exception, as it specifies a file at the rootlevel of the drive, which is above the TM1 server data directory.

Similarly, assume TextOutput=1 in TM1Functions.cfg. In this case, the function

TextOutput('logs\sample.txt’, 'this is sample text’);

is allowed and writes a string to the sample.txt file in the logs subdirectory of theTM1 server data directory.

Conversely, the function

160 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 173: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

TextOutput('c:\autoexec.bat’, 'del *.* -r –f’);

is not allowed due to the path being specified at the root level of the drive. Thisfunction will cause a security exception to be thrown at runtime.

Editing the TM1Functions.cfg fileThe TM1Functions.cfg file lets you prevent or restrict the execution of potentiallyharmful TurboIntegrator functions contained within a shared IBM Cognos Insightworkspace.

About this task

When you install IBM Cognos Insight, a default version of TM1Functions.cfg iscreated in C:\Documents and Settings\<user>\Application Data\IBM\CognosInsight\bins\bin_xxxx. <user> is the username under which you installed Insightand xxxx is the version of your installation. You can modify this configuration fileto further restrict function execution or allow function execution.

Procedure1. Open TM1Functions.cfg in a text editor.2. To completely prevent a function from executing, set the function name equal

to 0. For example, ExecuteCommand=0 or ServerShutdown=0.3. To allow a function to run in restricted mode, set the function name equal to 1.

For example, AsciiDelete=1. Only the ASCIIOutput, TextOutput, andASCIIDelete functions can be set to run in restricted mode.

4. To allow a function to run unimpeded, delete the function name fromTM1Functions.cfg.

5. Save and close TM1Functions.cfg.

Chapter 17. Advanced configuration 161

Page 174: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

162 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 175: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 18. Security configuration

After you install IBM Cognos TM1, you can configure the specific authenticationand security modes that you want to use.

Authentication security

Authentication or login security configuration includes selecting the type of loginsecurity that will control user access to the different Cognos TM1 components.

Data transmission security

Security configuration includes optionally configuring Cognos TM1 to use SSL forsecure data transmission.

Additional security

Another level of Cognos TM1 security is object security. This type of securityallows you to control access to the specific TM1 objects in your data model, but itis not configured during the initial installation and configuration process.

For more information about the procedures required to set security for CognosTM1 objects, see the IBM Cognos TM1 Developer Guide.

Authentication securityAuthentication or login security configuration includes selecting the type of loginsecurity that will control user access to the different IBM Cognos TM1 components.

Overview to authenticationYou can configure the IBM Cognos TM1 server to use a specific authenticationmode to control user login access.

By default, when you install the Cognos TM1 server it is configured to use thestandard Cognos TM1 authentication.

After you install the Cognos TM1 server, you can change the authenticationmethod by changing the parameters in the TM1 configuration files.

Table 24. Cognos TM1 server authentication methods

Authentication Methods Description

TM1 Authentication Cognos TM1 server asks you for a user name and password,and validates the login information against the security cubelogin information.

Integrated Login Microsoft Windows performs the Cognos TM1 authentication.

LDAP Authentication Cognos TM1 server asks you for a user name and password,and validates the login information against an external LDAPserver.

IBM Cognos Security The Cognos TM1 server authenticates users using IBMCognos security.

© Copyright IBM Corp. 2007, 2012 163

Page 176: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Standard Cognos TM1 authentication overviewWith IBM Cognos TM1 authentication, the Cognos TM1 server checks the username and password against the user names and passwords in the Cognos TM1database.

Integrated Login overviewWith Integrated Login, IBM Cognos TM1 uses the Microsoft Windows networkauthentication to access your Cognos TM1 data. After you log in to your MicrosoftWindows workstation, you can access Cognos TM1 without entering a user nameand password again.

Integrated Login is supported on Microsoft Windows only. You cannot useIntegrated Login to access a UNIX Cognos TM1 server.

Standard TM1 Security

Clients TM1 Server

Attempt to Establish a Connection

Ask for a User Name and Password

Supply a User Name and Password

Establish Connection

TM1 ArchitectTM1 PerspectivesTM1 Web client

Check Nameand Password

TM1 Contributor

Figure 5. Process of authenticating with the IBM Cognos TM1 server

Integrated Login

Clients TM1 Server

(2) Attempt to Establish a TM1 Connection

(3) Return Windows Network Identity

(4) Supply Windows Identity as a Log In request

(5) Establish Connection

TM1 ArchitectTM1 PerspectivesTM1 Web client

Check Name

Windows

User supplies auser name,

password, and

Authentication

Windows domainname while

logging into aWindows

workstation

(1) Windows Login Completed

WindowsDomain

Controller

TM1 Contributor

Figure 6. Process of authenticating by using Integrated Login

164 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 177: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

LDAP Authentication overviewWith LDAP authentication, an LDAP security service that is external to IBMCognos TM1 authenticates a login (as of Cognos TM1 version 8.2.2). You can add,modify, and delete user security information from one location - the LDAP serveror Microsoft Windows Active Directory.

Cognos SecurityThe IBM Cognos TM1 server can authenticate users using IBM Cognos security.

Cognos security is a component of the IBM Cognos framework that manages useraccess to data. Cognos security manages authorization and authentication throughthird-party security providers, such as LDAP or Active Directory. When a user isauthenticated through Cognos security, they are provided with a Cognos security"passport." This passport is then used by Cognos TM1 applications to determinethe user's permissions (role and group membership) and identity.

Security considerations for Cognos TM1 ApplicationsYou can use either IBM Cognos TM1 standard security authentication or IBMCognos security for the Cognos TM1 servers you use with Cognos TM1Applications.

Do not use a combination of different security authentication modes for the sameinstallation of Cognos TM1 Applications.

Determine the security mode before you configure Cognos TM1 Applications touse a Cognos TM1 server and use that same security mode with any additionalservers you add.

For details about using Cognos security, see: “Using Cognos TM1 Applicationswith Cognos Business Intelligence Security” on page 153.

Authentication using LDAP

TM1

(2) TM1 logs into LDAP with a

User Interface

(1) User Supplies name and password

(8) TM1 logs in the userand gives the user accessto objects on the server.

Server

well-known name and password.

(3) LDAP acknowledges asuccessful login using the

(4) Lookup - TM1 passes thename to LDAP

(5) LDAP returns a distinguishedname from its database that

(6) TM1 passes the distinguishedname and the user's password

(7) LDAP acknowledges asuccessful login using the

LDAPServer(ActiveDirectory,Netscape,etc.)

well-known name and password.

corresponds to the user's requested name.

to LDAP.

user-supplied name and password.

Figure 7. Process of authenticating by using LDAP

Chapter 18. Security configuration 165

Page 178: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Using the IntegratedSecurityMode parameter with Cognos TM1Applications

To set the Cognos TM1 security authentication mode use theIntegratedSecurityMode parameter in the Tm1s.cfg file of each Cognos TM1 serveryou want to use.

Important: The Cognos TM1 Applications component is compatible only withCognos TM1 security authentication modes 1 and 5.

For example, to use Cognos TM1 standard security authentication, set theIntegratedSecurityMode parameter to 1 for each server.

IntegratedSecurityMode=1

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

IntegratedSecurityMode=5

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

Configuring Cognos TM1 Applications security for multiple CognosTM1 Servers

If you want to use multiple Cognos TM1 servers with Cognos TM1 Applications,they must all be configured to use the same security authentication (either CognosTM1 standard authentication or Cognos security) and include the sameadministrator user name and password.

For more details, see “Configuring Cognos TM1 Applications to use MultipleCognos TM1 Servers” on page 158.

ETLDAP utilityThe ETLDAP utility enables you to move information from your LDAP(Lightweight Directory Access Protocol) directory to IBM Cognos TM1 .

You can use ETLDAP to add LDAP users to Cognos TM1 when using Cognos TM1with Integrated Login and LDAP authentication.

Note: You can only use the ETLDAP utility to add new LDAP users to CognosTM1 . ETLDAP does not modify, update or delete existing users in Cognos TM1 .

ETLDAP, an LDAP load tool, provides the following functionality:v Extracts user information from an LDAP or Active Directory server.v Creates the element UniqueID in the }ClientProperties dimension.v Adds users to the }ClientProperties cube.v Populates the UniqueID field in the }ClientProperties cube with the

domain-qualified user name of the user you add to IBM Cognos TM1 database.For example, ETLDAP writes the name [email protected] to the}ClientProperties cube.

As the Cognos TM1 administrator, you can perform these tasks using ETLDAP:

166 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 179: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Add many user names from an LDAP server to the Cognos TM1 databasequickly.

v Migrate information from a legacy LDAP database to Cognos TM1 .v Perform one or more queries to specify the users you want to create in Cognos

TM1 , and then export the users into the Cognos TM1 security cubes.v Update Cognos TM1 with new users that have been added to the LDAP server

since the initial load of user data into Cognos TM1 .

Note: The ETLDAP utility is not available when the Cognos TM1 server isconfigured to use IBM Cognos Access Manager (CAM) authentication.

Modifying LDAP attributesThe value of an attribute you retrieve from an LDAP directory may not preciselymatch what you want to enter in the IBM Cognos TM1 security cube.

If so, you must modify certain LDAP attributes before you can run ETLDAP.

For example, you could combine all users from the R&D, Quality Assurance, andDocumentation LDAP groups into a single Cognos TM1 group named Engineering.To support these requirements, you can extend a Java class with a single methodyou need to override.

The stringFilter class contains one method with the following signature:String filterString(String attrName, String value)

At run time, this method is passed the name of each LDAP attribute that matchesa mapping entry and its value. The String it returns is added to the Cognos TM1database.

The following code demonstrates the implementation of the stringFilter class,combining all users from the R&D, Quality Assurance, and Documentation LDAPgroups into a single Cognos TM1 group named Engineering.

The stringFilter class looks for instances of the LDAP 'ou' attribute, which is theCognos TM1 Group names field. If the value is 'R&D', 'Quality Assurance', or'Documentation', it returns 'Engineering'. The users from any of the 3 LDAPgroups is added to a single Cognos TM1 'Engineering' group. Any other groupvalue remains unchanged.// The stringFilter class provides the abilityto transformstrings

// which are read from the LDAP database before theyare inserted into // TM1’s datastore.

// To implement this feature, create a class which extendsstringFilter

// and contains a method ’filterString’ with the followingsignature:

//

// String filterString(String attrName, String value)

//

//

public class myStringFilter extends stringFilter

{

public String filterString(String attrName, String value)

Chapter 18. Security configuration 167

Page 180: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

{

if (attrName.equals("ou"))

{

if ( (attrName.equals("R&D")) ||

(attrName.equals("Quality Assurance")) ||

(attrName.equals("Documentation")) )

return "Engineering";

else

return value;

}

else

return value;

}

}

After you write and compile the Java code, put the class somewhere in yourClasspath. Then click Edit > Options and enter its name in the Class Name field.

Running ETLDAPYou can run ETLDAP from the Microsoft Windows operating system or the DOScommand window with command-line parameters.

Procedure1. If you want to run ETLDAP from the Microsoft Windows operating system,

complete the following actions:v Click Start > Programs > IBM Cognos > TM1 > Administration > ETLDAP.v Set the elements that you require.

Table 25. Elements in the LDAP Load Tool dialog box.

Field or Button Description

Search DNDisplays the LDAP node at which the search originates.ETLDAP does not search for entries above this level in thetree.

FilterDisplays the query string that filters the entries in thedirectory and generates the matching records.

AttributesDisplays the attribute values for LDAP entries that assist invalidating the records returned by the search. When youexport the LDAP information to TM1 , ETLDAP retrieve theattributes required to create valid TM1 users.

Note: The attributes are for display purposes only.

Search ScopeSpecifies the starting point of the search, and the search level.Select One level to specify all entries one level below the baseSearch DN, but not the base DN itself. Select Sub-tree levelto search all entries beneath the base DN, including the baseDN.

168 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 181: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 25. Elements in the LDAP Load Tool dialog box. (continued)

Field or Button Description

Results TableDisplays the search results. Click the column headers to sortthe data, or right-click in a row and click View Entry toexamine all attributes for that entry.

Search ButtonPerforms the search using the parameters you select.

Export ButtonExports the displayed set of users to TM1 based on thesettings in the Options dialog box.

2. If you want to run ETLDAP from the DOS command window, complete thefollowing actions:v Click Start > Programs > Accessories >Command Prompt.v Enter the following command line:

java etldap options

v Add the parameters that you require.

Table 26. Supported command-line parameters

Parameter Description

-f filename Passes the name of a saved session file to load allconfiguration settings from a previous session.

When you run ETLDAP in unattended (batch) mode, youmust include a name for the session save file. If this file doesnot contain the passwords necessary to connect to the LDAPand Cognos TM1 server , an error message is written to thelog file and the session is terminated.

-batch Runs ETLDAP in command-line mode with no user interface.Requires the -f option.

-secure When you run ETLDAP in batch mode, passing this flagremoves all passwords from the session file referenced by the-f flag after they have been read.

This parameter reads the save file at the beginning of thesession, and then re-writes the file with the passwordsremoved. While in use, you would run ETLDAP and specifythe passwords with the user interface. Then you would exitETLDAP and run the command line version specifying the'-secure' option. This would insure that the passwords wereonly available for the short period of time it takes for theutility to initialize.

-help Displays online Help for these command-line parameters.

Configuring the LDAP login parametersYou can configure the LDAP login parameters.

Chapter 18. Security configuration 169

Page 182: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. In the LDAP Load Tool dialog box, click File > Connect.2. Enter the following host and user information.

Panel Field Description

Host Info HostEnter the host name or IPaddress of the machinewhere the LDAP server isrunning.

PortThe port on which the LDAPserver is running. If a port isnot specified, 636 is used.Cognos TM1 attempts tobind to an LDAP server onthe specified secure port. Ifyou do not enter anLDAPPort value, CognosTM1 uses the default valueof port 636

VersionETLDAP will most likelyignore the version number.Most LDAP servers supportversion 2 or version 3 typeconnections, ETLDAP doesuse any functionality specificto either version.

SSL optionDetermines whether thecommunication between theLDAP server and ETLDAPhappens over a secureencrypted channel. Unlessyou are viewing secureinformation over an insecurenetwork, leave this optionturned off.

Anonymous optionMost LDAP servers havesome layer of securityconfiguration that requiresyou to authenticate as aknown user. In somesystems, anonymous userscan browse the directory, butnot retrieve the schema. Inother systems, ananonymous user might haveaccess to certain insecureareas of the directory, but notothers.

170 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 183: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Panel Field Description

User Info User DSNIn many cases, your LDAPdirectory preventsAnonymous users fromaccessing or modifying data.In this case, you may need aDistinguished Name (DN)and password to completethe extraction of your LDAPsecurity information.

For example, the name NormLodin might refer to aperson who works atBlodget, Inc. Inside LDAP, hehas a Distinguished Namethat uniquely distinguisheshim from all other entities inthe network.

Norm might enter thefollowing information in theUser Info field.

uid=nlodin, ou=People,o=Blodget.com

PasswordEnter a password thatcorresponds to the User DN.

3. To see if the connection is successful, click Test.4. Click OK.

You have established a connection to your LDAP server with the parametersyou specified.

Building an LDAP queryUse an LDAP query to add LDAP users and groups to IBM Cognos TM1.

Before you begin

An LDAP query consists of the following major elements:v Search DN - An LDAP directory is organized as a tree structure, with a root

node and a number of branches off this root. The Search DN specifies at whichnode the search originates. Entries above this level in the tree are searched. Youmust specify the correct base DN to obtain the results you want.

v Filter - A query string that filters the entries in the LDAP directory andgenerates the matching records. You can create complex filters by using acombination of the following symbols:& (AND)| (OR)! (NOT)* wildcard character( ) parentheses for nesting

Chapter 18. Security configuration 171

Page 184: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

For instructions on building LDAP filter strings, refer to LDAP books and onlineresources, including the LDAP standard, RFC 2254, The String Representation ofLDAP Search Filters.

v Scope - While the Search DN specifies the starting point of the search, the Scopeattribute indicate the level of depth to which the search occurs. There are twoScope levels:One Level - Specifies that LDAP search all entries one level below the base DN,but does not include the base DN itself.Sub-Tree Level - Indicates that LDAP search all records at all levels includingthe base DN.The following diagram illustrates the effect that the Scope setting has on asearch.

v Attributes - Describe every LDAP entry and their values. Includes acomma-separated list of values to return for the records that match the filterstring. There are two LDAP attributes:User attribute - You add this attribute to the LDAP directory. For example, cn ormail.Operational attribute - The LDAP server creates and maintains this attribute.For example, numSubordinates.The attributes for an entry could include:Present with no valuePresent with one or more valuesNot present. If an attribute is optional, the attribute may not exist for an entry.

Note: Be sure to request only the attributes you need. If you request allattributes, a large result set can significantly increase processing time on theLDAP server and memory requirements on both the server and the client.

Procedure1. Specify the Search DN, Filter String, Attributes, and Scope for your query.2. Click Search.

You see a list of entries in the table, unless there are syntax errors or if the filterstring does not match any records in the directory.

3. Examine the result set.

Search base: o=Applix.com

o: Applix.com

cn: Rob Smithuid: rsmith cn: Jill Benson

uid: jbenson

Scope: One

Scope: Sub

Figure 8. Effect that the Scope setting has on a search

172 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 185: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Does it include names that you do not want to see?v Are important entries missing?v Do you need to build multiple queries to capture the list of records you are

interested in?4. Make your changes to the filter string.5. Click Search.6. Examine the result set.7. Repeat steps 3 through 6 until you have a list of valuable records.8. Click File, Save As to save your LDAP query as a text file.

Note: You can use the saved LDAP query at a later time. To do so, click File >Open in the LDAP Load Tool dialog box. ETLDAP fills in the DN, Filter String,Attributes, and Scope for your LDAP query.

Connecting to the Cognos TM1 ServerFollow these steps to connect to the IBM Cognos TM1 server .

Procedure1. Click Edit > Login > TM1.2. Enter the following server information:

Field Description

HostThe machine name of the server on which your TM1 AdminServer is running.

SSL portEnter the port number configure which the admin server willuse. The default is 5498

ServerThe name of the TM1 server to which you want to connect.

Click Server and then the Browse button to select a serverfrom the Server list.

UsernameThe name of a user with Admin privileges on the target TM1server.

PasswordThe password of the admin user.

3. To see if the connection is successful, click Test.4. Click OK.

Mapping LDAP attributes to Cognos TM1 fieldsLDAP directories contain many attributes, some of which you standardize, andothers which you add or customize for your environment. You must specify therelationship between the LDAP attributes and the required IBM Cognos TM1 fieldsmanually.

Before you begin

You should be familiar with your LDAP schema.

Chapter 18. Security configuration 173

Page 186: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Click Edit > Mapping > TM1.2. For each required (red) Cognos TM1 field, select an LDAP schema attribute.

For each user, Cognos TM1 requires a unique name and group name. Forexample, you could map the name attribute in your LDAP schema to theCognos TM1 user, and map the department attribute to the Cognos TM1 group.

3. Click OK.

Specifying the ETLDAP export optionsYou can specify the ETLDAP export options.

Procedure1. Click Edit > Options.2. Select Enable Integrated Login.3. Enter the realm name that contains the users you want to transfer.4. Clear Save Passwords.

When you clear Save Passwords, ETLDAP removes all passwords necessary toconnect to the servers before the session save file is written. The next time yourun ETLDAP, you would have to enter the passwords again.

5. Set Maximum Search Results and Search Time Limit to 0.6. Click OK.

Exporting LDAP information to Cognos TM1You can export LDAP information to IBM Cognos TM1 .

Procedure1. Click Export.

ETLDAP moves the records you retrieved from the LDAP directory into TM1 ,and logs the data export activity in a log file.

Note: You can open the log before you export records to track the exportprogress.

2. Click View, Log to open the Session Log.The Session Log shows a summary of the LDAP users that ETLDAP exportedand created in Cognos TM1 . ETLDAP randomly generates the Cognos TM1user passwords and adds them to the Cognos TM1 database.

Note: If you use Integrated Login, Cognos TM1 users do not use the CognosTM1 passwords, and you do not have to coordinate passwords betweenCognos TM1 and Microsoft Windows. If you do not use Integrated Login,Cognos TM1 users must change their password during their first login session.For details, see “Integrated Login” on page 176.

Running ETLDAP in Update mode to add new LDAP usersYou can run ETLDAP in Update mode to update IBM Cognos TM1 with newLDAP users that do not already exist in Cognos TM1 . To do this, you specify adate in the Filter section of your LDAP query.

About this task

When you run ETLDAP the first time, you must retrieve all records from theLDAP server that meet your organizational requirements. You define these

174 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 187: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

requirements using the Filter parameter. After you retrieve all user and grouprecords, you load them into the IBM Cognos TM1 database.

After using ETLDAP to initially load LDAP users into Cognos TM1 , you can thenonly use the tool to retrieve and add new LDAP users that do not already exist inCognos TM1 . You cannot use the ETLDAP utility to update or delete existingusers in Cognos TM1 based on changes in the LDAP directory.

As new users are added to your LDAP server, you can add them to Cognos TM1by specifying a date in the Filter section of your LDAP query. Using a date in theFilter section runs ETLDAP in Update mode. You can edit your LDAP Filter toselect only new user records that meet your original search requirements since thelast time you ran ETLDAP.

Note: Running ETLDAP in Update mode only adds new LDAP users that do notalready exist in Cognos TM1 . ETLDAP does not update user attributes or deleteexisting Cognos TM1 users.

Procedure1. Determine the last modified record attribute to specify a date in the Filter

section of your LDAP query.All LDAP servers support a last modified record attribute, which includes thesetimestamp attributes:v Standard LDAP - modifytimestampv Microsoft Active Directory - whenChangedDuring an export session, ETLDAP examines all records as it processes themand stores the date of the most recently changed record in the Session Log file,as shown in the following sample:newest record modified: Thu Jan 23 07:00:42 EST 2003(20030123070042.0Z)

2. Locate the newest record line in the LDAP Session Log.3. Copy the timestamp portion of the string in parentheses from the LDAP

Session Log into the Filter section of your LDAP query.Important: Be sure to adhere to the syntax supported by LDAP Filters. Formore information, see the Internet standards protocol document, RFC 2254, TheString Representation of LDAP Search Filters.

The following table shows a sample Filter string without any changes, and aftermodification for both LDAP and Active Directory servers.v A standard LDAP server uses the modifytimestamp attribute.v An LDAP server with Microsoft Active Directory uses the whenChanged

attribute.

Sample Filter String Filter String After Modification

Initial string(&(objectclass=person)(|(department=R&D)

(department=Documentation)))

Modified for standard LDAP(&(objectclass=person)(modifytimestamp>

=20030515162433Z)(|(department=R&D*)

(department=QA)))

Modified for Active Directory(&(objectclass=person)(whenChanged>

=20030515162433.0Z)(|(department=R&D*)

(department=QA)))

Chapter 18. Security configuration 175

Page 188: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

4. After you make the necessary changes to the Filter line, save the session datawith a name that clearly identifies it as an incremental update query.

5. Run ETLDAP using the new session data.

Integrated LoginIntegrated Login enables you to use Microsoft Windows network authentication tocontrol access to IBM Cognos TM1 data.

In this security model, you can use the ETLDAP utility (see Running ETLDAP) orother steps to move user and group Microsoft Windows login information into theCognos TM1 database. Users who want to access Cognos TM1 data throughCognos TM1 clients must log in to Microsoft Windows first. After they successfullylog in to Microsoft Windows, Cognos TM1 does not ask for log in information.

Integrated Login matches the domain-qualified name you use to log in to MicrosoftWindows with a name in the UniqueID field of the }ClientProperties cube. If thereis a match, Cognos TM1 allows you to log in.

As an example, suppose you log in with the user name Robert into the domaincompany.com. When you double-click a server in Server Explorer, Cognos TM1looks in the }ClientProperties cube and examines the UniqueID field of that cube.Robert has a domain-qualified name of robert@company. As long as Robert logs into the COMPANY domain with the name Robert, Integrated Login should work forthis user.

If Integrated Login cannot match the domain-qualified name you use to log in toMicrosoft Windows with a name in the UniqueID field of the }ClientPropertiescube, Cognos TM1 displays an error message saying that the client name does notexist on the server.

Integrated Login is supported on Microsoft Windows only. You cannot useIntegrated Login to access a UNIX version of the Cognos TM1 server .

Configuring Cognos TM1 to use Integrated LoginUse the following checklist as an overall guide to configure IBM Cognos TM1components to use Integrated Login as the login authentication method for allusers.

Checklist

1. Complete the installation of the Cognos TM1 server and make sure you areable to run and log in to it.

2. Run the ETLDAP Utility to extract the user and group login data from yourLDAP directory and load that data into the TM1 security cube. ETLDAP createsCognos TM1 users from the LDAP data that you specify. These users aremembers of the same group to which they were assigned in your LDAPdirectory.For details, see “Running ETLDAP” on page 168.

3. Configure the Cognos TM1 server and client components to use IntegratedLogin.

176 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 189: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 27. Summary of Integrated Login configuration for Cognos TM1 components

Component Required Configuration

Cognos TM1 Server Configure the Integrated Login parameters in theTm1s.cfg file for any TM1 database that you wantto use with Integrated Login.

For details, see “Configuring Integrated Login forthe Cognos TM1 server” on page 178

Cognos TM1 Clients Enable the Use Integrated Login option for CognosTM1 Architect and Cognos TM1 Perspectives .

For details, see “Configuring Cognos TM1Perspectives to use Integrated Login” on page 182and “Configuring Cognos TM1 Architect to useIntegrated Login” on page 182

Cognos TM1 Web Configure the following settings for Cognos TM1Web:

v Web.config file: Configure parameters in theWeb.config file that enable Integrated Login forCognos TM1 Server Web.

v Folder Security: Configure user security for theCognos TM1 Server Web folders on the webserver.

v Microsoft IIS: Configure Microsoft InternetInformation Services (IIS) to use IntegratedWindows authentication.

Note: You may also need to manually verifyand/or configure your NTLM or Kerberos securitysettings.

For details, see “Configuring Integrated Login forCognos TM1 Web using NTLM” on page 180

4. Set the access rights for Cognos TM1 users.For details, see “Configuring access rights for Cognos TM1 users.”

Configuring access rights for Cognos TM1 usersFor an IBM Cognos TM1 user to access any data, you might have to assign thatuser to other Cognos TM1 groups. This topic explains how to add a user to theAdmin group.

For example, for a user to publish public objects to the Web through Cognos TM1Web, the user must be a member of the Cognos TM1 Admin group.

Procedure1. Start Cognos TM1 Architect.2. Click File > Options.3. Clear the Use Integrated Login option.4. Click OK.5. In the Tree pane of Server Explorer, double-click TM1 to open the list of

servers.6. Double-click a server name.7. Log in using your administrator login ID and password.

v Administrator name (default) - admin

Chapter 18. Security configuration 177

Page 190: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Administrator password (default) - apple8. Right-click the server name, and click Security > Clients and Groups.9. Select a user to add to the admin group. Use the scroll bar to scroll to the left,

where the list of groups displays.10. To add the user to the Admin group, select the check box in the ADMIN

column for that user.11. Click OK.

Configuring Integrated Login for the Cognos TM1 serverYou can modify an IBM Cognos TM1 installation to use Integrated Login withoutre-installing Cognos TM1 . To do so, run ETLDAP and modify several Cognos TM1configuration files.

Procedure1. Run ETLDAP and import the user and group information from your LDAP

server, as described in “Running ETLDAP” on page 168.2. Shut down the Cognos TM1 server .3. Edit the following parameters in the Tm1s.cfg file located in your Cognos TM1

server data directory:v Set the IntegratedSecurityMode parameter to 2.v Set the SecurityPackageName parameter to the security protocol you use for

Integrated Login, such as Kerberos (default) or NTLM.In the following example, the server is configured to use Kerberos.[TM1S]

SecurityLogging=F

SecurityPackagename=Kerberos

IntegratedSecurityMode=2

Servername=myserver

DatabaseDirectory=C:\Program Files\

4. Save and exit Tm1s.cfg.5. Restart the Cognos TM1 server.6. Configure the different Cognos TM1 clients to use Integrated Login by setting

the Use Integrated Login option in the associated user interface.v “Configuring Cognos TM1 Architect to use Integrated Login” on page 182.v “Configuring Cognos TM1 Perspectives to use Integrated Login” on page

182.

Results

You can now log in to your Cognos TM1 server using Integrated Login throughCognos TM1 Architect or Cognos TM1 Perspectives .

For information on configuring Integrated Login for Cognos TM1 Web, see“Configuring Integrated Login for Cognos TM1 Web using NTLM” on page 180.

Configuring Integrated Login for Cognos TM1 Web usingKerberosYou can set up IBM Cognos TM1 Web to use Integrated Login with the Kerberossecurity protocol.

178 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 191: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

About this task

If you use the Kerberos security protocol, you can configure your Web server touse either a system account or domain user account, according to your preference.

In all cases, you must verify that Cognos TM1 Web is correctly configured to useIntegrated Login. To verify this, make sure the system.web section of the CognosTM1 Web Web.config file includes the following line for the authenticationparameter.

<authentication mode="Windows" />

Procedure1. To determine if your web server is running in IIS 5.0 Isolation Mode, complete

the following actions:a. Run Computer Management.b. Right-click Web Sites and choose Properties.If the Run WWW service in IIS 5.0 isolation mode check box is selected, youare running your web server in IIS 5 isolation mode.

2. Set your web server to run the Kerberos security protocol on the web server bycompleting the following actions:a. Open a command prompt.b. Migrate to the inetpub/AdminScripts directory.c. Run the following command to set the security protocol to Kerberos:

cscript adsutil.vbs set w3svc/1/NTAuthenticationProviders

"Negotiate,NTLM"

The Negotiate,NTLM parameter forces the Web server to try to use Kerberosfirst. If Kerberos fails, the web server will use NTLM. Be careful not to leavea blank before NTLM.

3. Grant the web server machine account delegation rights by running the ActiveDirectory Users and Computers control panel from the network's domaincontroller and assigning delegation rights to the TM1 service account.There is a secure form of delegation called Constrained Delegation. WithConstrained Delegation, you can configure the Microsoft Active Directoryservice to restrict the services and servers that your ASP.NET application canaccess with the impersonated identity. Constrained Delegation requiresKerberos authentication. You can set the system to delegate. Refer to yourMicrosoft Windows documentation for more information.

4. To add the Cognos TM1 service account to the machine.config file on your webserver, complete the following actions:a. Edit machine.config on your web server. The machine.config file is located

in the following location:C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG

b. Locate the processModel Attributes section.password="AutoGenerate"

c. Change the userName and password fields to the domain-qualified nameand password of the Cognos TM1 service account.

d. Save the file and exit the editor.e. Restart the IIS admin service.

Chapter 18. Security configuration 179

Page 192: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

5. To create a new application pool for your Cognos TM1 Web virtual directory,complete the following actions:a. Right-click Application Pools and click New, Application Pool.b. Enter TM1 Web for the Application Pool ID.c. Choose Use Default settings for new application pool, and click OK.

Note: If you create an application pool for Cognos TM1 Web and thenuninstall, that application pool is not deleted. If you later reinstall and selectintegrated login during the custom install, the Cognos TM1 Web virtualdirectory is reset to the default application pool, not to Cognos TM1 Web.

6. To set the application pool to use the network identity under which you runthe Cognos TM1 services, complete the following actions:a. Right-click the Cognos TM1 Web application pool and click Properties >

Identity.b. Click Configurable.c. Enter the same domain user and password that are used by the Cognos

TM1 services.d. Click OK.

7. The Cognos TM1 domain user must belong to the IIS_WPG group on the webserver. To add the domain user to the group, complete the following actions:a. Run the Computer Management administration tool.b. Navigate to the Groups folder under System Tools > Local Users and

Groups > Groups.c. Right-click the group IIS_WPG and click Add to Group.d. Click Add and add the domain-qualified name to the IIS_WPG group. Use

the same name used by your Cognos TM1 services.8. To set the application pool for your Cognos TM1 Web virtual directory,

complete the following actions:a. Run the IIS Manager.b. Right-click the TM1 Web virtual directory and choose Properties.c. Set the Application Pool option to TM1 Web.

9. To set the service principal name (SPN), complete the following actions:a. Download the SetSPN.exe utility from the Microsoft web site.b. As a domain administrator, execute the following commands:

setspn -A HTTP/web_server_name domain_name\user_acct_for_TM1_services

setspn -A HTTP/webservername.domain_name domain_name\user_acct_for_TM1_services

Configuring Integrated Login for Cognos TM1 Web using NTLMManually configure IBM Cognos TM1 Web to use Integrated Login by editing theconfiguration parameters in the web configuration file, configuring MicrosoftInternet Information Services (IIS), and configuring folder security.

Procedure1. To edit the configuration parameters, complete the following actions:

a. Open the Web.config file for Cognos TM1 Web.This file is typically located in C:\Program Files\IBM\cognos\tm1\TM1Web.

b. Locate the <appSettings> section and edit the following parameter asfollows:<add key="IntegratedLogin" value="true" />

180 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 193: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

c. Locate the authentication settings under the <system.web> section and editthe following parameters as follows:<authentication mode=" Windows "/>

<identity impersonate="true"/>

d. Save and close the Web.config file.2. To configure Microsoft Internet Information Services (IIS) for it to work with

Integrated Login, make sure that IIS is configured to use Integrated Windowsauthentication.This option is enabled by default in IIS. For more information, see the MicrosoftIIS documentation.

3. Verify that the NTLM Windows service is running. Make sure that the NTLMSecurity Support Provider service is available and running as a Windowsservice.

4. To configure the SecurityPackageName parameter in the TM1s.cfg file, completethese actions:a. Shut down your Cognos TM1 server.b. Open TM1s.cfg in a text editor.c. Enter the SecurityPackageName parameter.d. Save TM1s.cfg.e. Restart your Cognos TM1 server.

5. To configure security for the IIS folders, complete the following actions:a. On the Web server running Cognos TM1 Web, use Microsoft Windows

Explorer to locate the IIS folders for Cognos TM1 Web.The default location is: C:\Program Files\IBM\cognos\tm1\TM1Web.

b. Right-click each of the following folders, click Properties, click the Securitytab, and ensure that the group Authenticated Users has permission set toFull Control.v TM1Web\css

v TM1Web\images

v TM1Web\scripts

v TM1Web\TempCharts

v TM1WebEx\ExcelSheet

v TM1WebEx\UserTempDir

c. Restart IIS.

Configuring web browsers for Integrated LoginAfter configuring IBM Cognos TM1 Web with Integrated Login, you must thenconfigure the Web browsers on the client systems that will access Cognos TM1Web.

Procedure1. If you are using Microsoft Internet Explorer, specify that the Cognos TM1 Web

URL is a trusted site.For example, enable the Automatic logon with current username and passwordoption and the Enable Integrated Windows Authentication option in InternetExplorer.For more information, see your Microsoft Internet Explorer documentation.

Chapter 18. Security configuration 181

Page 194: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

2. If you are using Mozilla Firefox, locate and edit the following preferences sothey include a comma separated list of URL prefixes or domains for thelocation of your TM1 Web server.network.automatic-ntlm-auth.trusted-uris

network.negotiate-auth.delegation-uris

network.negotiate-auth.trusted-uris

For example, enter localhost if you are running Cognos TM1 Web locally orenter the server name if you are running Cognos TM1 Web on a dedicated webserver.For more information, see your Mozilla Firefox documentation.

Configuring Cognos TM1 Architect to use Integrated LoginAfter you set up Integrated Login for the IBM Cognos TM1 server , you can use itto access your Cognos TM1 data through Cognos TM1 Architect .

Procedure1. Run Cognos TM1 Architect.2. Click File > Options.3. Verify that the Use Integrated Login check box is selected.4. Click OK.5. In the Tree pane of the Server Explorer, double-click to open the list of servers.6. Double-click the server into which you exported your LDAP user and group

information.You should be logged in without being prompted to enter a user name orpassword.

Configuring Cognos TM1 Perspectives to use Integrated LoginAfter you set up Integrated Login for the IBM Cognos TM1 server , you can use itto access your Cognos TM1 data through Cognos TM1 Perspectives . TM1Architect

Procedure1. Run Microsoft Excel.2. Click TM1 , Server Explorer.

The TM1 Server Explorer displays.3. Click File > Options.4. Verify that the Use Integrated Login check box is selected.5. Click OK.6. In the Tree pane of the Server Explorer, double-click to open the list of servers.7. Double-click the server into which you exported your LDAP user and group

information.TM1 Perspectives should automatically log you in to Cognos TM1 withoutasking for a user name or password.

Logging into Cognos TM1 Web with Integrated LoginAfter you configure a IBM Cognos TM1 server and Cognos TM1 Web to useIntegrated Login, you can use this authentication mode to log in and access yourdata through Cognos TM1 Web.

182 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 195: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Run Microsoft Internet Explorer.2. Enter the following URL in the browser Address box:

http:// Web Server Name / Virtual Directory Name /TM1WebLogin.aspx

3. Enter the Cognos TM1 server Admin Server host name in the Admin Hostfield.

4. Click Server arrow.5. Click Login.

LDAP AuthenticationYou can set up IBM Cognos TM1 authentication using an LDAP server.

Validating users with an LDAP serverLDAP validation allows you to centralize all of your user passwords in an externalLDAP server.

When your IBM Cognos TM1 users log in, the user name and password theyprovide is validated against the information held in your LDAP server. You canspecify a password and key to use before the server connects for LDAPauthentication, or the server can directly connect without the use of a password.

As a prerequisite to setting up LDAP authentication, you must have significantknowledge of LDAP and its role in your network security structure. If you are notthe LDAP administrator for your network, consult with your LDAP administratorto properly set up Cognos TM1 to use LDAP authentication.

Note: Your LDAP server must be configured to use SSL to successfullycommunicate with Cognos TM1 .

LDAP authentication parametersUse the following parameters in the Tm1s.cfg file to configure and support LDAPauthentication.

PasswordSource:

Compares user-entered password to the stored password.

Parameter type: optional, static

Cognos TM1 (Default): Compares the user-entered password to the password inthe Cognos TM1 database.

LDAP: Compares the user-entered password to the password stored in on theLDAP server.

LDAPPort:

IBM Cognos TM1 attempts to bind to an LDAP server on the specified secure port,port 636.

This must be a secure (SSL) port.

If you do not enter an LDAPPort value, Cognos TM1 uses the default value, port636.

Chapter 18. Security configuration 183

Page 196: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

LDAPHost:

Uses the domain name or dotted string representation of the IP address of theLDAP server host.

If you do not enter a value for LDAPHost, IBM Cognos TM1 uses the defaultvalue, localhost.

LDAPWellKnownUserName:

The IBM Cognos TM1 server uses the well-known user name to log in to LDAPand look up the name submitted by the user.

An LDAP distinguished name.

For example:uid=bjensen,ou=people,o=company.com

This is a required parameter when the LDAPUseServerAccount parameter is set toFalse.

LDAPSearchBase:

Specifies the node in the LDAP tree where IBM Cognos TM1 begins searching forvalid users.

A base distinguished name (DN) in the LDAP directory. For example:ou=people,o=company.com

For example, if the distinguished names are of the form:uid-bjensen, ou-people, o=company.com

then the search base would be:ou-people, o=company.com

This is a required field.

LDAPSearchField:

The name of the LDAP attribute that is expected to contain the name of the IBMCognos TM1 user being validated.

If you do not enter an LDAPSearchField value, the default value is cn, which isalso the default value for Microsoft Active Directory.

LDAPUseServerAccount:

Determines if a password is required to connect to the server when using LDAPauthentication.

Parameter type: optional, staticv To connect directly to the LDAP server using integrated authentication, set this

parameter to T. Set this parameter to T whenever the IBM Cognos TM1 serverand LDAP server exist on the same domain.

184 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 197: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v To use a password before connecting, set this parameter to F. WhenLDAPUseServerAccount is set to F, you must also set the “LDAPPasswordFile”and “LDAPPasswordKeyFile” to successfully connect to the LDAP server usingSSL.

LDAPPasswordFile:

Defines the password file used when LDAPUseServerAccount is not used. This isthe full path of the .dat file that contains the encrypted password for the IBMCognos TM1 server Admin Server's private key.

Parameter type: optional unless “LDAPUseServerAccount” on page 184=F, static

This parameter uses the full path to a .dat file.

LDAPPasswordKeyFile:

Defines the password key used when LDAPUseServerAccount is not used.

Parameter type: optional unless “LDAPUseServerAccount” on page 184=F, static

This parameter uses the full path of the .dat file that contains the key used toencrypt and decrypt the password for the private key.

This file must be generated using the tm1crypt utility, as described in “Runningthe TM1Crypt utility” on page 205.

Configuring LDAP validationTo configure LDAP validation, you will change the password in the TM1s.cfg fileso that you can then import names from your LDAP directory and modify groupassignments for new users. Then change the password back to the LDAPcredentials.

Before you begin

To configure LDAP validation, you need the following information:v A name that the Cognos TM1 server can use to log in to LDAP. You can test the

validity of this name using ETLDAP.v The SSL port on which your LDAP server is running. The default is 636.v The name or IP address of the LDAP server you want to use for validation.

Procedure1. To use your Cognos TM1 credentials to log in, change the password parameter

in TM1s.cfg by completing these actions:a. Edit TM1s.cfg in your IBM Cognos TM1 server data directory.b. Modify PasswordSource=LDAP to read PasswordSource=TM1

c. Save and exit TM1s.cfg.d. Recycle your Cognos TM1 server.

2. To import names from your LDAP directory into Cognos TM1 , complete theseactions:a. Use the procedure described in “ETLDAP utility” on page 166.b. Use the following Cognos TM1 login information:

v Admin user (default) - Admin

Chapter 18. Security configuration 185

Page 198: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Admin password (default) - appleUse the user that you specified during the installation to log in to LDAP.

3. To modify group assignments for new users, complete the following actions:a. Log in to Cognos TM1 as an administrator.b. Right-click the server name in Server Explorer and click Security, Clients

and Groups.c. Modify the groups assignments for your new users as required.

For each Cognos TM1 user ETLDAP added to your database, you mustassign that user to the same group they belong to in the LDAP directory.For example, if NadiaC is a member of the group gymnasts in your LDAPdirectory, ETLDAP creates the user Nadiac, and creates the group gymnastswithin Cognos TM1 . Nadiac displays in the Clients/groups dialog box as amember of gymnasts.

4. To change the password back to the LDAP credentials, complete these actions:a. Edit TM1s.cfg in your IBM Cognos TM1 server data directory.b. Modify PasswordSource=TM1 to read PasswordSource=LDAP

c. Define the connection status:v To directly connect to the server, add the following line:

LDAPUseServerAccount=T

v To use a password before connecting to the server, add the followinglines:LDAPPasswordFile= file

LDAPPasswordKey= key

d. Save and exit TM1s.cfg file.e. Recycle your Cognos TM1 server.

You should now be able to log in to Cognos TM1 with a name that youadded from your LDAP directory.

Using Cognos security with Cognos TM1You can use IBM Cognos security with IBM Cognos TM1 .

For complete details on Cognos security concepts, terminology, andimplementation, see the Cognos Administration and Security Guide.

Overview to Cognos securityThe IBM Cognos TM1 server can authenticate users using IBM Cognos security.

Cognos security is a component of the IBM Cognos framework that manages useraccess to data. Cognos security manages authorization and authentication throughthird-party security providers, such as LDAP or Active Directory. When a user isauthenticated through Cognos security, they are provided with a Cognos security"passport." This passport is then used by Cognos TM1 applications to determinethe user's permissions (role and group membership) and identity.

When using Cognos security, a Cognos passport is required to connect to CognosTM1 . A user is presented with a logon screen requiring a namespace, a user name,and a password when first logging in to Cognos TM1 or any other Cognossecurity-enabled components. Once authenticated by Cognos security, a passport isissued to the user. This passport automatically provides the user's credentials whenaccessing any other Cognos security-enabled application (including Cognos TM1 ).Once a user connects to the Cognos TM1 server via a specific Cognos server that

186 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 199: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

has been configured for common logon, no direct user input is required to accessadditional Cognos TM1 servers (or other Cognos applications) that are configuredto reference the same Cognos server.

When a user attempts to access the Cognos TM1 server, the server validates thepassport to authenticate the user. This is done by querying a Cognos server for theidentity of the passport. If the passport is valid, the query returns a collection ofsecurity and authentication information for the user. This information contains theroles and groups that the user has membership to, as well as the account (username) associated with the passport. If the user name already exists in Cognos TM1, their existing membership will be validated against the existing Cognos TM1groups. If the user does not exist, they are added and assigned to the appropriateuser groups on the Cognos TM1 server.

After connecting to CAM, two new folders are created in the installdirdirectory:configuration directory has epC8ITK.ini file and the Logs directory hasmultiple epC8ITK_2008-03-13.log.v the configuration directory has epC8ITK.ini

v Logs directory has multiple epC8ITK_<datestamp>.log

Anonymous access and the Cognos TM1 serverTo successfully set configuration settings and procedures to enable IBM Cognossecurity authentication on the IBM Cognos TM1 server, your Cognos server mustnot be configured to allow anonymous access. If anonymous access is enabled onthe Cognos server, you cannot logon to a namespace from Cognos TM1 whenimporting Cognos groups into Cognos TM1 .

Configuring the Cognos TM1 clientYou must add two parameters to your Tm1p.ini file to allow you to perform IBMCognos security-related administrative tasks from your Cognos TM1 client.

Procedure1. Open the Tm1p.ini configuration file in a text editor. Tm1p.ini is located in the

C:\Documents and Settings\user name\Application Data\Applix\TM1directory.

2. Add the following parameters to the Tm1p.ini file.

Table 28. Parameters for the Tm1p.ini file

Parameter Name Description

CognosGatewayURI The URI for the Cognos Server that IBM CognosConnection used to authenticate Cognos TM1 clients. TheURI is specified in the form

http[s]://host/cognos_location/cgi-bin/cognos.cgi

For example: http://10.121.25.121/cognos_location/cgi-bin/cognos.cgi

AllowImportCAMClients Determines if Cognos clients can be imported intoCognos TM1 . This parameter must be set to T whensetting up Cognos security in Cognos TM1 .

Your Tm1p.ini file should include parameters similar to the following:AllowImportCAMClients = T

CognosGatewayURI = http://10.111.25.121/cognos_location/cgi-bin/cognos.cgi

Chapter 18. Security configuration 187

Page 200: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

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

Defining a Cognos user to function as a Cognos TM1administratorTo successfully administer IBM Cognos TM1 while using IBM Cognosauthentication, an existing Cognos user must be added to the Cognos TM1ADMIN group.

This Cognos user will be used to import Cognos groups into Cognos TM1 .

Procedure1. Log in to Cognos TM1 as an administrator.2. From the Server Explorer, click Server > Security > Clients/Groups.3. From the Clients/Groups dialog box, click Clients > Add New Client.

The Cognos logon dialog box appears.4. Enter your Cognos user ID and password, then click OK.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 beimported into Cognos 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 onthe 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

Cognos TM1 administrator. In most circumstances, you will define your ownCognos user as a Cognos TM1 administrator, as you must know the Cognosuser's ID and password to complete administrative tasks.

8. Select the user.

9. Click the green arrow icon to move the selected user to the SelectedEntries list.

10. Click OK to import the Cognos user into Cognos TM1 .The user appears as a new client in the Client/Groups window, but is notassigned to any Cognos TM1 groups.

11. Assign the new user to the ADMIN group and click OK.12. Shut down the Cognos TM1 server .13. Open the Tm1s.cfg configuration file in a text editor.14. Set the IntegratedSecurityMode parameter to indicate that the server should

use IBM Cognos authentication. The exact parameter value depends on thespecific Cognos TM1 components you are using:v If you are not using the Cognos TM1 Applications component, set the

parameter to 4.IntegratedSecurityMode=4

v If you are using Cognos TM1 Applications with Cognos security, set theparameter to 5 to support user groups from both Cognos TM1 and Cognos.IntegratedSecurityMode=5

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

188 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 201: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Importing Cognos groups into Cognos TM1After an IBM Cognos user is defined as the Cognos TM1 administrator, that usercan import Cognos groups into Cognos TM1 .

You should import only the Cognos groups that you want to allow to access theCognos TM1 server .

Procedure1. In the Server Explorer, double-click your Cognos TM1 server.

The Cognos logon dialog box appears.2. Log on as the Cognos user that you have defined as the Cognos 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.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 beimported into Cognos 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 youwant to import into Cognos TM1 .

7. Click the green arrow icon to move the selected user to the SelectedEntries list.

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

Creating usersWhen the IBM Cognos TM1 server is configured to use Cognos authentication, youcannot create new clients directly on the Cognos TM1 server .

Instead, all client administration is performed in Cognos.

When a Cognos user accesses Cognos TM1 , the user is validated andautomatically assigned to the appropriate Cognos TM1 groups. There is no need tomanually assign users to groups in Cognos TM1 .

Administering Cognos TM1 object securityWhile IBM Cognos authentication automatically manages users on the IBM CognosTM1 server , the Cognos TM1 administrator must still manage object security toallow Cognos users to view and use Cognos TM1 objects.

For details on administering Cognos TM1 object security, see the Cognos securitywith Cognos TM1 Developer Guide.

Configuring Cognos TM1 Web to Use Cognos SecurityTo allow users to successfully log in to IBM Cognos TM1 Web when the CognosTM1 server uses IBM Cognos authentication, a variables_TM1.xml file must bepresent in the cognos_location\templates\ps\portal directory.

The variables_TM1.xml file must be configured to include the URL of the webserver used to deliver Cognos TM1 Web.

Chapter 18. Security configuration 189

Page 202: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The variables_TM1.xml file is included as part of the Cognos TM1 Viewer Portletsinstallation. For details on installing and configuring Viewer Portlets, see the IBMCognos security with IBM Cognos TM1 Installation and Configuration Guide.

Configuring session timeout values for Cognos TM1 Applicationsand Cognos BI SecurityWhen using IBM Cognos TM1 Applications with IBM Cognos Business Intelligencesecurity, set the pmpsvc session timeout to a value higher than the CAM sessiontimeout to ensure the proper timeout detection. If the Cognos TM1 Applications(pmpsvc) session timeout is set to a value lower than the Cognos BI security(CAM) session timeout, then Cognos TM1 Applications will not properly detect aCAM session termination and will not timeout.

About this task

To ensure that Cognos TM1 Applications can properly detect a CAM sessiontermination, set the pmpsvc session timeout to a value higher than the CAMsession timeout.v The pmpsvc session timeout is the number of seconds of inactivity after which

Cognos TM1 Applications terminates a user session. The default value is 3600seconds (1 hour).

v The CAM session timeout is the number of seconds of inactivity after whichCognos security terminates a user session. The default value is 3600 seconds (1hour).

Procedure1. Configure the pmpsvc session timeout parameter.

Enter a value for the timeout attribute of the service / session element in thepmpsvc_config.xml file. This file is located in the WEB-INF/configurationdirectory.For example:v When Cognos TM1 Applications is deployed with the Apache Tomcat that is

provided with the Cognos TM1 installation, the pmpsvc_config.xml file ishere:Cognos_TM1_install_location\webapps\pmpsvc\WEB-INF\configuration

v When Cognos TM1 Applications is deployed with a separate version ofApache Tomcat, the file is here:C:\Program Files\Apache Software Foundation\Tomcat version_number\webapps\pmpsvc\WEB-INF\configuration

Use the format for the service / session / timeout attribute as defined in theXML schema definition file pmpsvc_config.xsd located in the same directory

2. Configure the CAM session timeout using IBM Cognos Configuration.Enter a value in the Inactivity timeout in seconds field in theSecurity/Authentication section of Cognos Configuration.

Logging in to Cognos TM1 TopThe IBM Cognos TM1 Top utility allows you to log into the current Cognos TM1Top session by executing the Cognos TM1 Top command V.

To successfully log in to Cognos TM1 Top, you must provide the IBM CognosNamespace ID of the namespace (not the descriptive name), along with a validCognos user name and password.

190 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 203: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Administrator considerations when using Cognos authenticationIBM Cognos TM1 administrators should be aware of the some issues whenconfiguring the Cognos TM1 server to use IBM Cognos authentication.

The issues are as follows:v Review the description of Cognos TM1 security modes 4 and 5 for the

IntegratedSecurityMode parameter. You should understand how these differentmodes control whether or not Cognos users can belong to Cognos TM1 usergroups. For details, see the description of the IntegratedSecurityMode parameterin the IBM Cognos TM1 Operation Guide.

v You cannot use Cognos TM1 to permanently assign a Cognos user to anotherCognos group. Any user assignment you make in Cognos TM1 to a Cognosgroup is not saved back to Cognos. When a Cognos user logs in to Cognos TM1, the group assignments in Cognos override any Cognos group assignmentsmade in Cognos TM1 .

v If you rename a Cognos user after importing that user to Cognos TM1 , youmust then delete the user in Cognos TM1 in order to update Cognos TM1 withthe new user name. After deleting the user in Cognos TM1 , the new name willappear the next time the user logs in.

User considerations when using Cognos authenticationIBM Cognos TM1 users should be aware of issues that may arise when accessingthe Cognos TM1 server configured to use IBM Cognos authentication.

Authentication behavior:

Rules govern authentication behavior when logging on to the IBM Cognos TM1server that uses IBM Cognos authentication.

The rules are as follows:v If common logon is enabled in IBM Cognos and you have previously logged in

to an IBM Cognos application and maintain an active session, you are notprompted for credentials when logging on to the Cognos TM1 server .

v If common logon is enabled in IBM Cognos and you have not previously loggedin to an IBM Cognos application, you are prompted for credentials when loggingon to the Cognos TM1 server .

v If common logon is not enabled in IBM Cognos, you are prompted forcredentials when logging on to the Cognos TM1 server, even if the server isconfigured to use IBM Cognos authentication.

Private Cognos Security sessions:

When an IBM Cognos server is configured to use common logon, you will bechallenged only once for credentials.

Any subsequent connections to other IBM Cognos security-enabled applications(including Cognos TM1 ) which are configured to reference the same IBM Cognosserver will automatically occur, provided your Cognos security passport is valid.

For example, if you have three available Cognos TM1 servers, all configured to usethe same IBM Cognos server, once you connect to the first server as user X innamespace Y, all connections to the other Cognos TM1 servers will automaticallyoccur using the passport of user X from namespace Y.

Chapter 18. Security configuration 191

Page 204: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

In some circumstances, you might want to log on to the Cognos TM1 server as auser other than the one identified by your Cognos security passport. Toaccommodate this, the Logon As option lets you override the automaticauthentication that usually occurs with a passport, while maintaining the validityof the passport for later use. When you log on to the Cognos TM1 server using theLogon As option, a private session is established. The credentials used to establishthe private session are not stored in a passport and are not shared with any otherapplication. Any existing passport remains valid and can be used to access otherIBM Cognos security-enabled applications.

Procedure

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 Cognos TM1 server.3. Click OK.

Establishing a replication with Cognos security:

When establishing a replication connection to the IBM Cognos TM1 server thatuses IBM Cognos authentication, you must provide the IBM Cognos Namespace IDof the namespace.

Do not provide the descriptive name of the namespace.

Using SSL for data transmission securityYou can configure IBM Cognos TM1 to use SSL for secure data transmission.

Overview to using SSL for data transmission securityAll IBM Cognos TM1 components communicate with the Cognos TM1 AdminServer using SSL.

The Admin Server supports older Cognos TM1 clients that cannot use SSL bylistening on two ports; one secured, the other unsecured. Cognos TM1 clients thatcan use SSL connect to the Admin Server via the secured port, while older clientsthat are incapable of using SSL connect to the Admin Server via the unsecuredport.

When the Cognos TM1 server registers with the Admin Server, the Cognos TM1server specifies whether it is using SSL or not. When a Cognos TM1 client contactsthe Admin Server, the list of available Cognos TM1 servers will vary according towhich port the client uses to connect to the Admin Server. If the client uses thesecured port, the Admin Server responds with a list of all Cognos TM1 serversavailable on the network. If the client uses the unsecured port, the Admin Serverresponds with a list of only those Cognos TM1 servers that do not use SSL.

192 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 205: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Generated certificatesWhen you install IBM Cognos TM1 , all certificates and other files required toimplement SSL are placed in the TM1_install_dir\bin\SSL directory.

The certificates contained in this directory are issued by the Applix®, Inc. certificateauthority, which was created using OpenSSL. The password used was "applix".

When you install Cognos TM1 , the Admin Server, Cognos TM1 server, andCognos TM1 client are all configured to use SSL, relying on the certificatesinstalled in the TM1_install_dir\bin\SSL directory. While the Cognos TM1certificates allow an out-of-the-box SSL implementation, you should replace thesecertificates with your own certificates (as well as a certificate revocation list) if youwant to maximize security. For Cognos TM1 Web, all root certificates must beinstalled in the certificate store on the machine that the servers are using to runCognos TM1 Web.

The TM1_install_dir\bin\SSL directory contains the following certificates and files.Files with a .pem extension are Privacy Enhanced Mail format. Files with a .derextension are Distinguished Encoding Rules.v Applixca.pem - the public root authority certificatev Applixcacrl.pem - the certificate revocation list

Older TM1 client (Pre-9.1)Not configured to use SSL

This client will contact the Admin Server on the unsecured port and receive a list of only the TM1 servers that are not configured to use SSL. These are the only servers withwhich the client will be able to establish insecure connections; any TM1 servers configured to use SSL will not be visibleto this client.

This client will contact the Admin Server on the secured port and receive a list of all TM1 servers available on the network.

The client will establish secure connections with TM1 servers configured to use SSL, and will establish insecure connections with TM1 servers that arenot configured to use SSL.

TM1 (9.1 or later) clientConfigured to use SSL

TM1 Admin Server Configured to listen for client connectionson both secured and unsecured ports

Configured for SSLTM1 servers

Not configured for SSLTM1 servers

Figure 9. Using SSL for data transmission security

Chapter 18. Security configuration 193

Page 206: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v Applixca.der - the public root authority certificate in DER format used for Javacertificate stores

v tm1admsvrcert.pem - the Admin Server certificate containing the public/privatekey pair

v tm1svrcert.pem - the Cognos TM1 server certificate containing thepublic/private key pair

v dh512.pem - the file that contains the pre-generated Diffie-Hellman 512 bit keyv dh1024.pem - the file that contains the pre-generated Diffie-Hellman 1024 bit keyv tm1store - the Java certificate store containing the public root authority certificatev tm1cipher.dat - the encrypted file containing the password used to access the

server's private keyv tm1key.dat - the key used to encrypt and decrypt tm1cipher.dat

Configuring the Cognos TM1 Admin Server to use SSLUse IBM Cognos Configuration to configure the IBM Cognos TM1 Admin Server touse SSL.

Note: As of IBM Cognos TM1 version 10.1, these parameters are set exclusively inCognos Configuration and no longer set in the Tm1admsrv.ini configuration file.

Open Cognos Configuration and edit the SSL-related parameters as described inthe following table.

Parameter Description

SupportNonSSLClients This parameter determines if the Admin Server supportsnon-SSL Cognos TM1 clients.

Set SupportNonSSLClients = T to configure the AdminServer to support non-SSL clients and to listen for clientconnections on both secured (SSL) and unsecured ports.

Set SupportNonSSLClients = F to configure the AdminServer to support only SSL client connections on a singlesecured port.

SSLCertAuthority The full path of the Cognos TM1 Admin Server's certificateauthority file.

SSLCertificate The full path of the Cognos TM1 Admin Server's certificatefile, which contains the public/private key pair.

DHFile-512 The full path name of the file that contains a pre-generatedDiffie-Hellman 512 bit key.

The generation of Diffie-Hellman parameters can becomputationally expensive. To minimize the consumptionof resources and to reduce the amount of time required toload the Cognos TM1 server, the Diffie-Hellman 512 bit keyshould be pre-generated and stored in a file that is calledwhen the Admin Server starts.

194 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 207: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter Description

DHFile-1024 The full path of the file that contains a pre-generatedDiffie-Hellman 1024 bit key.

The generation of Diffie-Hellman parameters can becomputationally expensive. To minimize the consumptionof resources and to reduce the amount of time required toload the Cognos TM1 server, the Diffie-Hellman 1024 bitkey should be pre-generated and stored in a file that iscalled when the Admin Server starts.

SSLPrivateKeyPwdFile The full path of the file that contains the encryptedpassword for the Cognos TM1 Admin Server's private key.

SSLPwdKeyFile The full path of the file that contains the key used toencrypt and decrypt the password for the private key.

ExportSvrSSLCert Specifies whether the Cognos TM1 Admin Server'scertificate should be exported from the Windows certificatestore.

If ExportSvrSSLCert=T, the Admin Server's certificate isexported from the Windows certificate store when thecertificate is requested by the Admin Server.

If ExportSvrSSLCert=T, you must also set the followingparameters:

SvrSSLExportKeyID

SSLCertificateID

SSLPrivateKeyPwdFile

SSLPwdKeyFile

SSLCertAuthority

SvrSSLExportKeyID

ExportSvrSSLCert

ClientExportSSLSvrKeyID

For details on using your own security certificates andexporting certificates from the Windows certificate store, see“Using independent certificates” on page 205.

SSLCertificateID Specifies the name of the principal to whom the CognosTM1 Admin Server's certificate is issued to.

SSLCertRevocationFile The full path of the Cognos TM1 Admin Server's certificaterevocation file.

A certificate revocation file will only exist in the event acertificate had been revoked.

Chapter 18. Security configuration 195

Page 208: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter Description

SvrSSLExportKeyID Specifies the identity key used to export the Admin Server'scertificate from the Microsoft Windows certificate store.

This parameter is required only if you choose to use thecertificate store.

Configuring the Cognos TM1 Server to use SSLTo configure an IBM Cognos TM1 server to use SSL, you must set severalparameters in Tm1s.cfg, a Cognos TM1 server's configuration file.

The following table describes all SSL-related parameters that can be set in theTm1s.cfg configuration file. Note that this table describes only the Tm1s.cfgparameters that are related to SSL; all other Tm1s.cfg parameters are described in“Parameters in the Tm1s.cfg File” on page 220.

Parameter Description

UseSSL Enables or disables SSL on the Cognos TM1server.

Set UseSSL=T to enable SSL. With thissetting, only Cognos TM1 9.1 and laterclients will be able to securely connect to theserver.

Set UseSSL=F to disable SSL. With thissetting, all Cognos TM1 clients, includingolder clients that do not support SSL, will beable to connect to the server in insecuremode.

AdminSvrSSLCertID Specifies the name of the principal to whomthe Cognos TM1 Admin Server's certificateis issued.

If the AdminSvrSSLCertID is incorrectlyconfigured, the server pull-down menu inCognos TM1 Web displays as empty and anerror is logged to the TM1web.log file.

AdminSvrSSLCertAuthority The full path of the certificate authority filethat issued the Cognos TM1 Admin Server'scertificate.

AdminSvrSSLCertRevList The full path of the certificate revocation fileissued by the certificate authority thatoriginally issued the Cognos TM1 AdminServer's certificate. A certificate revocationfile will only exist in the event a certificatehad been revoked

196 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 209: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter Description

ExportAdminSvrSSLCert Specifies whether the Cognos TM1 AdminServer's certificate should be exported fromthe Microsoft Windows certificate store.

If ExportAdminSvrSSLCert=T, the AdminServer's certificate is exported from theMicrosoft Windows certificate store whenthe certificate is requested by the CognosTM1 server.

AdminSvrSSLExportKeyID Specifies the identity key used to export theAdmin Server's certificate from the MicrosoftWindows certificate store.

SSLCertificate The full path of the certificate file thatcontains the public/private key pair.

SSLCertAuthority The name of the Cognos TM1 server'scertificate authority file. This file must resideon the computer where the Cognos TM1server is installed.

SSLCertRevocationFile The name the Cognos TM1 server'scertificate revocation file. A certificaterevocation file will only exist in the event acertificate had been revoked. This file mustreside on the computer where the CognosTM1 server is installed.

SSLCertificateID The name of the principal to whom theCognos TM1 server's certificate is issued.

Chapter 18. Security configuration 197

Page 210: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter Description

ExportSvrSSLCert Specifies whether the Cognos TM1 server'scertificate should be exported from theWindows certificate store.

If ExportSvrSSLCert=T, the Cognos TM1server's certificate is exported from theWindows certificate store when thecertificate is requested by the Cognos TM1server.

If ExportAdminSvrSSLCert=T, you must alsoset the following Tm1s.cfg parameters:

AdminSvrSSLCertID

AdminSvrSSLExportKey

ExportSvrSSLCert

SvrSSLExportKeyID

SSLCertificateID

SSLPwdKeyFile

SSLPrivateKeyPwdFile

SSLCertAuthority

ClientExportSSLSvrCert

For details on using your own securitycertificates and exporting certificates fromthe Microsoft Windows certificate store, see"Using Independent Certificates."

SvrSSLExportKeyID The identity key used to export the CognosTM1 server's certificate from the Windowscertificate store.

This parameter is required only if youchoose to use the certificate store by settingExportSvrSSLCert=T.

SSLPrivateKeyPwdFile The full path of the file that contains theencrypted password for the private key.

SSLPwdKeyFile The full path of the file that contains the keyused to encrypt and decrypt the passwordfor the private key.

198 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 211: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter Description

ClientExportSSLSvrCert Specifies whether the Cognos TM1 clientshould retrieve the certificate authoritycertificate, which was originally used toissue the Cognos TM1 server's certificate,from the Microsoft Windows certificate store.

If ClientExportSSLSvrCert=T, the certificateauthority certificate is exported from thecertificate store on the client computer whenrequested by the Cognos TM1 client.

ClientExportSSLSvrKeyID The identity key used by the TM1 client toexport the certificate authority certificate,which was originally used to issue theCognos TM1 server's certificate, from theWindows certificate store.

DHFile-512 The full path of the file that contains thepre-generated Diffie-Hellman 512 bit key.

The generation of Diffie-Hellman parameterscan be computationally very expensive. Tominimize this cost, the Diffie-Hellman 512bit key can be pre-generated and stored in afile that is called when the Cognos TM1server starts.

DHFile-1024 The full path name of the file that containsthe pre-generated Diffie-Hellman 1024 bitkey.

The generation of Diffie-Hellman parameterscan be computationally very expensive. Tominimize this cost, the Diffie-Hellman 1024bit key can be pregenerated and stored in afile that is called when the Cognos TM1server starts.

Configuring Cognos TM1 clients to use SSLTo configure IBM Cognos TM1 Architect or Perspectives clients to use SSL, youmust set several options on the Cognos TM1 Options dialog box.1. Open Cognos TM1 Architect or Cognos TM1 Perspectives, Server Explorer.2. In Server Explorer, click File > Options.3. Edit the SSL options in the Admin Server Secure Socket Layer (SSL) section.

The following table describes all SSL-related options that can be set in the TM1Options dialog box and lists the corresponding Tm1p.ini parameters.

Chapter 18. Security configuration 199

Page 212: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Option NameCorresponding Tm1p.iniParameter Description

CertificateAuthority

AdminSvrSSLCertAuthority The full path of the certificateauthority file that issued the CognosTM1 Admin Server's certificate.

CertificateRevocation List

AdminSvrSSLCertRevList The full path of the certificaterevocation file issued by the certificateauthority that originally issued theCognos TM1 Admin Server'scertificate. A certificate revocation filewill only exist in the event a certificatehad been revoked.

Certificate ID AdminSvrSSLCertIDNote: The name of the principal towhom the Cognos TM1 AdminServer's certificate is issued.

The value of this parameter should beidentical to the SSLCertificateIDparameter for the IBM Cognos TM1Admin Server as set in IBM CognosConfiguration.

Use CertificateStore

ExportAdminSvrSSLCert Select this option if you want thecertificate authority certificate whichoriginally issued the Cognos TM1Admin Server's certificate to beexported from the Microsoft Windowscertificate store at runtime.

Selecting this option in the CognosTM1 Options dialog box is equivalentto setting ExportAdminSvrSSLCert=Tin the Tm1p.ini file.

When this option is selected, you mustalso set a value for Export CertificateID in the Cognos TM1 Options dialogbox.

Export CertificateID

AdminSvrSSLExportKeyID The identity key used to export thecertificate authority certificate, whichoriginally issued the Cognos TM1Admin Server's certificate, from thecertificate store.

This parameter is required only if youchoose to use the certificate store bysetting ExportAdminSvrSSLCert=T.

Configuring Cognos TM1 Web to use SSLTo enable SSL in IBM Cognos TM1 Web, you must modify the value for theAdminSvrSSLCertID key in the Cognos TM1 Web configuration file, Web.config.

The Web.config file is located in the TM1Web directory on your Web server. Thedefault location of this directory is:

200 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 213: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos_TM1_install_location\TM1Web

The AdminSvrSSLCertID key displays in the appSetting section located at the top ofthe configuration file. You must set the AdminSvrSSLCertID key value to the nameof the principal to whom the Cognos TM1 Admin server's certificate is issued.

The default AdminSvrSSLCertID entry in the Web.config file is:

<!-AdminSvrSSLCertID: Admin Server SSL Certificate ID -->

<add key="AdminSvrSSLCertID" value="tm1adminserver" />

This default entry configures Cognos TM1 Web to use the standard, default SSLcertificates that are included as part of your Cognos TM1 installation.

To use your own custom SSL certificates, set the value attribute of this parameterto the certificate name you are using for the Cognos TM1 Admin server SSLcertificate.

Configuring Cognos TM1 Applications to use SSLTo configure IBM Cognos TM1 Applications to use SSL with your own customcertificates, you configure SSL for the other Cognos TM1 components that interactwith Cognos TM1 Applications, configure the web servers that support CognosTM1 Applications, and edit the Cognos TM1 Applications configuration.

Before you begin

Install and configure Cognos TM1 Applications without SSL and ensure that youcan run and log in to the program.

Procedure1. Configure TM1 Admin Server to use SSL.

See “Configuring the Cognos TM1 Admin Server to use SSL” on page 194.2. Configure TM1 Server to use SSL.

See “Configuring the Cognos TM1 Server to use SSL” on page 196.3. Configure TM1 Web to use SSL.

See “Configuring Cognos TM1 Web to use SSL” on page 200.4. Copy your certificate files into the Cognos TM1 Applications SSL folder:

Cognos TM1 install location\webapps\pmpsvc\WEB-INF\bin\ssl

5. If you are using your own certificates, import them as follows.a. On the computer running Cognos TM1 Admin Server, use IBM Cognos

Configuration to update the SSL parameters for the Admin Server.See “Editing SSL parameters in Cognos Configuration to use independentcertificates” on page 207.

b. On the computer running Cognos TM1 Server, run the tm1crypt.exe toolSee “Running the TM1Crypt utility” on page 205.

c. On the computer running Cognos TM1 Web, import your certificate to theMicrosoft Windows certificate store.See “Adding your certificate to the Microsoft Windows certificate store” onpage 205.

Chapter 18. Security configuration 201

Page 214: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

6. On the computer where Cognos TM1 Web is running, ensure that MicrosoftInternet Information Services (IIS) is configured to use SSL. For details, see theMicrosoft support web site for article #299875, “How to implement SSL in IIS”.

7. On the computer running the Cognos TM1 Application Server, configureApache Tomcat to use SSL. For details, search the Apache documentation website for “SSL Configuration”. The overall steps include:a. Create a keystore using the Java Development Kit (JDK) keytool.b. Configure the Tomcat server.xml file so that Tomcat uses the keystore.c. Create a signing request using the JDK keytool.d. Sign the request and obtain the certificate reply from the Certificate

authority.e. Import the certificate into the keystore used by Tomcat.f. Import root CA into the keystore used by Tomcat.

8. On the computer running the Cognos TM1 Application Server, edit the CognosTM1 Applications configuration file, fpmsvc_config.xml.a. Open the fpmsvc_config.xml file:

v If you deployed Cognos TM1 Applications with the provided ApacheTomcat, look for the file here:Cognos TM1 install location\webapps\pmpsvc\WEB-INF\configuration

v If you deployed with a different web application server, look for the filehere:program files for web application server\webapps\pmpsvc\WEB-INF\configuration

b. Edit or add the following entry under the </tm1><servers> section:<certificate authority="authority_file_name" id="id_name" />

where authority_file_name is the name of the certificate file and id_name isthe certificate name. This file is expected to be found in the folder:Cognos TM1 install location\webapps\pmpsvc\WEB-INF\bin\ssl

Remember: You must manually copy this file to this location.c. To specify an SSL certificate revocation list, use the optional revocationList

attribute. If specified, the file with the same name is expected to be in the\pmpsvc\WEB-INF\bin\ssl folder.

d. To specify authority and certificate id for a Cognos TM1 Admin Server, addthe same <certificate authority /> section under the admin_host section.If a certificate is not specified, the default one is used.

9. Update the URL configuration for the Cognos TM1 Application Web client:a. Log in to Cognos TM1 Applications.

b. Click the Administer IBM Cognos TM1 Applications icon on the toolbarof the Cognos TM1 Applications main page.

c. Click the TM1 Application Web check box and then click Edit.d. Update the value in the URL field to the secure URL for your installation of

Cognos TM1 Web. For example:https://web server name/TM1Web/contributor.aspx

e. Click OK.

202 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 215: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Configuring the Cognos TM1 Top Utility to use SSLThe IBM Cognos TM1 Top utility can be configured to use SSL whencommunicating with the Cognos TM1 Admin Server by adding five SSL-specificparameters to the Tm1top.ini file.

Parameter Description

AdminSvrSSLCertAuthority The full path of the certificate authority filethat issued the Cognos TM1 Admin Server'scertificate.

AdminSvrSSLCertID The name of the principal to whom theCognos TM1 Admin Server's certificate isissued.

AdminSvrSSLCertRevList The full path of the certificate revocation fileissued by the certificate authority that issuedthe Cognos TM1 Admin Server's certificate.

A certificate revocation file will only exist inthe event a certificate had been revoked.

ExportAdminSvrSSLCert Indicates whether the certificate authoritycertificate which issued the Cognos TM1Admin Server's certificate should beexported from the Microsoft Windowscertificate store at runtime.

To export the certificate authority certificateat runtime, set ExportAdminSvrSSLCert=T.

AdminSvrSSLExportKeyID The identity key used to export thecertificate authority certificate which issuedthe Cognos TM1 Admin server's certificatefrom the Windows certificate store.

This parameter is required only if youchoose to use the certificate store by settingExportAdminSvrSSLCert=T.

Configuring the TM1 C API to Use SSLSeveral public routines are available as part of the TM1 C API. You can use theseroutines to configure a client to communicate with the Admin Server using SSL.

For further details, see "Configuring the TM1 C API to Use SSL" in the IBMCognos TM1 API Guide.

Configuring the Cognos TM1 Java API to use SSLThe certificates used by a Java client to validate the server must reside in either theJava system cacerts truststore file or be specified on the application command line.

The Java system cacerts truststore resides in the Java \lib\security directory.

For example:C:\Program Files\Java\JDK1.5.0_04\lib\security

Chapter 18. Security configuration 203

Page 216: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The default password for cacerts is "changeit". Java provides an executable namedkeytool.exe for this very purpose. For example:keytool -keystore ..\lib\security\cacerts -alias Company-import -file Companyca.der

Optionally, if access is restricted to the system cacerts truststore, a truststore can becreated. For example:keytool -keystore tm1store -alias Companyca -import -fileACompanyca.der

When starting the Java application this keystore must be specified. If a password isrequired it must be provided as well. For example:java -Djavax.net.ssl.trustStore=bin\ssl\tm1store -Djavax.net.ssl.

trustStorePassword=Companycom.mycompany.MyApp

Further information is provided in the API specification for the Java 2 PlatformStandard Edition. The minimum Java version supported is 1.4.2.

Configuring the Cognos TM1 ETLDAP Utility to use SSLBefore you can connect to the LDAP server using SSL, you must run the followingcommand to add your certificate to the IBM Cognos TM1 store in theTM1_install_dir\axajre\bin directory:

Example:C:\Program Files\Cognos\Tm1\axajre\bin >keytool -keystore"C:\Program Files\Cognos\Tm1\bin\ssl\tm1store" -alias Applixldapca-import -file c:\temp\certificate_name.cer

In the above command, substitute the name of your certificate file forcertificate_name.cer.

When prompted for the keystore password, enter 'applix'.

You will receive confirmation that the certificate was added to the Cognos TM1keystore.

When connecting to the LDAP server, you must select the SSL option.

If you do not select the SSL option, the LDAP server will not be able toauthenticate your user information.

When running the ETLDAP utility from a command line, you must use thefollowing two parameters to enable SSL.

204 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 217: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter Description

-Djavax.net.sll.truststore Use this parameter to specify the full path tothe Java certificate store containing thepublic root authority certificate.

For example, to use the Java certificate storeinstalled with Cognos TM1 , use theparameter -Djavax.net.sll.truststore=C:\Program Files\Cognos\TM1\bin\ssl\tm1store

-Djavax.net.ssl.trustStorePassword Use this parameter to specify the passwordused to create the Java certificate store.

For example, to specify the password usedto create the Java certificate store installedwith Cognos TM1 , use the parameter-Djavax.net.ssl.trustStorePassword=applix

Using independent certificatesThough a standard IBM Cognos TM1 installation is configured to use SSL byrelying on the certificates installed in the TM1_install_dir\bin\SSL directory, youshould use your own certificates to maximize security.

The following sections describe how to use independent certificates to implementSSL.

Adding your certificate to the Microsoft Windows certificate storeYou can add an independent certificate to the Microsoft Windows certificate storeand configure IBM Cognos TM1 to use the certificate in the store.

Procedure1. From the Windows Start menu, click Start > Run and enter mmc to open the

Microsoft Management Console.2. Click File > Add/Remove Snap-in from the Microsoft Management Console.3. Click Add.4. Select Certificates and click Add.5. Select My User Account and click Finish. Click OK.6. Right-click Personal under Certificates - Current User and select All Tasks >

Import. Click Next.7. Click Browse and select the .pfx file that contains your certificate information.

Click Next.8. Enter a password for the private key and select the Mark this key as

exportable option. Click Next.9. Configure the screen as required and click Next.

10. Click Finish on the final screen of the Certificate Import Wizard.

Running the TM1Crypt utilityThe TM1Crypt utility (TM1Crypt.exe) encrypts the password that is needed by theIBM Cognos TM1 server to access the private key.

Chapter 18. Security configuration 205

Page 218: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The password is encrypted using Advanced Encryption Standard, 256 bit, CipherBlock Chaining (AES-256-CBC).

Location

The TM1Crypt utility, tm1crypt.exe, is installed in the directory:

TM1_install_dir\bin

Syntax

Run the TM1Crypt utility from a command prompt using the following syntax:

tm1crypt.exe -pwd password -keyfile filename -outfile filename -validate

Command options

Table 29. Options for the TM1Crypt utility

Option Description

-pwd The password for the private key. This should be the same password youused to encrypt your certificate in Step 11 above.

-keyfile The name of the .dat file that will be generated to contain the key used toencrypt and decrypt the password for the private key.

If this parameter is not specified, TM1Crypt generates a file namedtm1key.dat.

-outfile The name of the .dat file that will be generated to contain the encryptedpassword for the private key.

If this parameter is not specified, TM1Crypt generates a file namedtm1cipher.dat.

-validate If you include the -validate parameter, the utility will decrypt theencrypted password and display the results as clear text.

The displayed text should correspond to the password you specified withthe -pwd parameter.

This parameter does not allow validation of exiting files.

Example

For example, the command

tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfile btprk.dat -validate

generates two files:v btkey.dat - contains the key used to encrypt/decrypt the password for the

private keyv btprk.dat - contains the encrypted password for the private key.

The generated files are written to the TM1_install_dir\bin directory.

206 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 219: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Editing SSL parameters in Cognos Configuration to useindependent certificatesAfter adding your certificate to the Microsoft Windows Certificate Store, use IBMCognos Configuration to update the SSL parameters for the Cognos TM1 AdminServer.

Note: As of IBM Cognos TM1 version 10.1, these parameters are set exclusively inCognos Configuration and no longer set in the Tm1admsrv.ini configuration file.

Table 30. SSL Parameters in Cognos Configuration that support independent certificates

Parameter Description

ExportSvrSSLCert This parameter must be set to T to enable the Admin Server toretrieve the certificate from the Certificate Store.

ExportSvrSSLCert=T

SSLCertAuthority The name of the authority that issued your certificate.

You can determine this value by referring to the MicrosoftManagement Console and clicking Certificates > Personal >Certificates. The authority name displays in the Issued By column ofthe Properties pane.

SSLCertificateID The name of the principal to whom the IBM Cognos TM1 AdminServer's certificate is issued.

You can determine this value by referring to the MicrosoftManagement Console and clicking Certificates > Personal >Certificates. The principal name displays in the Issued To column ofthe Properties pane.

SSLPrivateKeyPwdFileThe full path to the .dat file that contains the encrypted passwordfor the private key.private key.

The name of this file is specified by the -outfile parameter when yourun the TM1Crypt utility.

For example, if you run the TM1Crypt utility from the followingcommand:

tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfile btprk.dat-validate

the correct parameter value is:

SSLPrivateKeyPwdFile=C:\Program Files\Cognos\TM1\bin\btprk.dat

SSLPwdKeyFile The full path to the .dat file that contains the key used to encryptand decrypt the password for the private key.

The name of this file is specified by the -keyfile parameter when yourun the TM1Crypt utility.

For example, if you run the TM1Crypt utility from the followingcommand:

tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfile btprk.dat-validate

the correct parameter value is:

SSLPwdKeyFile=C:\Program Files\Cognos\TM1\bin\btkey.dat

Chapter 18. Security configuration 207

Page 220: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 30. SSL Parameters in Cognos Configuration that support independentcertificates (continued)

Parameter Description

SvrSSLExportKeyID Specifies the identity key used to export the Admin Server'scertificate from the Windows certificate store.

In most cases, the value for SvrSSLExportKeyID will be identical tothe value for SSLCertificateID.

Editing the Tm1s.cfg fileAfter adding your certificate to the Microsoft Windows Certificate Store, addrequired parameters to the Tm1s.cfg file.

Table 31. SSL Parameters for the Tm1s.cfg file

Parameter Value

AdminSvrSSLCertID Specifies the name of the principal to whom the IBMCognos TM1 Admin Server's certificate is issued.

AdminSvrSSLExportKeyID Specifies the identity key used to export the Admin Server'scertificate from the Microsoft Windows certificate store.

ClientExportSSLSvrCert Specifies whether the Cognos TM1 client should retrieve thecertificate authority certificate, which was originally used toissue the Cognos TM1 server's certificate, from theMicrosoft Windows certificate store.

If ClientExportSSLSvrCert=T, the certificate authoritycertificate is exported from the certificate store whenrequested by the TM1 client.

ClientExportSSLSvrKeyID The identity key used by the Cognos TM1 client to exportthe certificate authority certificate, which was originallyused to issue the Cognos TM1 server's certificate, from theMicrosoft Windows certificate store.

ExportAdminSvrSSLCert Specifies whether the Cognos TM1 Admin Server'scertificate should be exported from the Microsoft Windowscertificate store.

If ExportAdminSvrSSLCert=T, the Admin Server's certificateis exported from the Microsoft Windows certificate storewhen the certificate is requested by the Cognos TM1 server.

ExportSvrSSLCert This parameter must be set to T to enable the Cognos TM1server to retrieve the certificate from the Certificate Store.

ExportSvrSSLCert=T

SSLCertAuthority The name of the authority that issued your certificate.

You can determine this value by referring to the MicrosoftManagement Console and clicking Certificates > Personal >Certificates. The authority name displays in the Issued Bycolumn of the Properties pane.

SSLCertificateID The name of the principal to whom the Cognos TM1Server's certificate is issued.

You can determine this value by referring to the MicrosoftManagement Console and clicking Certificates > Personal >Certificates. The principal name displays in the Issued Tocolumn of the Properties pane.

208 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 221: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 31. SSL Parameters for the Tm1s.cfg file (continued)

Parameter Value

SSLPrivateKeyPwdFile The full path to the .dat file that contains the encryptedpassword for the private key.private key.

The name of this file is specified by the -outfile parameterwhen you run the TM1Crypt utility.

For example, if you run the TM1Crypt utility from thefollowing command:

tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfilebtprk.dat -validate

the correct parameter value is SSLPrivateKeyPwdFile=C:\Program Files\Cognos\TM1\bin\btprk.dat

SSLPwdKeyFile The full path to the .dat file that contains the key used toencrypt and decrypt the password for the private key.

The name of this file is specified by the -keyfile parameterwhen you run the TM1Crypt utility.

For example, if you run the TM1Crypt utility from thefollowing command:

tm1crypt.exe -pwd abc123 -keyfile btkey.dat -outfilebtprk.dat -validate

the correct parameter value is SSLPwdKeyFile=C:\ProgramFiles\Cognos\TM1\bin\btkey.dat

SvrSSLExportKeyID Specifies the identity key used to export the Cognos TM1server's certificate from the Microsoft Windows certificatestore.

In most cases, the value for SvrSSLExportKeyID will beidentical to the value for SSLCertificateID.

Using independent certificates on your file systemYou can implement SSL using independent certificates stored on your file system.

Simply add your certificate, certificate authority, password files, etc. to theTM1_install_dir\bin\SSL directory and modify the appropriate IBM Cognos TM1configuration parameters to point to your independent files.

Chapter 18. Security configuration 209

Page 222: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

210 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 223: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Chapter 19. Maintenance of your Cognos TM1 10.1 installation

After successfully installing IBM Cognos TM1, you can perform maintenance taskssuch as installing additional components, backing up your data, and uninstallingthe current version.

Installing additional componentsYou can return to the Cognos TM1 Installation Wizard to install additionalcomponents that are not installed. If you try to reinstall the same versionof IBM Cognos TM1 that is already installed, the Program Maintenancescreen opens with the following options:

Backing up dataWhen upgrading to a new version of Cognos TM1, you can manually backup and restore your existing Cognos TM1 data.

Uninstalling the current version

Remove - Use this option to uninstall Cognos TM1 from your computer.For details, see Uninstalling Cognos TM1 10.1.

Backing up data for Cognos TM1 10.1This topic describes how to backup your Cognos TM1 data.

About this task

If you are currently using IBM Cognos TM1, follow these steps to backup yourCognos TM1 data directory and configuration files.

If you are using Cognos TM1 Web on a web server, you should also back up therelated files and data for that component. If you are using Cognos TM1Applications, you should also back up the related files and data separately.

Procedure1. Save a copy of the contents of your IBM Cognos TM1 database

<TM1_Install>\samples\ data directory and subdirectories to a secure location.2. Save a copy of all Cognos TM1 configuration files you may want to retain, such

as the tm1admsrv.ini file located in <TM1_Install>\bin\directory.3. If you use Cognos TM1 Web, backup the web.config file and any custom

Cognos TM1 Web server pages to a secure location. The default location forthese files is <TM1_Install>\TM1Web.

4. If you are using Cognos TM1 Architect or Cognos TM1 Perspectives, save theTm1p.ini file in both %ALLUSERSPROFILES%\Application Data\Applix\TM1\ and%USERPROFILE%\Application Data\Applix\TM1\.In most cases, the full paths to these files are C:\Documents and Settings\AllUsers\Application Data\Applix\TM1\Tm1p.ini and C:\Documents andSettings\<username>\Application Data\Applix\TM1\Tm1p.ini.

5. If you use Cognos TM1 Applications, see “Backup your Cognos TM1Applications data” on page 213 for the steps to backup the related data andconfiguration files.

© Copyright IBM Corp. 2007, 2012 211

Page 224: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Modifying Cognos TM1 installed componentsYou can modify your current installation, add components, and change installationparameters.

About this task

You can only install components using the install wizard, you cannot removecomponents using this method.

Procedure1. Insert the IBM Cognos TM1 installation CD in your CD drive.

If autorun is enabled on your CD drive, the Cognos TM1 Installation Wizarddisplays. If autorun is not enabled, run issetup.exe in the installation CD rootdirectory to start the Cognos TM1 Installation Wizard.

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

The Component Selection screen appears, showing the current state of yourCognos TM1 installation. Items currently installed display with a disk driveicon next to the component name. Items not currently installed display with anX next to the name.Program maintenance does not include changing the location of the CognosTM1 installation directory. To change the location of the installation directory,remove all Cognos TM1 files and reinstall Cognos TM1 in another location.

4. Select the Cognos TM1 components you want to modify and click Next.5. Click Install to start the modifications.6. Click Finish when the modifications are completed.

Uninstalling Cognos TM1 10.1To remove and uninstall all components of IBM Cognos TM1, follow these steps.

Note: If you are uninstalling and reinstalling Cognos TM1 Applications, see thesection “Uninstalling Cognos TM1 Applications” on page 213 for additionalrequired steps. Uninstalling also has an effect on the Cognos TM1 application pool.See the IBM Cognos TM1 Web User Guide for more information.

Before you begin

Depending on which components installed, you might have to perform separatesteps to remove them. Before you start to uninstall Cognos TM1 10.1, you musthave completed the backup of all Cognos TM1 data.

About this task

Procedure1. Uninstall Cognos Insight:

a. From the Windows Control Panel, choose Add or Remove Programs.b. In the list of currently installed programs, select IBM Cognos TM1 Insight.c. Click Remove and follow the instructions to complete the processd. Check program files directory to see if any files remain. If so delete them

manually.

212 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 225: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

2. Uninstall Cognos TM1 Performance Modeler:a. From the Windows Control Panel, choose Add or Remove Programs.b. In the list of currently installed programs, select IBM Cognos Performance

Modeler.

c. Click Remove and follow the instructions to complete the processd. Check program files directory to see if any files remain. If so delete them

manually.3. Uninstall core TM1 components - server,

a. From the Microsoft Windows Start menu, click Programs > IBM CognosTM1 > Uninstall IBM Cognos TM1 > Uninstall IBM Cognos TM1.

b. select language for the uninstall wizard and click Nextc. On the Select the packages you wish to uninstall screen, click the check box

for the IBM Cognos TM1 option, then select Next. The uninstall programremoves the components and may take some time. When completed, youwill be prompted to restart your computer.

d. Choose to restart now or later, then click Finish.

Uninstalling Cognos TM1 ApplicationsThe IBM Cognos TM1 Applications needs several steps to do a complete backupand export of data if you want to keep your applications data.

The tasks described here enable you to:v Backup your Cognos TM1 Applications datav Export your Cognos TM1 Applications datav Stop all related servicesv Uninstall Cognos TM1 Applicationsv Undeploy Cognos TM1 Application from Apache Tomcat if used.v Undeploy Cognos TM1 Applications from WebSphere if used.v Re-import exported applications into the current version of Cognos TM1

Applications.

Backup your Cognos TM1 Applications dataThis topic describes how to backup your data and configuration files for CognosTM1 Applications.

Procedure

Save a backup copy of the Cognos TM1 Applications applications folder and thepmpsvc_config.xml and fpmsvc_config.xml configuration files.The typical locations for these items are:v <TM1_Install>\webapps\pmpsvc\WEB-INF\applications

v <TM1_Install>\webapps\pmpsvc\WEB-INF\configuration\pmpsvc_config.xml

v <TM1_Install>\webapps\pmpsvc\WEB-INF\configuration\fpmsvc_config.xml

If you are using IBM Cognos BI security with Cognos TM1 Applications, theseitems are located in the following location:<Your Program Files>\cognos\cx\webapps\pmpsvcwhere x is the version of Cognos BI you are using.

Chapter 19. Maintenance of your Cognos TM1 10.1 installation 213

Page 226: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Exporting applications from Cognos TM1 10.1 ApplicationsYou can export an application from IBM Cognos TM1 Applications 10.1 to save aback up copy or to move the application to another instance of Cognos TM1Applications.

About this task

An archive is created and contains the XML files that describes the structure andsecurity of your application.

Procedure1. Open the TM1 Cognos Applications portal.2. Click the Export Application icon under the Actions column.3. From the File Download dialog box, click Save.4. Navigate to the directory to where you want to save the export file.5. Click Save.

Stopping related services in Cognos TM1 10.1This topic describes how to stop related services.

Procedure1. Open Cognos Configuration.2. Stop all of the following services:

v TM1 Admin Serverv TM1 Excel servicev all instances of the TM1 server servicev TM1 Application Server

3. If you are using IBM Cognos Business Intelligence security with Cognos TM1Applications, stop the IBM Cognos BI service.

4. If you are running any Cognos TM1 services that were not initially configuredand started through Cognos Configuration, stop those services in the Windowsservices console.

Uninstalling Cognos TM1 10.1 ApplicationsThe steps to uninstall IBM Cognos TM1 Applications.

Procedure1. Undeploy and uninstall Cognos TM1 Applications.2. From the Windows Control Panel, choose Add or Remove Programs.3. In the list of currently installed programs, select IBM Cognos TM1

Applications.

4. Click Remove and follow the instructions to complete the process5. Check program files directory to see if any files remain. If so delete them

manually.

Undeploy Cognos TM1 Applications in Apache TomcatThis topic describes how to undeploy IBM Cognos TM1 Applications in ApacheTomcat.

214 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 227: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Open the Tomcat Manager.2. Click Undeploy for the /pmpsvc entry in the Applications list.3. Click OK to confirm.

The application is undeployed and removed from the Tomcat ManagerApplications list.

Tip: If the /pmpsvc entry is still shown in the Applications list afterundeploying, stop and restart Tomcat and then click Undeploy for a secondtime.

4. Verify that the following Cognos TM1 Application Web application folders andfiles have been deleted. Stop Tomcat and delete these files if they still exist.Folders:

v C:\Program Files\Apache Software Foundation\webapps\pmpsvc

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

v C:\Program Files\Apache Software Foundation\Tomcat6.0\work\Catalina\localhost\pmpsvc

Files:

v C:\Program Files\Apache Software Foundation\Tomcat6.0\webapps\pmpsvc.war

If you are using IBM Cognos Business Intelligence security with Cognos TM1Applications, these items are located in the following locations:v C:\Program Files\cognos\cx\webapps\pmpsvc

v C:\Program Files\cognos\cx\tomcat4.1.27\work\Standalone\localhost\pmpsvc

where x is the version of Cognos BI you are using.

Undeploy Cognos TM1 Applications in WebSphereThis topic describes how to undeploy IBM Cognos TM1 Applications in IBMWebSphere.

Procedure1. Open the WebSphere Administrative Console.2. In the Console Navigation pane, locate the Applications section and click Web

App WARs.The Installed Web Applications page opens.

3. Locate the entry for /pmpsvc in the URL column and click Uninstall.4. Click OK to confirm the uninstall.

WebSphere displays the following message when complete:Uninstalled application

default/pmpsvc

Importing applications from the current version back into thecurrent version Cognos TM1 Applications

You can import an application exported from IBM Cognos TM1 Applications backinto IBM Cognos TM1 Applications.

Chapter 19. Maintenance of your Cognos TM1 10.1 installation 215

Page 228: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Procedure1. Open the Cognos TM1 Applications portal.2. Click the Import Application button.3. Select the Cognos TM1 server onto which you want to import the application.4. Next to the Application file field, click Browse.5. Navigate to the application (.zip) file, then click Open.6. Select the Import application security option if you want to import security

settings with the application.7. Select the Import application properties option if you want to import property

settings with the application.8. Click Import.

216 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 229: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Appendix A. Accessibility features

Accessibility features help users who have a physical disability, such as restrictedmobility or limited vision, to use information technology products.

See the IBM Accessibility Center for more information about the commitment thatIBM has to accessibility.

The IBM Accessibility Center is available online at http://www.ibm.com/able.

Keyboard shortcuts for the installation wizardKeyboard shortcuts, or shortcut keys, provide you with an easier and often fastermethod of navigating and using software.

The installation wizard uses standard Microsoft Windows operating systemnavigation keys in addition to application-specific keys.

Note: The following keyboard shortcuts are based on US standard keyboards.

The following table lists the keyboard shortcuts that you can use to perform someof the main tasks in the installation wizard on the Windows operating system.

Action Shortcut key

Move to the next field on a page Tab

Return to the previous field on a page Shift+Tab

Close the installation wizard Alt+F4

Move to the next configuration step Alt+N

Return to the previous configuration step Alt+B

Move to the next selection in a list Down arrow

Move to the previous selection in a list Up arrow

The following table lists the keyboard shortcuts you can use to perform some ofthe main tasks in the installation wizard on the UNIX or Linux operating system.

Action Shortcut key

Move to the next field on a page Tab

Return to the previous field on a page Shift+Tab

Close the installation wizard Alt+F4

Move to the next selection in a list Down arrow

Move to the previous selection in a list Up arrow

The following table lists the keyboard shortcuts you can use to perform some ofthe main tasks in the License Agreement page of the installation wizard.

Action Shortcut key

Accept the license agreement Alt+A

© Copyright IBM Corp. 2007, 2012 217

Page 230: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Action Shortcut key

Decline the license agreement Alt+D

Quit the installation wizard Alt+x

Keyboard shortcuts for Cognos ConfigurationKeyboard shortcuts, or shortcut keys, provide you with an easier and often fastermethod of navigating and using software.

The following keyboard shortcuts are based on US standard keyboards.

The following table lists the keyboard shortcuts that you can use to perform someof the main tasks in IBM Cognos Configuration on the Windows operating system.

Action Shortcut key

Save the current configuration Crtl+S

Close Cognos Configuration Alt+F4

Rename the selected item F2

Display the File menu Alt+F

Display the Edit menuAlt+H Alt+E

Display the View menu Alt+V

Display the Actions menu Alt+A

Display the Help menu Alt+H

The following table lists the keyboard shortcuts you can use to perform some ofthe main tasks in Cognos Configuration on the UNIX or Linux operating system.

Action Shortcut key

Save the current configuration Tab

Close Cognos Configuration Shift+Tab

Rename the selected item Alt+F4

218 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 231: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Appendix B. The Tm1s.cfg Server Configuration File

The Tm1s.cfg file is an ASCII file that specifies environment information for anIBM Cognos TM1 server.

A default Tm1s.cfg file is created in the Cognos TM1 server data directory whenyou install a copy of the Cognos TM1 server. Most of the available parameters aredocumented in the configuration file. If a parameter is not installed by default, theparameter is commented out in the configuration file. You can edit the Tm1s.cfgfile to reflect the environment of the associated remote server by un-commentingthe parameter you wish to use and setting the correct value.

For an alphabetical listing of all the parameters in the server configuration file, see“Parameters in the Tm1s.cfg File” on page 220.

Location of the Tm1s.cfg FileThe location of the Tm1s.cfg file depends on the type of server you are using.v If you are using the IBM Cognos Configuration tool to start and stop your IBM

Cognos TM1 servers, you can view the configuration path for a Cognos TM1server by clicking the server name in the Explorer tree of Cognos Configuration.

v If you are running the Cognos TM1 remote server as a Microsoft Windowsservice (Tm1sd.exe), and you used the Cognos TM1 installation program toinstall the server, the system uses the Tm1s.cfg file that is located in the serverdata directory you specified during installation.

v If you are running the Cognos TM1 remote server as a Windows application(Tm1s.exe), you specify the location of the Tm1s.cfg file by using the -zparameter in the command line when you start the server, either from a shortcutor from a command prompt.For example, this command specifies that Cognos TM1 will use the Tm1s.cfg filelocated in the c:\salesdata directory:c:\ProgramFiles\Cognos\TM1\bin\tm1s.exe -z c:\salesdata

If the -z parameter points to a directory containing spaces, you must enclose thedirectory in double quotes. For example, -z "c:\sales data".

v If you are running a Cognos TM1 server on UNIX, and you used the CognosTM1 installation program to install the server, the system uses the Tm1s.cfg filethat is located in the server data directory you specified during installation.

Sample Tm1s.cfg FileThis is a sample Tm1s.cfg file.

Your tm1s.cfg file may also include comments that describe the parameters.#Security mode

#(there are typically some information comments here.)

[TM1S]

ServerLogging=F

SecurityPackageName=Kerberos

IntegratedSecurityMode=1

© Copyright IBM Corp. 2007, 2012 219

Page 232: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

UseSSL=T

ServerName=Planning Sample

DataBaseDirectory=C:\Program Files\Cognos\TM1\Custom\TM1Data\PlanSamp\

AdminHost=xxxxxxxx

PortNumber=12345

ClientMessagePortNumber= 5433

Language=ENG

SaveTime=

DownTime=

ProgressMessage=True

AuditLogOn=F

AuditLogMaxFileSize= 100 MB

AuditLogUpdateInterval=60

#ServerCAMURI=http://L3L0833-6457A26:9300/p2pd/servlet/dispatch

#ClientCAMURI=http://L3L0833-6457A26/cognos8/cgi-bin/cognos.cgi

#ClientPingCAMPassport=900

#Optional CAM parameters

#CAMSSLCertificate=

#CAMSSLCertRevList=

#SkipSSLCAMHostCheck=TRUE

#SkipSSLCAMHostCheck=TRUE

Parameters in the Tm1s.cfg FileThe parameters in the Tm1s.cfg file are described here.

Dynamic parameter

Dynamic parameter values can be edited while the IBM Cognos TM1 server isrunning.

The Cognos TM1 server continuously polls the Tm1s.cfg file at 60 second intervalsto determine if any dynamic parameter values have changed. If the server detects aparameter value change, the new value is applied immediately. Dynamicparameters are identified with a statement describing them as "dynamic" in thislist.

Static parameter

Static parameter values are read from the Tm1s.cfg file only when the IBM CognosTM1 server starts. If you want to change a static parameter value, you must shutdown the Cognos TM1 server, edit the value in the Tm1s.cfg file, and then restartthe server.

Most parameters in the Tm1s.cfg file are static.

Spaces in values

If a parameter value contains spaces, enclose the parameter values within doublequotes.

220 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 233: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

AdminHostSpecifies the computer name or IP address of the Admin Host on which an AdminServer is running.

Parameter type: required, static

To specify multiple Admin Hosts, separate each host name with a semicolon whenrunning on Microsoft Windows or with a colon when running on a UNIX. Forexample:v Use the format AdminHost=hostname1;hostname2 on a Windows Cognos TM1

server.v Use the format AdminHost=hostname1:hostname2 on a UNIX Cognos TM1 server.

Some other examples include:v AdminHost=boston;newyork

v AdminHost=192.168.1.17;192.168.1.22

v AdminHost=boston;192.168.1.17;192.168.1.22;myserver;192.168.1.40

Note: The string specifying the admin host or hosts is limited to 1020 characters orbytes.

AllowReadOnlyChore RescheduleProvides users with READ access to a chore, and the ability to activate, deactivate,and reschedule chores.

Parameter type: optional, static

When the line AllowReadOnlyChoreReschedule=T is added to the Tm1s.cfg file fora server, users with READ access to a chore can right-click a chore in ServerExplorer, and toggle the Activate Schedule option or choose the Edit Chore option.The Edit Chore option is available only when a chore is not activated.

When a user with READ access to a chore selects the Edit Chore option, only thescheduling screen of the Chore Setup Wizard opens.

The scheduling screen lets the user set scheduling parameters for the chore, butdoes not allow the user to edit the list of processes that compose the chore.

AllowSeparateNandCRulesWhen enabled, this parameter lets you specify rule expressions for N: and C: levelson separate lines using identical AREA definitions.

Parameter type: optional, static

For example,[’Budget’,’Argentina’]=N:Expression;

[’Budget’,’Argentina’]=C:Expression;

are both valid rules statements when you include the AllowSeparateNandCRulesparameter in the Tm1s.cfg file and set to T.

This parameter also effects how numeric and string rules are applied to cells.Without this parameter, the first rule statement that is encountered for a given

Appendix B. The Tm1s.cfg Server Configuration File 221

Page 234: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

AREA definition is applied to the cells within the scope of that definition. If anycell within the AREA definition is numeric and the rule is a string rule, then thecell is considered not rule-derived because there was a match that did not apply tothe cell.

For example, consider the statements:[’1 Quarter’]=s:’str_value’;Not following.

[’1 Quarter’]=n:77;

If the AllowSeparateNandCRules parameter is not set (or is set to F), then the firstrule statement will match any cell that uses '1 Quarter' as one of its elements. If thecell is a string cell, the value of the cell will be set to 'str_value'. If the cell is anumeric cell, the cell will not be considered rule derived, since a match was found(the first rule) but the rule itself did not apply.

If the AllowSeparateNandCRules parameter is set to T, then string cells which use'1 Quarter' will be set to 'str_value' and numeric cells which use '1 Quarter' will beset to 77.

To set the parameter to T, add the following line to Tm1s.cfg:AllowSeparateNandCRules=T

AllRuleCalcStargateOptimizationThe AllRuleCalcStargateOptimization parameter can improve performance incalculating views that contain only rule-calculated values.

Parameter type: optional, static

Typically, Cognos TM1 performs calculations for standard consolidations and thencalculates values for rule-based consolidations, which may end up overridingvalues in the standard consolidations. The AllRuleCalcStargateOptimizationparameter provides optimization that first checks if every value in the view isrule-calculated and then proceeds as follows:v If every value in the view is rule-calculated, then Cognos TM1 skips the

unnecessary calculations for standard consolidations and just performs therule-calculated consolidations.

v If the view contains even a single value which is not rule-calculated, then thisoptimization parameter will have no effect.

When this parameter is set to True, some additional processing will take place forevery view that is requested to first check if the view contains only rule-calculatedvalues. For most views, this additional processing is minimal since theoptimization is stopped after the first value in the view is found to be notrule-calculated.

To enable this parameter, set the parameter's value to T in the Cognos TM1 serverconfiguration file, Tm1s.cfg, as follows:AllRuleCalcStargateOptimization=T

The default setting is disabled (F).

AuditLogMaxFileSizeIndicates the maximum file size that an audit log file can grow to before it isclosed and a new file is created.

222 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 235: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter type: optional, dynamic

This value must include units of KB (kilobytes), MB (megabytes), or GB(gigabytes). For example, to limit the log file size to 100 MB, enter the following:

AuditLogMaxFileSize=100 MB

The range of values include:v Default value: 100 MBv Minimum value: 1 KBv Maximum value: 2 GB

AuditLogMaxQueryMemoryIndicates the maximum amount of memory that IBM Cognos TM1 can use whenrunning an audit log query and retrieving the set of results.

Parameter type: optional, dynamic

This value must include units of KB (kilobytes), MB (megabytes), or GB(gigabytes). For example:

AuditLogMaxQueryMemory=100 MB

The range of values include:v Default value: 100 MBv Minimum value: 1 KBv Maximum value: 2 GB

AuditLogMaxTempFileSizeIndicates the maximum file size that the temporary audit log file can grow tobefore Cognos TM1 moves the file's data into the final audit log.

Parameter type: optional, dynamic

This value must include units of KB (kilobytes), MB (megabytes), or GB(gigabytes). For example:AuditLogMaxTempFileSize=100MB

The range of values include:v Default value: 100 MBv Minimum value: 1 KBv Maximum value: 2 GB

AuditLogOnTurns audit logging on (T) or off (F).

Parameter type: optional, static

For example:v To enable audit logging, set AuditLogOn=Tv To disable audit logging, set AuditLogOn=F

Appendix B. The Tm1s.cfg Server Configuration File 223

Page 236: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The default setting is F.

AuditLogUpdateIntervalIndicates the maximum amount of time, in minutes, that IBM Cognos TM1 waitsbefore moving the events from the temporary audit file into the final audit log.

Parameter type: optional, dynamic

For example:

AuditLogUpdateInterval=60

The default value is 60 (sixty minutes).

The minimum value is 1 (one minute).

Note: You can manually update the audit log with the latest events anytime youwant by using the Process Audit Log Events command in Server Explorer. Fordetails, see "Updating the Audit Log with the Latest Events" in the IBM CognosTM1 Operation Guide.

CalculationThresholdForStorageDefines a minimum number of rule calculations required for a single cell orStargate view, beyond which the IBM Cognos TM1 server stores the calculationsfor use during the current server session.

Parameter type: optional, dynamic

For example, when a user requests rule-derived values from the Cognos TM1server, either from a single cell or a Stargate view, the server usually has toperform multiple rule calculations to arrive at the requested rule-derived values.

CalculationThresholdForStorage has a direct effect on memory consumption andperformance. A high parameter value results in decreased memory consumptionand slower performance. A low parameter value results in increased memoryconsumption and faster performance.

If you do not include CalculationThresholdForStorage in Tm1s.cfg, the defaultcalculation threshold is 50.

CAMSSLCertificateThe full path and name of the SSL certificate to be used when connecting to theinternal dispatcher.

For example, C:\AxTM1\Install_Dir\ssl\CognosCert.cer.

Parameter type: static

Required only when CAM server is configured to use SSL.

CheckFeedersMaximumCellsLimits the number of cells checked by the Check Feeders option in the CubeViewer.

224 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 237: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The CheckFeedersMaximumCells is an optional parameter that you can add toTm1s.cfg. If you do not include this parameter in Tm1s.cfg, Check Feeders checks3,000,000 cells, by default.

Parameter type: optional, dynamic

When Cognos TM1 checks feeders from a highly consolidated cell, it must checkall intersections that apply to the cell. In large applications, the Cognos TM1 serverwill be unavailable for a significant amount of time while Cognos TM1 is checkingall intersections.

To limit the number of cells checked when using Check Feeders (which in turnlimits the amount of time the Cognos TM1 server is unavailable), addCheckFeedersMaximumCells to Tm1s.cfg and set the parameter to the number ofcells you want to check.

For example, to limit Check Feeders to 1,000,000 cells, enter the following line:

CheckFeedersMaximumCells=1,000,000

ClientCAMURIThe URI for the IBM Cognos Server IBM Cognos Connection used to authenticateCognos TM1 clients.

Parameter type: optional, static

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

ClientPingCAMPassportIndicates the interval, in seconds, that a client should ping the CAM server to keeptheir passport alive.

Parameter type: optional, static

If an error occurs or the passport expires the user will be disconnected from theCognos TM1 server.

CAMPortalVariableFileThe path to the variables_TM1.xml file in your IBM Cognos installation.

Parameter type: Required for IBM Cognos interoperability, static.

The CAMPortalVariableField parameter is required only when using IBM CognosBusiness Intelligence (BI) with Cognos TM1 Web and the Cognos TM1 Server.

Set this parameter with a relative path as follows:

CAMPortalVariableFile=portal\variables_TM1.xml

Note: The exact file location on the IBM Cognos BI server is: Cognos_location\templates\ps\portal\variables_TM1.xml.

Appendix B. The Tm1s.cfg Server Configuration File 225

Page 238: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The variables_TM1.xml file is included as part of the IBM Cognos TM1 BIInteroperability (Viewer Portlets) installation. For details, see Chapter 14, “CognosTM1 and Cognos Business Intelligence interoperability installation,” on page 131.

ClientMessagePortNumberIdentifies a secondary port used to accept client messages concerning the progressand ultimate cancellation of a lengthy operation without tying up thread reserves.

Parameter type: optional, static for changes/dynamically set

If no port number is specified in the configuration file, the port number isdynamically chosen and set at server startup. However, it cannot be changed whilethe server is running.

This additional port ensures that other server requests can continue to processwhile waiting for a cancellation from the user.

By default, this port number is automatically and dynamically assigned when theCognos TM1 server starts. You do not have to set ClientMessagePortNumber to aspecific number unless firewalls or other network issues require the listener port tobe a well-known number.

CAUTION:Be sure to assign unique port numbers for the server and client message ports. Ifyou have two servers running on the same machine with the same port number,the message activity may cause a system failure.

See also, “PortNumber” on page 246 and “ProgressMessage” on page 247.

ClientPropertiesSyncIntervalSpecifies the frequency (in seconds) at which client properties are updated in the}ClientProperties control cube. Set to 1800 seconds to update cube every 30minutes.

Frequent updating can cause unnecessary consumption of CPU time and maycause users from connecting/disconnecting until operation completes.

Parameter type: optional, dynamic

ClientVersionMaximumSpecifies the maximum client version that can connect to the TM1 server.

Parameter type: optional, dynamic

The ClientVersionMaximum parameter value is expressed as a version string usingthe following format:

m.n.tffhh

m = major release number,

n = minor release number

t = maintenance release number

226 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 239: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

ff = fix pack number

hh = hot fix number

Using this format, setting ClientVersionMaximum = 9.4.10305 specifies that themaximum client version that can connect to the server is 9.4.1.

If your Tm1s.cfg file does not include a ClientVersionPrecision parameter value,only the major release number, minor release number, and maintenance releasenumber are used to enforce compatability between client and server. Using theabove example,

If ClientVersionMaximum is not explicitly set, the default value is equal to thecurrently installed server version.

Valid parameter values fall within the range x00 - currently installed serverversion, where x is the base version of the currently installed TM1 server. Forexample, valid parameter values for TM1 server 9.0 SP3 fall within the range 900 -903.

You cannot set ClientVersionMaximum to a value greater than the currentlyinstalled server version. You cannot connect newer client versions to older serverversions.

ClientVersionMinimumSpecifies the minimum client version that can connect to the IBM Cognos TM1server.

Parameter type: optional, dynamic

The ClientVersionMinimum parameter value is expressed as a version string usingthe following format:

m.n.tffhh

m = major release number,

n = minor release number

t = maintenance release number

ff = fix pack number

hh = hot fix number

Using this format, setting ClientVersionMinimum = 9.4.10305 specifies that theminimum client version that can connect to the server is 9.4.1.

If your Tm1s.cfg file does not include a ClientVersionPrecision parameter value,only the major release number, minor release number, and maintenance releasenumber are used to enforce compatability between client and server.

If the ClientVersionMinimum parameter is not explicitly set, the default value is8.4.00000, which corresponds to version 8.4.

Appendix B. The Tm1s.cfg Server Configuration File 227

Page 240: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

You should not set ClientVersionMinimum to a value lower than the base versionof the currently installed Cognos TM1 server. There is no upper limit forClientVersionMinimum. However, if ClientVersionMinimum is larger thanClientVersionMaximum, only clients with a version number equal toClientVersionMaximum can connect to the server.

ClientVersionPrecisionThis parameter lets you more precisely identify the minimum and maximumversions of clients that can connect to the IBM Cognos TM1 server.

Parameter type: optional, dynamic

The ClientVersionMinimum and ClientVersionMaximum parameter values areexpressed as a version string using the following format:

m.n.tffhh

m = major release number,

n = minor release number

t = maintenance release number

ff = fix pack number

hh = hot fix number

Using this format, the version string 9.4.10305 indicates major release 9, minorrelease 4, maintenance release 1, fix pack 3, and hot fix 5.

If ClientVersionPrecision is not set in Tm1s.cfg or if it is set to 0, only the majorrelease number, minor release number, and maintenance release number are usedto enforce compatability between client and server. In this case, any client frommajor release 9, minor release 4, maintenance release 1 and more recent canconnect to the server.

You can enforce more precise server and client version compatability by addingClientVersionPrecision to the Tm1s.cfg file and setting the parameter to one of thefollowing values.v 1 - Indicates that the fix pack number will be enforced, but not the hot fix

number.v 2 - Indicates that both the fix pack number and hot fix number will be enforced.

Examples

If ClientVersionMinumum = 9.4.10305 and ClientVersionPrecision = 1, only clientsfrom major release 9, minor release 4, maintenance pack 1, fix pack 3 or later canconnect to the server. In this case, the hot fix number is not enforced whendetermining server/client compatability.

If ClientVersionMinumum = 9.4.10305 and ClientVersionPrecision = 2, only clientsfrom major release 9, minor release 4, maintenance pack 1, fix pack 3, hot fix 5 orlater can connect to the server. In this case, both the fix pack and hot fix numbersare enforced when determining server/client compatability.

228 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 241: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

CognosInterfacePathSpecifies the location of the IBM Cognos Business Intelligence server to use whenimporting data from a Cognos Package to TM1 using the IBM Cognos TM1Package Connector.

See the IBM Cognos TM1 TurboIntegrator Guide for more information.

Parameter type: static, optional/required only when using the Cognos TM1Package Connector.

DataBaseDirectorySpecifies the data directory from which the server loads cubes, dimensions, andother objects.

You can list multiple data directories by separating them with semicolons.

Parameter type: required, static

For details, see “Data directory overview” on page 25.

DefaultMeasuresDimensionIdentifies if a measures dimension is created. IBM Cognos TM1 does not requirethat a measures dimension be defined for a cube. You can optionally define ameasures dimension by modifying the cube properties.

For more information, see the topic, "}CubeProperties", in the IBM Cognos TM1Operation Guide.

Parameter type: optional but some OLAP applications may require this parameter(see description below for details),static

Some OLAP applications do require that a measures dimension be present in allcubes, and may fail if such a dimension is not present. To accommodate theseapplications, set DefaultMeasureDimension=T to instruct the Cognos TM1 server toautomatically define the last dimension in a cube as the measures dimension whena new cube is created on the Cognos TM1 server.

If DefaultMeasureDimension is set to F or is omitted from Tm1s.cfg, a measuresdimension is not defined for when a cube is created.

DisableMemoryCacheDisables the memory cache used by IBM Cognos TM1 memory manager.

Parameter type: optional, static

Enable this parameter only to debug memory leaks. When you enable thisparameter, there might be a decrease in server performance.

For example, when DisableMemoryCache=T is set it disables the memory cache usedby IBM Cognos TM1 memory manager. The default setting isDisableMemoryCache=F.

Appendix B. The Tm1s.cfg Server Configuration File 229

Page 242: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

DisableSandboxingDetermines if users have the ability to use sandboxes across the server.

Parameter type: optional, dynamic

By default, this parameter is not present in the configuration file which enables thesandbox capability for all users.DisableSandboxing=F

When sandboxing is turned on in this way, administrators can Deny or Grant theuse of Personal Workspaces or multiple sandboxes on a per usergroup basis usingCapability Assignments. For more details, see "Capability Assignments" in the IBMCognos TM1 Operation Guide.

To put all usergroups into Direct Writeback mode, add the following line toTm1s.cfg:DisableSandboxing=T

When DisableSandboxing=T, the Capability Assignments are ignored.

DisableWorksheetViewDisableWorksheetView disables any VIEW functions contained in slice worksheets.

Any slice worksheets containing a VIEW function remain functional, but thefunction does not generate a Stargate view.

Parameter type: optional, static

Please contact customer support to determine if this parameter is applicable toyour system.

Generally, you should disable the worksheet VIEW functions when you work withextremely large row or column dimensions in slice worksheets. The VIEW functiongenerates a Stargate view that contains all row and column dimension elements,and not just those elements contained in the current row and column subsets. Withthe Stargate view, you might experience decreased performance when, for example,a row dimension contains 9,000 elements but only 20 elements are actually used inthe row subset.

To disable the slice worksheet VIEW functions, add the following line to Tm1s.cfg:

DisableWorksheetView=T

Display_Info_DBType_R8Display_Info_DBType_R8 instructs the IBM Cognos TM1 server to storeDISPLAY_INFO column data as DBTYPE_R8.

Parameter type: optional, static

Please contact customer support to determine if this parameter is applicable toyour Cognos TM1 system.

By default, Cognos TM1 stores the DISPLAY_INFO as DBTYPE_UI4. When theCognos TM1 OLE DB provider processes a request from ADO 2.7 for the

230 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 243: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

DISPLAY_INFO column data, the provider has to convert Cognos TM1 columndata from DBTYPE_UI4 to a DBTYPE_R8. The Cognos TM1 OLE DB provider thenreturns the converted column data to the OLE DB client (ADO in this case).

ADO 2.7 expects IRowset::GetData to return an integer, and uses only the first 4bytes of the converted column data. However, the returned data is an 8-byte realnumber, and as a result, all information in the last 4 bytes is lost. This causes ADO2.7 to return zeroes for all the items of the DISPLAY_INFO column.

When you include the Display_Info_DBType_R8 parameter in the Tm1s.cfg file andset the parameter to T, the Cognos TM1 server stores DISPLAY_INFO column dataas DBTYPE_R8 with the relevant 4 bytes of information in the first 4 bytes. TheDisplay_Info_DBType_R8 parameter ensures that the information is not lost whenADO converts the data back to an integer of 4 bytes. The parameter also ensuresthat ADO 2.7 returns the correct values for the properties of an axis rowsetmember. Additionally, the parameter ensures that any OLE DB client (such as ADO2.6) requesting the DISPLAY_INFO property as a 4 byte value, gets the correctvalues.

DistributedPlanningOutputDirDistributedPlanningOutputDir defines the directory to which TUnits are writtenwhen a Cognos Insight distributed application is deployed.

Parameter type: optional, static

Cognos Insight distributed clients need information called "tunits". This data iscreated when an application is deployed and is updated as the Cognos TM1 serverruns. The location of the directory used for this purpose is set using thisparameter.

In order to deploy Cognos Insight distributed client applications using thisdatabase, uncomment or add this parameter asDistributedPlanningOutputDir=<location of the tunit directory>.

The pathname specified can be absolute, or relative to the Cognos TM1 server datadirectory.

For example:

Sample setting Action

DistributedPlanningOutputDir=tunit Creates a directory tunit under the CognosTM1 server data directory.

DistributedPlanningOutputDir=../tunit Creates a directory tunit as a sibling to theCognos TM1 server data directory.

DistributedPlanningOutputDir=C:\ProgramFiles\IBM\cognos\tm1\samples\tm1\GO_New_Stores\tunit

Creates a directory tunit at the specifiedlocation.

DownTimeSpecifies a time when the server will come down automatically.

Parameter type: optional, dynamic

The format of the DownTime parameter is dd:hh:mm where:

Appendix B. The Tm1s.cfg Server Configuration File 231

Page 244: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v dd is the number of days from today. (For example, 00 is today, and 01 istomorrow.)

v hhmm is the time of day in 24-hour format.

For example, DownTime = 01:03:30 specifies that you want to bring the serverdown on the following day at 3:30 in the morning.

The DownTime parameter is not available when you run the Cognos TM1 serveras a Windows service.

When you use the DownTime parameter on the UNIX Cognos TM1 server, youmust set the RunningInBackground parameter to T. If RunningInBackground=F, theserver prompts for confirmation before shutting down and cannot shut downwithout manual confirmation from an administrator.

ExcelWebPublishEnabledEnables the publication of Microsoft Excel files to IBM Cognos TM1 Web, as wellas the export of Excel files from Cognos TM1 Web, when Excel is not installed onthe Web Server.

Parameter type: optional, static

If ExcelWebPublishEnabled=T, Excel files in Cognos TM1 Applications can bepublished to Cognos TM1 Web without using Excel on the Web server. Similarly,Websheets and Cubeviewers can be exported from Cognos TM1 Web without usingExcel on the Web server.

When Excel is not available on the Web server, Excel files in Cognos TM1Applications must be explicitly published to Cognos TM1 Web.

For details about the procedure required to publish Excel files, see the IBM CognosTM1 Developer Guide.

For details about limitations exporting from Cognos TM1 Web without using Excelon the Web server, see the IBM Cognos TM1 User Guide.

Restriction: You cannot publish Excel 2007 .xlsx files to Cognos TM1 Web whenExcel is not available on the Web server. These files must be saved in Excel 2003.xls format if you want to publish them to Cognos TM1 Web.

ForceReevaluationOfFeedersForFedCellsOnDataChangeWhen this parameter is set, a feeder statement is forced to be re-evaluated whendata changes.

Parameter type: optional, static

When the IBM Cognos TM1 server computes feeders, the process can be a "chain"of feeders, where cell A feeds cell B, and there is a feeder rule for cell B, so that ruleruns and feeds cell C, etc. Feeders for numeric cells are only evaluated when a cellgoes from empty to some non-zero value since any non-zero value in the cellwould already have set any feeders.

There is no need to re-evaluate the feeders when a cell changes from one non-zerovalue to another.

232 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 245: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Normally, when evaluating feeders, if a feeder rule is evaluated and the target cellis already fed, the feeding process stops.

Feeder rules are not processed any further since the presence of the feeder in thetarget cell indicates that the feeder rules for the target cell have already been run,and there is no need to run them again.

Consider the following feeder rules:['A’]=>['B’];

The feeder rule for cell B depends on some cube data value:[B]=>DB(cube-name,!dim1,DB(cube2-name,...),!dim2);['C’]=>['D’];['X’]=>['B’];

When the feeder rule for B is initially evaluated, the DB(cube2-name,...) isevaluated to produce an element name, such as C. Therefore B feeds C and then Cfeeds D. When that cell X goes from zero to non-zero. This change also feeds B. ButB is already fed, so the feeding process stops, and the feeder rule for B neverevaluates, so any "change" in the output of the rule, which may come aboutbecause of an underlying data change targeted by the DB(...) statement will notbe evaluated. If the config parameterForceReevaluationOfFeedersForFedCellsOnDataChange is set, then the presence of afeeder in cell B will not terminate feeder processing. Rather, the feeder rule for Bwill run. Because the feeder rule for B is data dependent, the target for the feedermay be the former C, or may be some other cell, and that cell will be fed. Note thatsetting this parameter will force more feeder evaluations, which may have aperformance impact.

To turn on this parameter setForceReevaluationOfFeedersForFedCellsOnDataChange=T.

In an earlier release, this parameter was named ReevaluateConditionalFeeders

GroupsCreationLimitSets the maximum number of groups that can be created in one IBM Cognos TM1server session.

Parameter type: optional, static

The GroupsCreationLimit parameter accepts a value of any positive integer. Themaximum number of groups for GroupsCreationLimit is 65535. The maximumnumber of groups that can exist on a server is 65535. If you do not use theparameter, the default number of groups is 20.

For example, to create 50 groups per server session, enter the following line:GroupsCreationLimit=50

Tip: When Cognos TM1 allocates memory to store security information, the servercalculates the amount of memory required based in part on the value ofGroupsCreationLimit. In some circumstances when your Cognos TM1 model islarge and the GroupsCreationLimit parameter is set to an exceptionally high value,the server will attempt to allocate memory beyond the available capacity on theserver. The Cognos TM1 server will fail to load and will issue a Server Out ofMemory message. To avoid this situation, set GroupsCreationLimit to a value thataccurately reflects the maximum number of user groups you may need to createduring a server session.

Appendix B. The Tm1s.cfg Server Configuration File 233

Page 246: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The GroupsCreationLimit value is not enforced when you create groups with theAddGroup function in TurboIntegrator.

IdleConnectionTimeOutSecondsSpecifies a timeout limit for idle client connections, in seconds.

Parameter type: optional, dynamic

For example, if you include the following line in Tm1s.cfg, the server disconnectsidle client connections after 900 seconds.IdleConnectionTimeOutSeconds=900

IntegratedSecurityModeThis parameter sets the user authentication mode to be used by the IBM CognosTM1 server.

Parameter type: optional, static

Although the parameter name focuses on Integrated Security Mode, the 2, 3 and 4settings are used to set other kinds of security.

Use the following format to set this parameter:

IntegratedSecurityMode=x

where x can be a value for one of the following security modes.

Cognos Business Intelligence 8 and 10 are supported.

Security Mode Description

1 The server uses secure mode (standard Cognos TM1 security).

With this authentication, the Cognos TM1 server checks the username and password against the user names and passwords in theCognos TM1 database.

2 This mode allows you to switch back and forth between integratedlogin and native Cognos TM1 security.

3 The server uses Integrated Login.

Integrated Login uses Microsoft Windows network authentication tocontrol access to Cognos TM1 data.

If you use this security mode, you must also set the“SecurityPackageName” on page 251 parameter.

For more details, see “Integrated Login” on page 176.

234 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 247: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Security Mode Description

4 The server uses IBM Cognos BI security authentication.

Considerations when using this mode:

In Cognos TM1, Cognos BI users can belong only to Cognos BIgroups and any of the three internal Cognos TM1 administratorgroups (ADMIN, DataAdmin and SecurityAdmin). Membership inCognos TM1 user (non-administrator) groups is not supported forCognos BI users when they log in to Cognos TM1 .

You can not use Cognos TM1 to permanently assign a Cognos BIuser to another Cognos BI group. Any user assignment you make inCognos TM1 to a Cognos BI group is not saved back to Cognos BI.When a Cognos BI user logs in to Cognos TM1, the groupassignments in Cognos BI override any Cognos BI group assignmentsmade in Cognos TM1 .

5 The server uses IBM Cognos BI security authentication and supportsuser groups from both Cognos TM1 and Cognos BI.

Use security mode 5 when you are running IBM Cognos TM1Applications with IBM Cognos BI security.

Considerations when using this mode:

v In Cognos TM1,Cognos BI users can belong to both Cognos BI andCognos TM1 groups.

v You can not use Cognos TM1 to permanently assign a Cognos BIuser to another Cognos BI group. Any user assignment you makein Cognos TM1 to a Cognos BI group is not saved back to CognosBI. When a Cognos BI user logs in to Cognos TM1 , the groupassignments in Cognos BI override any Cognos BI groupassignments made in Cognos TM1.

IPAddressThis parameter lets you specify multiple IP addresses for an individual IBMCognos TM1 server.

For example, a server can use one IP address for clients within a firewall and adifferent IP address for clients outside the firewall.

Parameter type: optional, static

Note: When this parameter is used in the Tm1s.cfg file, both the Cognos TM1Server and Admin Server must run on the same computer. If this parameter isused in the Tm1s.cfg file, but the Cognos TM1 Server and Admin Server reside ondifferent computers, Cognos Cognos TM1 clients will receive an error when theyattempt to log in to the Cognos TM1 Server.

If the Cognos TM1 Server and Admin Server reside on different computers, youcan configure the Admin Server to use multiple IP addresses for an individualCognos TM1 Server by adding an initialization file named Tm1admsrv.ini to thedirectory where the Admin Server executable resides.

Appendix B. The Tm1s.cfg Server Configuration File 235

Page 248: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The syntax for Microsoft Windows uses as element separator a semicolon, forexample the following setting specifies two IP addresses for the TM1 server:IPAddress="130.5.32.0; 130.5.64.0"

Attention: The addresses must be enclosed in a single set of quotation marks andseparated by a semicolon.

When you specify multiple IP addresses for a server, the associated Admin Serverrecognizes all addresses but displays only the first IP address in the Admin Serverwindow.

The syntax for UNIX uses as element separator a colon. For exampleIPAddress=130.5.32.0: 130.5.64.0

IPVersionThis parameter indicates the Internet protocol used by the IBM Cognos TM1 serverto identify IP addresses on the network.

For example, to specify that your network uses the IPV6 protocol, add theparameter IPVersion=ipv6 to the tm1s.cfg file.

Parameter type: optional, static

Valid settings are:v ipv4

Default setting. Used for IPv4 networks.v dual

Used to transition from IPv4 to IPv6. Both protocols are supported.v ipv6

Used for IPv6 networks.

Configuration notes

If you set this parameter to ipv6 or dual, use the Cognos Configuration tool tochange the TM1 Admin Server IP support option to reflect the change.

To allow clients to recognize this change, add and set the TM1_IPVersionenvironment variable in the operating system to ipv6 or dual.

Setting this parameter to dual or IPV6 without having the appropriate networkrunning can result in performance degradation.

Note: In some cases, depending on your network environment and DNSconfiguration, you may need to also add the IPv6 address to the /etc/hostsoperating system file on UNIX and Microsoft Windows to successfully run theCognos TM1 Admin Server and Cognos TM1 Server in IPv6 mode.

For complete details on configuring all Cognos TM1 components to use IPv6, see“Configuring Cognos TM1 to use IPv6” on page 145.

236 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 249: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

JobQueuingTurns on queuing for Personal Workspace or Sandbox submissions.

Parameter type: optional, static

Set this parameter to JobQueuing=T to have all sandbox submissions to processusing the Job Queue. When this parameter is set to F or not in the configurationfile, sandbox submissions do not process in a queue.

When this parameter is turned on, the submission icon displays on the toolbar.

See the Job Queuing description in the Sandbox and Writeback chapter of theIBMCognos TM1 User Guide for details.

JobQueueMaxWaitTimeWhen the queue thread runs, it blocks all incoming requests to ensure it can getthe locks necessary to process a job on the queue.

New requests are blocked for the amount of time set in the JobQueueMaxWaitTimeparameter.

Parameter type: optional, static

Defaults to 100ms.

If the currently executing requests have not completed in this time, the queuethread goes back to sleep for JobQueueThreadSleepTime and incoming requests areallowed to proceed.

To give the queue thread higher priority, set the JobQueueMaxWaitTime to a largernumber.

If the JobQueueMaxWaitTime parameter is set to zero in the configuration file andJob Queuing is turned on, the queue will keep trying until it can process,effectively locking out any other activity until it is complete.

See Job Queuing in the IBM Cognos TM1 User Guide for more details.

JobQueueThreadPoolSizeThe JobQueueThreadPoolSize parameter enables IBM Cognos TM1 to use multiplethreads to process the Cognos TM1 Job Queue, providing greater thru-put andprocessing of sandbox requests when the Cognos TM1 server is configured to useParallel Interaction. When the server is not running in Parallel Interaction mode,this parameter has no effect, and only a single thread is used to process requests inthe Job Queue.

Parameter type: optional, static

By default, if this parameter is not set when the Cognos TM1 server is running inParallel Interaction mode, then Cognos TM1 uses a value of 1 and the Cognos TM1server uses only a single thread to process requests in the Job Queue.

Configure this parameter in the Tm1s.cfg file using the following format:

Appendix B. The Tm1s.cfg Server Configuration File 237

Page 250: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

JobQueueThreadPoolSize=x

where x represents the number of threads you want to use for processing CognosTM1 Job Queue requests.

For example:

JobQueueThreadPoolSize=3

By default, if this parameter is not set, then Cognos TM1 uses a value of 1.

JobQueueThreadSleepTimeJobQueueThreadSleepTime determines the frequency with which the threadprocessing the queue runs when there are queued jobs.

Parameter type: optional, static

Defaults to 10 seconds.

LanguageSets the language used for the IBM Cognos TM1 server. This parameter applies tomessages generated by the server and is also used in the user interface of theserver dialog box when you run the server as an application instead of a Windowsservice.

Parameter type: optional, static

Valid values currently are:

Language Code

Brazilian Portuguese bra

Croatian hry

Czech csy

Chinese (Simplified) sch

Chinese (Traditional) tch

Danish dan

German deu

Spanish esp

Finnish fin

French fra

Hungarian hun

Italian ita

Japanese jpn

Kazakh kaz

Korean kor

Norwegian nor

Polish pol

Romanian rom

238 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 251: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Language Code

Russian rus

Swedish sve

Turkish trk

LDAPUseServerAccountDetermines if a password is required to connect to the server when using LDAPauthentication.

Parameter type: optional, staticv To connect directly to the LDAP server using integrated authentication, set this

parameter to T. Set this parameter to T whenever the IBM Cognos TM1 serverand LDAP server exist on the same domain.

v To use a password before connecting, set this parameter to F. WhenLDAPUseServerAccount is set to F, you must also set the “LDAPPasswordFile”on page 185 and “LDAPPasswordKeyFile” on page 185 to successfully connectto the LDAP server using SSL.

LDAPPasswordFileDefines the password file used when LDAPUseServerAccount is not used. This isthe full path of the .dat file that contains the encrypted password for the IBMCognos TM1 server Admin Server's private key.

Parameter type: optional unless “LDAPUseServerAccount” on page 184=F, static

This parameter uses the full path to a .dat file.

LDAPPasswordKeyFileDefines the password key used when LDAPUseServerAccount is not used.

Parameter type: optional unless “LDAPUseServerAccount” on page 184=F, static

This parameter uses the full path of the .dat file that contains the key used toencrypt and decrypt the password for the private key.

This file must be generated using the tm1crypt utility, as described in “Runningthe TM1Crypt utility” on page 205.

LockPagesInMemoryWhen this parameter is enabled, Windows trims pages from the IBM Cognos TM1process space, but does not page them to disk.

Parameter type: optional, static

If a Cognos TM1 server running on a Windows 64-bit operating system is idle for along period of time, physical memory taken up by the Cognos TM1 server willpage out to disk. This is a function of the Windows 64-bit operating system andnot Cognos TM1 . This can cause performance degradation in large Cognos TM1databases when trying to access data after an idle period.

Appendix B. The Tm1s.cfg Server Configuration File 239

Page 252: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

To maximize performance when running a large Cognos TM1 database on 64-bitWindows, set LockPagesInMemory=T in the Tm1s.cfg file.

When this parameter is enabled, Windows still trims pages from the Cognos TM1process space, but does not page them to disk. This benefits Cognos TM1 serverperformance because objects are no longer placed in virtual memory, but insteadremain in physical RAM.

LoggingDirectorySpecifies the directory to which the server saves its log files.

If you do not supply this parameter, the log files are saved to the first datadirectory specified by the DataBaseDirectory parameter.

Parameter type: optional,static

Note: The value of parameter LoggingDirectory must be encapsulated by quotes ifit uses spaces, for example LoggingDirectory=C:/Data Files/Logfiles. TheCognos TM1 Server startup will fail if quotes are not used in that case. Note alsothat other parameters, such as DataBaseDirectory, do not necessarily require quoteswhen a value contains spaces.

LogReleaseLineCountSets the number of lines that a search of the Transaction Log will accumulate in alocked state before releasing temporarily so that other Transaction Log activity canproceed.

Parameter type: optional, static

By default this value is set at 5000 lines.

MaskUserNameInServerToolsDetermines whether or not user names in server administration tools (TM1 Topand TM1 Operations Console) are masked until a user is explicitly verified ashaving administrator access.

Parameter type: optional, static

When MaskUserNameInServerTools is set to TRUE, user names are masked inserver administration tools until the user who is working in the administration toolis explicitly verified as an administrator. Please refer to the IBM Cognos TM1Operations Console Guide for details on verifying administrator access to theOperations Console. See the IBM Cognos TM1 Operation Guide for details onverifying administrator access to TM1 Top.

When MaskUserNameInServerTools is set to FALSE, user names are displayed inserver administration tools to all users regardless of administrator status.

If MaskUserNameInServerTools is not present in Tm1s.cfg, the default behavior isto display user names in server administration tools to all users regardless ofadministrator status.

240 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 253: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

MaximumCubeLoadThreadsSpecifies whether the cube load and feeder calculation phases of server loading aremulti-threaded, so multiple processor cores can be used in parallel.

This results in decreased server load times.

Parameter type: optional, static

To run in multi-threaded mode, you should set MaximumCubeLoadThreads to thenumber of processor cores on the Cognos TM1 server that you want to dedicate tocube loading and feeder processing.

Generally, the best performance is achieved when the parameter is set to a valueequal to (number off available processor cores) - 1. For example, if the Cognos TM1server is running on a computer with four processor cores,MaximumCubeLoadThreads should be set to 3. This ensures that one processorcore is available to run other applications while the Cognos TM1 server is loading.

When MaximumCubeLoadThreads is set to 0, cube loading and feeder processingis NOT multi-threaded. This is the default behavior whenMaximumCubeLoadThreads is not explicitly set in the Tm1s.cfg file.

Note: When MaximumCubeLoadThreads is enabled, Cognos TM1 cannot managethe order in which feeders are calculated. There may be cases where processingorder has an adverse effect on your application due to some order-of-evaluationdependencies in the multi-threaded environment.

If your Cognos TM1 model uses conditional feeders where the condition clausecontains a fed value, you should set MaximumCubeLoadThreads=0 or exclude theparameter from the Tm1s.cfg file to disable the use of multiple threads at loadtime.

MaximumLoginAttemptsSets the maximum number of failed user login attempts permissible on the server.

If you do not include MaximumLoginAttempts in Tm1s.cfg, by default, the serverallows three login attempts.

Parameter type: optional, dynamic

For example, if you add the line MaximumLoginAttempts=5 to Tm1s.cfg, theserver enforces a limit of five failed login attempts per user. If a user does notsuccessfully log in to the Cognos TM1 server within the specified number ofattempts, the server issues an error.

After a user has exceeded the specified maximum number of failed login attempts,the Cognos TM1 server rejects any subsequent login attempts by the user.

The MaximumLoginAttempts parameter is enforced per server session. If a userexceeds the maximum number of attempts, he cannot log in to the current CognosTM1 server session, unless the Cognos TM1 administrator changes his password.However, after the Cognos TM1 server recycles, the user can log in with hisexisting password.

Appendix B. The Tm1s.cfg Server Configuration File 241

Page 254: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

MaximumMemoryForSubsetUndoSets the maximum amount of memory, in kilobytes, to be dedicated to storing theUndo/Redo stack for the Subset Editor.

For example, adding the line MaximumMemoryForSubsetUndo=20480 to theconfiguration file instructs the server to allot 20480 kilobytes (20 MB) of memoryfor the Undo/Redo stack.

Parameter type: optional, dynamic

Generally, larger subsets require greater amounts of memory to store a usableUndo/Redo stack. If you find that the Cognos TM1 server is not storing asufficient number of Undo/Redo steps for your subsets, increase the value ofMaximumMemoryForSubsetUndo.

If this parameter is not explicitly set in the Tm1s.cfg file, the maximum amount ofmemory dedicated to the Undo/Redo feature of the Subset Editor is 10240kilobytes (10 MB).

MaximumSynchAttemptsSets the maximum number of times a synchronization process on a planet serverwill attempt to reconnect to a network before the process fails.

Parameter type: optional, static

You can use the MaximumSynchAttempts parameter to improve the stability of asynchronization process that is running over an unstable network connection suchas a long distance wide area network (WAN) with high latency, poor bandwidthand poor transmission quality.

To specify the maximum number of times a synchronization process shouldattempt to make a network connection, add the following line to Tm1s.cfg for theplanet server:

MaximumSynchAttempts=n

where n represents the number of network connection attempts that thesynchronization process should make a before the process fails.

The default value is 1 which means the synchronization process will only attemptto connect once and will not attempt to reconnect if the connection is lost. Thisdefault behavior is the same behavior as Cognos TM1 versions prior to 9.5.1 wherea synchronization process would fail if the network connection was lost.

A value of 0 means unlimited network connection attempts.

You can configure this parameter to work with the SyncUnitSize parameter. Formore information, see “SyncUnitSize” on page 255.

The following example shows how to use the MaximumSynchAttempts parameterwith the SyncUnitSize parameter:SyncUnitSize=2000

MaximumSynchAttempts=100

242 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 255: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

MaximumTILockObjectsA server configuration parameter that sets the maximum lock objects for aTurboIntegrator process. Used by the synchronized() TurboIntegrator function.

The server maintains a list of created TurboIntegrator lock objects. Every time theuser calls the synchronized() function on a lock object, the server first checks to seeif the lock object is already in the list. If not, the server creates a new lock objectand inserts it into the list.

For more details, see the topic "Serializing TurboIntegrator processes usingsynchronized()" in the IBM Cognos TM1 TurboIntegrator Guide.

Even after all the TurboIntegrator processes that have referenced a lock object haveexited, the lock object may not be removed from the list to free the memoryimmediately. This is because it is likely that sometime later, either the same processor some other process may call the synchronized() function on that same lockobject.

The server configuration parameter MaximumTILockObjects in tm1s.cfg controls thegrowth of the list of created TurboIntegrator lock objects. When the number of lockobjects in the list has reached MaximumTILockObjects, the server starts a cleanupoperation. It removes some lock objects from the list if they are not used by anyTurboIntegrator process at that moment.

If the MaximumTILockObjects parameter is not explicitly set in tm1s.cfg, a defaultvalue of 2000 is assumed.

Parameter type: optional, static

MaximumUserSandboxSizeSets the maximum amount of RAM memory (in MB) to be allocated per user forpersonal workspaces or sandboxes.

If you do not set the MaximumUserSandboxSize parameter, the default maximumsize is 100 MB on a 32-bit system, and 500 MB on a 64-bit system.

Parameter type: optional, dynamic

To specify a maximum amount of memory allocation for personal workspaces orsandboxes, add the following line to Tm1s.cfg:

MaximumUserSandboxSize=n

where n represents the amount of memory in MB to be allocated.

MaximumViewSizeSets the maximum amount of memory (in MB) to be allocated when a useraccesses a view.

If you do not set the MaximumViewSize parameter, the default maximum viewsize is 100MB on a 32-bit system, and 500 MB on a 64-bit system.

Parameter type: optional, dynamic

Appendix B. The Tm1s.cfg Server Configuration File 243

Page 256: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

To specify a maximum amount of memory allocation for views, add the followingline to Tm1s.cfg:MaximumViewSize=n

where n represents the amount of memory in MB to be allocated.

MaxUndoHoldLineCountMaxUndoHoldLineCount determines how long an Undo or Redo operation locksthe Tm1s.log file.

Parameter type: optional, dynamic

When the Tm1s.log file grows to sizes of 1 GB or larger, an Undo or Redooperation can lock the Tm1s.log file for an unacceptably long period, preventingother threads from accessing the log file. MaxUndoHoldLineCount lets you specifythe interval, expressed as the number of records to be processed between lockreleases, at which an Undo or Redo operation allows other threads to access theTm1s.log file.

To specify the interval at which the Cognos TM1 server should release the lock onthe Tm1s.log file, add the following line to Tm1s.cfg:MaxUndoHoldLineCount=n

where n represents the number of records to be processed before an Undo/Redooperation relinquishes and reacquires the lock on Tm1s.log. WhenMaxUndoHoldLineCount is set, an Undo/Redo operation processes the number ofrecords specified by the parameter value, then releases the lock, alows otherthreads to access the log file, and reacquires the lock.

If MaxUndoHoldLineCount is not explicitly set, the default value is 5000.

MessageCompressionEnables message compression for large messages that significantly reduces networktraffic.

The parameter is enabled by default.

Parameter type: optional, static

To disable message compression, add the following line to Tm1s.cfg:MessageCompression=F

NetRecvBlockingWaitLimitSecondsChanges the way the maximum time the server waits for a client to send the nextrequest from one long wait to shorter wait periods so a thread may be cancelled ifneeded.

The parameter is enabled by default.

Parameter type: optional, static

By default the server can wait for a long time for input, which can result inlong-held threads and other problems.

244 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 257: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

This parameter instructs the Cognos TM1 server to perform the wait as a series ofrepeated shorter waits and gives the server the opportunity to cancel or pause thethread. When set to zero (the default) the legacy behavior of one long wait is used.

NetRecvMaxClientIOWaitWithinAPIsSecondsMaximum time for a client to do I/O within the time interval between arrival ofthe first packet of data for a set of APIs through processing until response has beensent.

Parameter type: optional, static

Requires the client to handle I/O in a reasonably timely fashion after initiating APIrequests. This parameter is designed to protect against connections that go deadbut do not raise a socket error or create other possibilities such as a hung client.

Default value is 0 which means no time limit.

ParallelInteractionTurns Parallel Interaction on or off for all of the user-created and control cubes inan IBM Cognos TM1 server.

Parallel Interaction is a Cognos TM1 server-related feature that allows for greaterconcurrency of read and write operations on the same cube object. For moredetails, see "Using Parallel Interaction with a Cognos(r) TM1(r) server" in the IBMCognos TM1 Operation Guide.

Parameter type: optional, static

As of Cognos TM1 version 10.1, Parallel Interaction is enabled by default whichuses Parallel Interaction for all cubes in the TM1 server.

To manually disable Parallel Interaction for all cubes, set ParallelInteraction=F.

PasswordMinimumLengthSpecifies a minimum password length for clients accessing the server.

Parameter type: optional, dynamic

For example, set PasswordMinimumLength=8 to enforce a minimum password lengthof 8 characters.

Note: This parameter only affects passwords set or changed after the parameterhad been set. It has no effect on old, unchanged passwords having less charactersas enforced by PasswordMinimumLength

PasswordSourceCompares user-entered password to the stored password.

Parameter type: optional, static

Cognos TM1 (Default): Compares the user-entered password to the password inthe Cognos TM1 database.

Appendix B. The Tm1s.cfg Server Configuration File 245

Page 258: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

LDAP: Compares the user-entered password to the password stored in on theLDAP server.

PerformanceMonitorOnAutomatically starts populating the }Stats control cubes when a server starts.

The control cubes contain statistics that you can review to monitor the systemperformance. For details on control cubes, see "Control Cubes" in the IBM CognosTM1 Operation Guide.

Parameter type: optional, static

For example, to enable Performance Monitor set PerformanceMonitorOn=T. Todisable the Performance Monitor set PerformanceMonitorOn=F

PersistentFeedersTo improve reload time of cubes with feeders, set the PersistentFeedersconfiguration parameter to true (T) to store the calculated feeders to a .feeders file.

Any installation with server load times of over 5 minutes can probably improvetheir performance using this parameter.

Parameter type: optional, static

When this parameter is set to T and the server encounters a persistent feeder file, itloads the saved feeders which reduces the time normally taken to recalculate thosefeeders. Feeders are saved when the data is saved or rules are edited. You do notexplicitly save the feeders

For installations with many complex feeder calculations persisting feeders and thenre-loading them at server startup will improve performance. For simple feeders,the time taken to read feeders from disk may exceed the time to re-calculate thefeeders but most installations will benefit.

Using the Persistent Feeders feature will increase your system size on disk only.Memory size is not affected by the use of this parameter.

PersistentFeeders=T

For more information, see "Using Persistent Feeders" in the IBM Cognos TM1Operation Guide.

PortNumberSets the server port number used to distinguish between multiple servers runningon the same computer.

When multiple IBM Cognos TM1 servers are installed on a single computer, eachserver must use a unique port number.

Parameter type: optional, static

When you install a Cognos TM1 server, the default port number is 12345. Validport numbers are between 5001 and 49151.

246 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 259: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

If the Tm1s.cfg file does not contain the PortNumber parameter, the Cognos TM1server uses port 5000. Local Cognos TM1 servers use port 5000. The port used forClient Messages must also be a unique port number and is set to 5001 by defaultwhen the ClientMessagePortNumberparameter is used.

PrivilegeGenerationOptimizationWhen the TM1 server generates security privileges from a security control cube, itreads every cell from that cube.

If the security control cube is sparsely populated, this results in unnecessaryprocessing and a longer loading time. An example of a sparsely populated securitycube would be one that has a greater ratio of default security settings compared todefined security settings.

Parameter type: optional, static

To address this issue, the PrivilegeGenerationOptimization parameter can be addedto the Tm1s.cfg file as follows:PrivilegeGenerationOptimization=T

When this parameter is set to T, the Cognos TM1 server will read only thepopulated cells in security cubes. In the case of a sparsely populated security cube,this will dramatically shorten the Cognos TM1 server's load time.

Note: If you populate the security settings via rules and want to use thisparameter, you must write feeders for the rules that populate your security cubes.Because security settings are stored as strings, the rules that populate your securitycubes must include the FeedStrings function.

ProgressMessageThis parameter determines whether users have the option to cancel lengthy viewcalculations.

When a user opens a view that takes a significant amount of time to calculate(usually a view with high levels of consolidation or complex rules), IBM CognosTM1 monitors the progress of the process. When ProgressMessage=T a dialog boxopens that allows the user to Stop Building View.

Parameter type: optional, static

If the user clicks Stop Building View, the view is discarded on the client, but viewcalculation continues on the server. In some instances, this can tie up the server.v If ProgressMessage=F, the Stop Building View option is not offered and the user

cannot cancel lengthy operations. This setting helps avoid potential server tieups in versions 9.1 SP3 through 9.4.

v When ProgressMessage=T or is not present in the Tm1s.cfg file, the StopBuilding View option opens during lengthy view calculations so the user cancancel the process if necessary. For versions 9.4 or later, the user can assign aunique Port Number using ClientMessagePortNumber. This additional portallows these progress messages to travel via a secondary port so that serverprocessing can continue without tying up thread reserves.

Note: To avoid potentially tying up servers, Cognos TM1 9.1 SP3 through 9.4 haveProgressMessage=F inserted into the Tm1s.cfg file during server installation. As of

Appendix B. The Tm1s.cfg Server Configuration File 247

Page 260: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos TM1 9.4, progress messages can travel via the secondary port assigned byClientMessagePortNumber so Cognos TM1 9.4 and later have ProgressMessage=Tset by default.

ProportionSpreadToZeroCellsAllows you to perform a proportional spread from a consolidation withoutgenerating an error when all the leaf cells contain zero values.

In this case, Cognos TM1 applies an equal spread to the empty cells when theProportionSpreadToZeroCells parameter is enabled. This functionality is enabledby default in Cognos TM1 9.5.2 and later.

Parameter type: optional, static

Behavior when ProportionSpreadToZeroCells is enabled

This parameter and functionality are enabled by default, allowing you to completea spread operation without an error when you perform a proportional spread on aconsolidation where all the leaf cells are zero. In this scenario, Cognos TM1converts the typed entry of "P###" to "LS*###" and applies the spread as an equalspread.

When this parameter is enabled and data exists in any of the leaf cells, the behavioris the same as previous versions of Cognos TM1 when performing a proportionalspread.

This parameter is on by default and it is not necessary to enable it. However, ifyou want to explicitly configure it, set the ProportionSpreadToZeroCells parameterto T (True) in the Tm1s.cfg configuration file as follows.

ProportionSpreadToZeroCells=T

Behavior when ProportionSpreadToZeroCells is disabled

Setting this parameter to F (False) disables this feature and provides the samebehavior as pre-9.5.2 versions of Cognos TM1. An error displays when you try toperform one of the following proportional spreading operations:v In TM1 Contributor - Enter a number in a consolidated cell where all of the leaf

cells for that consolidation contain zeros.v In TM1 Contributor and other TM1 clients - Perform a proportional spread

operation by either entering a spreading code and number such as "P###" in acell, or access a proportional spread from the right-click menu or TM1 menu(TM1 Perspectives only) when the leaf cells for that consolidation all containzeros.

These operations make the TM1 server perform a proportional spread, but theoperation fails because all of the leaf cells contain zeros.

To disable this new functionality, set the ProportionSpreadToZeroCells parameterto F (False) in the Tm1s.cfg configuration file as follows.

ProportionSpreadToZeroCells=F

248 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 261: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

RawStoreDirectoryIndicates the location of the temporary, unprocessed log file for audit logging iflogging takes place in a directory other than the data directory.

Parameter type: optional, dynamic.

If this parameter is not entered, by default the unprocessed audit log file is savedin the directory listed in the DataBaseDirectory parameter.

For details on other audit logging parameters, see “AuditLogMaxFileSize” on page222, “AuditLogMaxQueryMemory” on page 223, “AuditLogMaxTempFileSize” onpage 223, “AuditLogOn” on page 223, and “AuditLogUpdateInterval” on page 224.

ReceiveProgressResponseTimeoutSecsThe ReceiveProgressResponseTimeoutSecs parameter configures the server to severthe client connection and release resources during a long wait for a Cancel action.

Parameter type: optional, dynamic

When the Cognos TM1 server is performing lengthy operations for a client,periodic "progress" messages are sent to the Cognos TM1 client application. Theclient responds to these messages with an indication of whether the user haspressed the Cancel button, in which case the lengthy operation is terminated.These responses are generated automatically by the network code in the clientapplication; there is no user interaction involved. After sending the progressmessage the server waits for a response from the client application. As the server iswaiting, the client's thread will continue to hold resource locks on the Cognos TM1server, preventing other users from making other server requests which require thesame resource locks.

In some particular situations, most notably running Cognos TM1 clients under aCitrix environment, the response from the client application never arrives back atthe Cognos TM1 server, causing the server to wait for an infinite amount of time.This results in a system lockup, because the client's thread holds resource locksthat are never released.

The ReceiveProgressResponseTimeoutSecs parameter lets you configure your serverto detect this situation and to sever the client connection, releasing the resources.When the parameter is set to a valid interval (in seconds), the server process willterminate the client connection, releasing any resource locks, if the server does notdetect the client application's response within the specified interval.

For example, if ReceiveProgressResponseTimeoutSecs=20 and the client applicationdoes not respond to the progress message sent from the server within 20 seconds,the client connection is terminated. Again, no user action is required to generatethis response. The response is automatically generated by the client application, sothat if the response does not arrive within 20 seconds, it is an indication that thereis something seriously wrong with the client or the underlying network.

ReceiveProgressResponseTimeoutSecs is an optional Tm1s.cfg parameter. If theparameter is not present in the Tm1s.cfg file, processes are not terminated when aclient does not respond to a progress message from the Cognos TM1 server.

For some Cognos TM1 installations (version 9.4 or later), theClientMessagePortNumber defines a separate thread to use for cancellation

Appendix B. The Tm1s.cfg Server Configuration File 249

Page 262: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

messages without tying up reserves. When ClientMessagePortNumber is available,ReceiveProgressResponseTimeoutSecs is not used.

RunningInBackgroundWhen you add the line RunningInBackground=T to Tm1s.cfg, the UNIX IBM CognosTM1 server runs in background mode.

Parameter type: optional, static

RulesOverwriteCellsOnLoadPrevents cells from being overwritten on server load in rule-derived data.

Parameter type: optional, static

During the processing of feeders for a cube, a cube's value can be wiped out ifthere is a rule for that cell. Once the cube which had a cell wiped out is saved, thevalue is gone so the action has no effect on the cube. However, if the rule is editedbut the cube is not subsequently modified, the cube is not saved to disk. In thatcase, real cell values may be wiped out when the rules run.

The RulesOverwriteCellsOnLoad parameter can be used to prevent the zeroing outaction after a rule is edited.

If you are changing rules and the rules may, due to various edits, cause some cellswhich have data to become rule-derived, add RulesOverwriteCellsOnLoad=F tothe configuration file.

If this parameter is set to True or is not present, whenever the server loads,rule-derived cells are wiped to zero. The data value in those cells is lost even if therule is subsequently changed so that the cell is no longer rule-derived.

By default this parameter is not present in the configuration file or is set to True.RulesOverwriteCellsOnLoad=F

SAPLoggingEnabledWhen a TurboIntegrator process imports objects and/or data from SAP RFC, youcan configure your IBM Cognos TM1 server to log all activity between CognosTM1 and SAP.

Parameter type: optional/used only in 9.0 software. Use a property to set thisvalue in 9.1 and higher versions; static

When a TurboIntegrator process imports objects and/or data from SAP RFC, youcan configure your Cognos TM1 server to log all activity between Cognos TM1and SAP.

Add the line SapLoggingEnabled=T to your Tm1s.cfg file to enable SAP logging. Ifthis parameter is not present in the Tm1s.cfg file, or if the parameter is set to F,SAP activity is not logged.

If SapLoggingEnabled=T you must also set the SapLogFilePath parameter.

SAPLogFilePathThis parameter sets the log file to receive SAP logging information.

250 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 263: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter type: optional/used only in 9.0 software. Use a property to set thisvalue in 9.1 and higher versions; static

Specify the full path to the log file, for example, SapLogFilePath=c:\SAPdata\tm1_sap.log.

SaveTimeSets the time of day to execute an automatic save of server data; saves the cubesevery succeeding day at the same time. As with a regular shutdown, SaveTimerenames the log file, opens a new log file, and continues to run after the save.

Parameter type: optional, dynamic

The SaveTime parameter is not available when running the Cognos TM1 server asa Windows service.

The format of the SaveTime parameter is dd:hh:mm where:v dd is the number of days from today that the system will start automatically

saving data. For example, 00 is today, 01 is tomorrow.v hh:mm is the time of day in 24-hour format.

SecurityPackageNameIf you configure the IBM Cognos TM1 server to use Integrated Login, theSecurityPackageName parameter defines the security package that authenticatesyour user name and password in Microsoft Windows.

Parameter type: optional, static

Valid values are:v Kerberos (default) - supported versions Microsoft Windows.v NTLM - Older Microsoft Windows installations, such as Microsoft Windows NT.

For complete descriptions of all login security modes, including Integrated Login,see “Integrated Login” on page 176.

ServerCAMURISpecifies the URI for the internal dispatcher that the IBM Cognos TM1 servershould use to connect to CAM.

The URI is specified in the form http[s]://host IP address:port/p2pd/servlet/dispatch.

Parameter type: optional, static

For example,http://10.121.25.121:9300/p2pd/servlet/dispatch

orhttps://10.121.25.121:9300/p2pd/servlet/dispatch

ServerLoggingGenerates a log with the security activity details on the IBM Cognos TM1 serverthat are associated with Integrated Login.

Appendix B. The Tm1s.cfg Server Configuration File 251

Page 264: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

The log file, named Tm1server.log, is saved to the Cognos TM1 server datadirectory. The ServerLogging parameter is useful only if your Cognos TM1 serveris configured to use Integrated Login.

Parameter type: optional, static

Set ServerLogging to T in Tm1s.cfg. Note also that if ServerLogging=T is set, youmust rename the Cognos TM1 server message logfile tm1server.log by editing thecorresponding parameter in the logger configuration file tm1s-log.properties file.

ServerNameSets the name of the IBM Cognos TM1 server. If you do not supply this parameter,Cognos TM1 names the server Local and treats it as a local server.

Parameter type: optional, static

ServicePrincipalNameSpecifies the service principal name (SPN) when using Integrated Login with TM1Web and constrained delegation.

Parameter type:v Optionalv Static

If you change this parameter value, restart the TM1 server to apply the newvalue.

Use the following format to add the parameter to the Tm1s.cfg file:

ServicePrincipalName=SPN

The value you set here must match the service name that has also been mapped toa domain account on the Active Directory domain controller using the Microsoftcommand-line tool, setspn.exe.

For example, if you use setspn.exe to add an SPN as follows:

setspn -a FPM/TM1 WbSvr_Account

then you need to set the ServicePrincipalName parameter like this:

ServicePrincipalName=FPM/TM1

For more information about constrained delegation and SPN configuration, searchthe Microsoft Web site for the topic "Kerberos Technical Supplement for Windows".

SkipLoadingAliasesUse SkipLoadingAliases to speed up the loading of the server and updating ofviews by skipping the loading of aliases.

Parameter type: optional, static

Please contact customer support to determine if this parameter is applicable toyour Cognos TM1 system.

252 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 265: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Valid values are:v T - Aliases skippedv F - Aliases loaded

SkipSSLCAMHostCheckIndicates whether the SSL certificate ID confirmation process can be skipped.

The default is False.

Parameter type: optional, static

Important: This parameter should be set to True only if using a generic certificatefor demonstration purposes.

SpreadingPrecisionUse the SpreadingPrecision parameter to increase or decrease the margin of errorfor spreading calculations.

Parameter type: optional, dynamic

Floating point arithmetic on computers is not 100% precise. When a computercalculates very small numbers, a margin of error is applied to the calculation. If thecomputer adds a set of numbers, and the resulting sum is close to the target valuewithin the margin of error, the sum is considered accurate.

The margin of error for certain Cognos TM1 calculations is controlled through theSpreadingPrecision parameter. The default value is SpreadingPrecision=1e-8. Thisvalue is used in the following spreading scenarios:v Spreading from a consolidated cell.v Spreading in leaf cells whose consolidated value has a hold applied.

Spreading from a Consolidation

When you execute a proportional data spread from a consolidated cell, CognosTM1 writes the numbers to each cell in the range, and rolls up the total torecalculate the consolidation. The total of all cells in the consolidation is thencompared to the original value you provided for the spread function. The totalmight be different from the target value because of the rules applied to the n-levelelements or the consolidated cell itself.

If the rules are such that the resultant value does not match the spread desiredvalue, an error will be generated and the spread operation will not be done.

If SpreadingPrecision=1e-8, the total calculated by Cognos TM1 for theconsolidation must be within 0.000001% of the target value (99.999999% accurate),or Cognos TM1 displays an error. An error of more than US$0.01 on a consolidatedspread of US$1,000,000 results in an error.

You can increase or decrease the margin of error for these types of calculationsusing the SpreadingPrecisionparameter.

The following examples include valid values for the SpreadingPrecision parameter:v SpreadingPrecision=1e-4

Appendix B. The Tm1s.cfg Server Configuration File 253

Page 266: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v SpreadingPrecision=1e-8

v SpreadingPrecision=1e-10

v SpreadingPrecision=1e-12

SpreadingPrecision (Consolidated Holds)Specifies the margin of error for spreading consolidated hold calculations.

Parameter type: optional, dynamic

The SpreadingPrecision parameter also has an effect under these conditions:v When you spread values to some leaf cells that roll up into a consolidationv A consolidation with a hold applied to it

For example, suppose you have the consolidation Q1 with values Jan, Feb, andMar.

If Q1- has a consolidated hold applied, and you spread values to Jan and Feb,Cognos TM1 does the following:v Applies the spreading to Jan and Feb.v Adjusts Mar.v Adds the three n-level elements together.v Compares the sum of the n-level elements to the value of Q1.

If the sum is accurate to within the margin of error specified by theSpreadingPrecision parameter, the spread succeeds. If the sum falls outside themargin of error specified by the SpreadingPrecision parameter, Cognos TM1generates an error.

SubsetElementBreatherCountThis parameter manages the way IBM Cognos TM1 handles locking behavior forsubsets.

Parameter type: optional, dynamic

WhenSubsetElementBreatherCount=-1

The Cognos TM1 server never releases the lock on subsets when other requests forthe subset are pending. This setting is the default. It can optimize viewperformance for a single user, but at the cost of multi-user concurreny.

WhenSubsetElementBreatherCount=0

the Cognos TM1 server releases the lock on subsets when other requests for thesubset are pending, then reacquires the lock after pending requests are processed.This setting improves performance when multiple users attempt to access the samesubset, particularly when the subset contain more than 100 elements.

StartupChoresStartupChores is a configuration parameter that identifies a list of chores that runat server startup.

254 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 267: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Parameter type: optional, static

To run a chore at startup before users login or other scheduled chores run, add thisparameter with the names of the chores to run separated by a colon, for example:StartupChores=ChoreName1:ChoreName2:ChoreName3:ChoreNameN

If this parameter is not specified, then no Chores will be run. If the name specifieddoes not match an existing Chore then an error is written to the server log andexecution continues to the next Chore.

The value of the configuration parameter can be retrieved by a client application asa Server property called StartupChores using the existing TM1ObjectPropertyGetcall.

This is a read-only property and set operations are rejected. The value of theproperty can be changed only by editing the configuration file and restarting theserver.

SyncUnitSizeSets the frequency of saving a check point during a synchronization process in casethere is a network connection failure.

Parameter type: optional, static

Note: When you use SyncUnitSize, you must also configure theMaximumSynchAttempts parameter. For more information, see“MaximumSynchAttempts” on page 242.

If you configure both the SyncUnitSize and MaximumSynchAttempts parametersand a synchronization process is interrupted by a network connection failure, theprocess will attempt to reconnect and complete the synchronization starting fromthe last check point.

To set this parameter, add the following line to the Tm1s.cfg file for the planetserver:SyncUnitSize=n

where n represents the number of synchronization records written to thetransaction log file, Tm1s.log, after which a check point will be saved.

The default value is 1000.

The minimum recommended value is 500.

UserDefinedCalculationsEnables user-defined consolidations on an IBM Cognos TM1 server.

Parameter type: optional, dynamic

By default, UserDefinedCalculations is enabled.

To disable user-defined consolidations on a server, add the following line toTm1s.cfg:UserDefinedCalculations=F

Appendix B. The Tm1s.cfg Server Configuration File 255

Page 268: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

UseLocalCopiesforPublicDynamicSubsetsAllows public dynamic subsets to improve performance and reduce locking byusing local copies of the subset when possible.

By default, or if the parameter is not present in the tm1s.cfg file,UseLocalCopiesforPublicDynamicSubsets is enabled. To restore the earlier methodof saving Dynamic Subsets, set this parameter to F.

Parameter type: optional, static

UseSQLFetch UseSQLFetchScroll UseSQLExtendedFetchThese parameters instruct IBM Cognos TM1 to use a particular fetch call.

Parameter type: optional, dynamic

When you run TurboIntegrator process that extracts information from an ODBCdata source, Cognos TM1 tries to use the most efficient SQL fetch call possible.Cognos TM1 queries the ODBC driver to determine which of the following SQLFetch calls to use to extract the data:

SQLFetch(), an ODBC 1 function

SQLFetchScroll(), an ODBC 2 function

SQLExtendedFetch(), an ODBC 3 function

These parameters are all dynamic.

If Cognos TM1 receives no response when it queries the ODBC driver, yourCognos TM1 process will result in an error unless one of the following parametersis set to T in your Tm1s.cfg file:

UseSQLFetch

UseSQLFetchScroll

UseSQLExtendedFetch

These parameters instruct Cognos TM1 to use a particular fetch call. You mustensure that the call specified in Tm1s.cfg is appropriate for the ODBC driver beingaccessed, and you can specify only one of these parameters in Tm1s.cfg.

For example, to instruct the Cognos TM1 server to use the SQLExtendedFetch() callto extract data from an ODBC source, add the following line to Tm1s.cfg:UseSQLExtendedFetch=T

UseSSLEnables or disables SSL on the Cognos IBM TM1 server.

Parameter type: optional/required to use SSL; static

Set UseSSL=T to enable SSL. With this setting, only Cognos TM1 9.1 and laterclients will be able to securely connect to the server.

256 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 269: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Set UseSSL=F to disable SSL. With this setting, all Cognos TM1 clients, includingolder clients that do not support SSL, will be able to connect to the server ininsecure mode.

When UseSSL=T, you must set several other Tm1s.cfg parameters that manage SSLimplementation. For details on these parameters, see “Using SSL for datatransmission security” on page 192.

UseStargateForRulesIndicates if a rule uses the Stargate view.

Parameter type: optional, static

By default, any time a rule references a calculated value, the value is retrievedfrom a Stargate view stored in memory (if available). Using the Stargate view forrules, in most cases, results in a significant improvement in performance. It is moreefficient to retrieve a calculated value from memory than to request and retrieve acalculation from the server.

In some unique instances that are difficult, if not impossible, to determine inadvance and can only be determined through trial and error, retrieving a calculatedvalue from a Stargate view is actually slower than requesting and retrieving thevalue from the server. In these instances, add the following line to Tm1s.cfg toinstruct the Cognos TM1 rules to always retrieve the calculated values from theserver and improve performance.UseStargateForRules=F

Please contact customer support before adding the UseStargateForRulesparameter.

ViewConsolidationOptimizationEnables or disables view consolidation optimization on the IBM Cognos TM1server.

Parameter type: optional, static

Using this parameter improves the performance of calculating consolidatedelements. By default, ViewConsolidationOptimization is enabled on the CognosTM1 server.

View consolidation optimization stores the consolidated values that use leafelement components on either the row or column axis. For example, consider thedimension structure Year, 1Quarter with values Jan, Feb, and Mar.

When either a row or column subset uses the Jan element, both the 1 Quarter andYear consolidations are calculated and stored for future reference. This improvesperformance but increases the amount of memory required for a given view.

To disable view consolidation optimization, add the following line to Tm1s.cfg:

ViewConsolidationOptimization=F

Appendix B. The Tm1s.cfg Server Configuration File 257

Page 270: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

ViewConsolidationOptimizationMethodThis parameter defines the method used to achieve view consolidationoptimization when the ViewConsolidationOptimization parameter is enabled onthe IBM Cognos TM1 server.

Parameter type: optional, static

There are two methods that ViewConsolidationOptimization can use to calculateand store consolidations: ARRAY or TREE. The ARRAY method storesconsolidations in a temporary array. The TREE method stores consolidations in atree.

ViewConsolidationOptimizationMethod should be set to TREE in mostcircumstances. This setting provides the best performance in normal operationsand when data is sparse along the view axes.

In the uncommon circumstance when axes dimensions have just a few leafelements rolling up to many consolidations,ViewConsolidationOptimizationMethod should be set to ARRAY.

To set this parameter, add the appropriate line to your configuration file:ViewConsolidationOptimizationMethod=TREE

ViewConsolidationOptimizationMethod=ARRAY

If ViewConsolidationOptimizationMethod is not explicitly set in the Tm1s.cfg file,the ARRAY method is used by default.

258 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 271: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Appendix C. The Tm1p.ini Client Configuration File

The Tm1p.ini file specifies the environment information for the IBM Cognos TM1clients (Cognos TM1 Perspectives, Cognos TM1 Architect, and Cognos TM1Clients) .

Location of the Tm1p.ini FileIBM Cognos TM1 installs a system default version of the Tm1p.ini file and alsocreates a user-specific version of the file.

The two versions of the Tm1p.ini file are stored in different locations.

System default Tm1p.ini file

When you install IBM Cognos TM1 , the installation location for the system defaultversion of the Tm1p.ini file is:;%ALLUSERSPROFILES%\Application Data\Applix\TM1\Tm1p.ini.

In most cases, the full path to this version of the Tm1p.ini file is:C:\Documents and Settings\All Users\Application Data\Applix\TM1\Tm1p.ini.

The system default version of Tm1p.ini allows multiple users to use Cognos TM1on a given computer. Tm1p.ini must be present the first time a user starts CognosTM1 on the computer, as the parameters in the system default version govern thebehavior of the initial startup of the Cognos TM1 client for each user.

User-specific Tm1p.ini file

After a user starts Cognos TM1 on the computer, a user-specific copy of Tm1p.iniis created in:%APPDATA%\Applix\TM1\Tm1p.ini

In most cases, the full path to the user-specific version of the Tm1p.ini file is:

C:\Documents and Settings\user name\ApplicationData\Applix\TM1\Tm1p.ini.

The user-specific copy of Tm1p.ini accepts all parameters settings and changes forthe user and governs the behavior of the Cognos TM1 client for all subsequentuser sessions of the Cognos TM1 client.

The Cognos TM1 Options dialog box also stores many of these settings. You canchange these settings using either the TM1 Options dialog box or by editing theTm1p.ini file. The Tm1p.ini parameters and TM1 Options are described here.

Parameters in the Tm1p.ini fileThe following parameters can be used in the Tm1p.ini file.

AdminHostDisplays the Admin Host name on which an Admin Server is running. On IBMCognos TM1 Options, use Login Parameters Admin Host.

© Copyright IBM Corp. 2007, 2012 259

Page 272: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

AdminSvrSSLCertAuthorityThe full path of the certificate authority file that issued the IBM Cognos TM1Admin Server's certificate.

On Cognos TM1 Options, use Certificate Authority.

AdminSvrSSLCertIDThe name of the principal to whom the IBM Cognos TM1 Admin Server'scertificate is issued.

Note: The value of this parameter should be identical to theSSLCertificateIDparameter for the Cognos TM1 Admin Server as set in IBMCognos Configuration.

This parameter can also be set for clients in the Cognos TM1 Options window >Certificate ID field.

AdminSvrSSLCertRevListThe full path of the certificate revocation file issued by the certificate authority thatissued the IBM Cognos TM1 Admin Server's certificate.

A certificate revocation file will only exist in the event a certificate had beenrevoked. On Cognos TM1 Options, use Certificate Revocation List.

AdminSvrSSLExportKeyIDThe identity key used to export the certificate authority certificate, which originallyissued the IBM Cognos TM1 Admin Server's certificate, from the certificate store.

This parameter is required only if you choose to use the certificate store by settingExportAdminSvrSSLCert=T.

On Cognos TM1 Options, use Export Certificate ID.

AdvancedRulesEditorIndicates the type of Rules Editor used.

The Advanced Rules Editor has an enhanced interface.v T - The Enhanced Rules Editor is used.v F (Default)- The Basic Rules Editor is used.

AllowImportCamClientsThis parameter is required only when configuring IBM Cognos TM1 to use CAMauthentication.

It must be set to T when importing an administrative user from CAM into CognosTM1.

If your Cognos TM1 server is not configured to use CAM authentication, thisparameter should be set to F or omitted from the Tm1p.ini file.

For details, see “Anonymous access and the Cognos TM1 server” on page 187.

260 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 273: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

BrowseDisplayReadsRightToLeftIndicates how data is oriented in the Cube Viewer.

Data can display right to left or left to right.v T - Data is oriented right to left.v F (Default) - Data is oriented left to right.

ClassicSliceModeIndicates whether the Slice option in the Cube Viewer generates classic slices ordynamic slices.v T - Slice option generates classic slices.v F - Slice option generates dynamic slices.

CognosGatewayURIThis parameter is required only when configuring IBM Cognos TM1 to use IBMCognos security (CAM) authentication.

It must be set to the URI of your IBM Cognos gateway. The URI is specified in theform http[s]:/<host>/cognosx/cgi-bin/cognos.cgi or http[s]:/<host>/ibmcognos/cgi-bin/cognos.cgi.

For example, http://win2003test/ibmcognos/cgi-bin/cognos.cgi.

If your Cognos TM1 server is not configured to use CAM authentication, thisparameter should be omitted from the Tm1p.ini file.

For details, see “Anonymous access and the Cognos TM1 server” on page 187.

ConnectLocalAtStartupIndicates whether IBM Cognos TM1 Architect or IBM Cognos TM1 Perspectivesautomatically connects to the local server at startup.v T (Default) - Cognos TM1 connects to the local server at startup.v F - Cognos TM1 does not connect to the local server at startup.

DataBaseDirectoryUses the full path to the local server data directory.

You can specify multiple data directories by separating the directory names withsemicolons.

DimensionDownloadMaxSizeA threshold value of the number of elements in a dimension, beyond which thedimension is downloaded and cached on the IBM Cognos TM1 client.

To improve performance when you work with large dimensions, addDimensionDownloadMaxSize so that large dimensions will cache on the client.

DisplayApplicationsIndicates whether the Applications group is visible in Server Explorer on startup.v T - Applications group is visible in Server Explorer.

Appendix C. The Tm1p.ini Client Configuration File 261

Page 274: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v F - Applications group does not appear in Server Explorer.

DisplayChoresIndicates whether the Chores group is visible in Server Explorer on startup.v T - Chores group is visible in Server Explorer.v F - Chores group does not appear in Server Explorer.

DisplayControlCubesIndicates whether the Control Cube group is visible in Server Explorer on startup.v T - ControlCube group is visible in Server Explorer.v F - ControlCube group does not appear in Server Explorer.

DisplayCubesIndicates whether the Cubes group is visible in Server Explorer on startup.v T - Cubes group is visible in Server Explorer.v F - Cubes group does not appear in Server Explorer.

DisplayDimensionsIndicates whether the Dimensions group is visible in Server Explorer on startup.v T - Dimensions group is visible in Server Explorer.v F - Dimensions group does not appear in Server Explorer.

DisplayExplorerPropertiesWindowIndicates whether the Properties pane is visible in Server Explorer on startup.v T - Properties pane is visible.v F (Default) - Properties pane does not appear.

DisplayProcessesIndicates whether the Processes group is visible in Server Explorer at startup.v T - Processes group is visible in Server Explorer.v F - Processes group does not appear in Server Explorer.

DisplayReplicationsIndicates whether the Replications group is visible in Server Explorer at startup.v T - Replications group is visible in Server Explorer.v F - Replications group does not appear in Server Explorer.

ExpandRowHeaderWidthIndicates if the Row Headers will automatically expand to accommodate the widthof the longest entry in the column.v T(Default) - Row headers auto-expand.v F - Row header must be manually expanded when necessary.

ExportAdminSvrSSLCertSelect this option if you want the certificate authority certificate which originallyissued the IBM Cognos TM1 Admin Server's certificate to be exported from theMicrosoft Windows certificate store at runtime.

262 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 275: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v T (Default) - Original certificate is exported from the Windows certificate store.v F - Original certificate is not exported.

In Cognos TM1 Options, select Use Certificate Store.

When this option is selected, you must also set a value for Export Certificate ID inthe Cognos TM1 Options dialog box or AdminSvrSSLExportKeyID.

InSpreadsheetBrowserIndicates if the In-Spreadsheet Browser or the Cube Viewer is the default browser.v T - In-Spreadsheet Browser is the default browser. When you double-click a cube

or view, it opens in an Excel document.v F (Default) - Cube Viewer is the default browser. When you double-click a cube

or view, it opens in the Cube Viewer.

IntegratedLoginIndicates if your IBM Cognos TM1 client uses Integrated Login or the standardCognos TM1 security to log in to the Cognos TM1 server and other Cognos TM1components.v T - Client uses Integrated login, where your Microsoft Windows login username

and password are used to access the Cognos TM1 server and other components.v F (Default) - Client uses standard Cognos TM1 security, where a username and

password must be explicitly provided, when logging in to the Cognos TM1server and other components.

Before you enable this parameter, consult with your Cognos TM1 administrator todetermine if Integrated Login is implemented on your Cognos TM1 server.

On Cognos TM1 Options, use Integrated Login.

LanguageIndicates the language used in the IBM Cognos TM1 client interface.

Clients will try to read from the locale and use that to set the language. Thatlanguage will be used if it matches one of the supported languages. If the languageentered does not match a supported language, English is used.

To override the default you can set the Language explicitly in the tm1p.ini usingthe following codes:

Language Code

Brazilian Portuguese bra

Croatian hry

Czech csy

Chinese (Simplified) sch

Chinese (Traditional) tch

Danish dan

German deu

Spanish esp

Finnish fin

Appendix C. The Tm1p.ini Client Configuration File 263

Page 276: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Language Code

French fra

Hungarian hun

Italian ita

Japanese jpn

Kazakh kaz

Korean kor

Norwegian nor

Polish pol

Romanian rom

Russian rus

Swedish sve

Turkish trk

LocalServerNetworkProtocolDetermines the protocol that the local IBM Cognos TM1 server uses tocommunicate with clients. Currently, the only valid setting is TCP.

MainWindowLayoutInfoGenerates dimension and position coordinates for the Server Explorer window;allows Server Explorer dimensions and position to be maintained between sessions.

The coordinates are automatically generated when you move or resize the ServerExplorer window.

PreviousAdminHostsLists up to six of the most recently accessed Admin Hosts from the IBM CognosTM1 Options Admin Host list.

PreviousDataDirectoriesLists up to six of the most recently accessed data directories in the Local ServerData Directory list from the IBM Cognos TM1 Options window.

The directories accessed within a single session are separated by semicolons. Thedirectories accessed in different sessions are separated by commas.

SecurityAssignmentWindowLayoutInfoGenerates dimension and position coordinates for the Clients/Groups window;allows Clients/Groups dimensions and position to be maintained betweensessions.

The coordinates are automatically generated when you move or resize theClients/Groups window.

SentMsgsToServerCountWarningThe SentMsgsToServerCountWarning parameter is for development use only. Theparameter is set to F by default.

264 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 277: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Be sure not to change the default setting.

ShowAdminHostChangeWarningBetween session storage of whether to display or suppress a warning when theAdminHost is changed.v T (Default)- When an AdminHost is changed, a warning message displays.v F - No message is displayed when the AdminHost is changed.

ShowAliasAttributeWarningBetween session storage of whether to display or suppress a warning when theAlias Attribute is changed.v T (Default)- When an Alias Attribute is changed, a warning message displays.v F - No message is displayed when the Alias Attribute is changed.

ShowChoresSchedulingWarningBetween session storage of whether to display or suppress a warning when a choreschedule is changed.v T (Default)- When a chore schedule is changed, a warning message displays.v F - No message is displayed when a chore schedule is changed.

ShowCubeReplicationWarningBetween session storage of whether to display or suppress a warning when a cubeis replicated.v T (Default)- When a cube is replicated, a warning message displays.v F - No message is displayed when a cube is replicated.

ShowDimDeleteElementWarningBetween session storage of whether to display or suppress a warning when adimension element is deleted.v T (Default)- When a dimension element is deleted, a warning message displays.v F - No message is displayed when a dimension element is deleted.

ShowDimensionAccessWarningBetween session storage of whether to display or suppress a warning when adimension is accessed.v T (Default)- When a dimension is accessed, a warning message displays.v F - No message is displayed when a dimension is accessed.

ShowDynamicSubsetWarningBetween session storage of whether to display or suppress a warning when aDynamic Subset is changed.v T (Default)- When a Dynamic Subset is changed, a warning message displays.v F - No message is displayed when a Dynamic Subset is changed.

ShowPickOperationWarningBetween session storage of whether to display or suppress a warning when data iscopied using the Pick Elements option.

Appendix C. The Tm1p.ini Client Configuration File 265

Page 278: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

v T (Default)- A warning message displays any time data is copied using the PickElements option.

v F - No message displays when data is copied using the Pick Elements option.

ShowProcessUNASCIIWarningBetween session storage of whether to display or suppress a warning when anASCII datasource is processed.v T (Default)- When an ASCII datasource is processed, a warning message

displays.v F - No message is displayed when an ASCII datasource is processed.

ShowProcessUNODBCWarningBetween session storage of whether to display or suppress a warning when anODBC datasource is processed.v T (Default)- Any time an ODBC datasource is processed, a warning message

displays.v F - No message displays when an ODBC datasource is processed.

SliceNewWorkbookDetermines how slices are generated from the Cube Viewer.v T - Inserts slices in a new workbook.v F (Default) - Inserts slices in a new sheet of the current workbook.

SubsetWindowLayoutInfoGenerates dimension and position coordinates for the Subset Editor window;allows Subset Editor dimensions and position to be maintained between sessions.

The coordinates are automatically generated when you move or resize the SubsetEditor window.

TM1RebuildDefaultDetermines if worksheets recalculate on opening by default

By default, when you slice a view into Microsoft Excel from IBM Cognos TM1, theworkbook contains a workbook level named variable, TM1RebuildOption, that isset to 1 by default. This causes the worksheets in the book to be rebuilt on opening(which forces a recalculation to happen on each sheet in the book). This action isnecessary if the sheets contain Active Forms. If you are not working with ActiveForms, you may not want all workbooks to use this default behavior.

All worksheets recalculate when a Cognos TM1 workbook is opened. Theworkbook was created by slicing from Cognos TM1 Perspectives and contains theworkbook level named variable TM1RebuildOption = 1.

By default, as of Cognos TM1 9.4.1 all new books created by slicing have aworkbook level named variable TM1RebuildOption=1 in them. This makes theworkbook rebuild on open, causing a recalculation of the all sheets which isimportant for Active Forms but may not be the desired behavior is you areprimarily working with non-Active Form worksheets.

To prevent sheets from using the default to always rebuild when slicing, changeTM1RebuildDefault from T to F (or add TM1RebuildDefault=F if it doesn't already

266 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 279: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

exist) in your tm1p.ini file. When TM1RebuildDefault=F the books get theworkbook level named variable set to TM1RebuildOption=0 on slicing. This isequivalent to how Cognos TM1 worked prior to the introduction of Active Forms.

If this option is set to T or doesn't exist, slicing from a view in Cognos TM1Perspectives sets the TM1RebuildOption workbook level named variable to 1which forces a rebuild on open. If this option is F, the name variableTM1RebuildOption is set to 0, which does not rebuild. For a particular report, forexample, an Active Form, you can set the name variable to 1 instead of the default0.

By default, a new install does not have the TM1RebuildDefault parameter at allwhich provides the default behavior of slicing with TM1RebuildOption=1.

Appendix C. The Tm1p.ini Client Configuration File 267

Page 280: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

268 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 281: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Appendix D. Setting up unattended installations andconfigurations

Set up an unattended installation and configuration to install an identicalconfiguration across several computers on your network, or automate theinstallation and configuration process by specifying options and settings for users.

Before you set up an unattended installation and configuration, ensure that all thesystem requirements and prerequisites are met and that all third-party products areinstalled and configured.

Procedure1. Configure a transfer specification file (.ats) to specify installation options.2. Run the installation tool in silent mode.3. Use a pre-configured configuration file from another computer.4. Run the configuration tool in silent mode.

Unattended installationsUse a transfer specification file (.ats) to copy IBM Cognos components to yourcomputer without being prompted for information.

By default, each time you install IBM Cognos components using the installationwizard, the options you select are recorded in a transfer specification file.Therefore, if you already installed IBM Cognos components on a sample computer,you can use the generated transfer specification file as a template for unattendedinstallations on different computers.

If you do not use the installation wizard to install components, you can use thedefault transfer specification file named response.ats that is available on the disk.You must modify the response.ats file for your environment before you can use itfor an unattended installation.

You can check if the unattended installation was successful by checking the returnstatus. A value of zero (0) indicates success and all other values indicate that anerror occurred.

Setting up an unattended installationUse the following TM1 product codes for an unattended installation.

Procedure

Follow the instructions described in Setting up an Unattended Installation(http://publib.boulder.ibm.com/infocenter/cbi/v10r1m0/index.jsp?topic=%2Fcom.ibm.swg.im.cognos.inst_cr_winux.10.1.0.doc%2Finst_cr_winux_id28690c8bi_SetUpUnattendedInstallation.html) substituting thefollowing TM1 product codes.

© Copyright IBM Corp. 2007, 2012 269

Page 282: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Table 32.

Product Code Product

TM1APPTIER_APP=1 TM1 Applications Tier

TM1SERVER_APP=1 TM1 Server

TM1ADMINSERVER_APP=1 TM1 Admin Server

TM1TOOLS_APP=1 TM1 Tools

TM1WEBAPPTIER_APP=1 TM1 Web Applications Tier

TM1CONTRIBGATEWAY_APP=1 TM1 Applications Gateway

TM1CONTRIBSERVICE_APP=1 TM1 Applications Server

TM1WEB_APP=1 TM1 Web

TM1OPERATIONSCONSOLE_APP=1 TM1 Operations Console

TM1CLIENTTIER_APP=1 TM1 Client Tier

TM1PERSPECTIVES_APP=1 TM1 Perspectives

TM1COGNOSINSIGHT_APP=1 Cognos Insight

TM1APIS_APP=1 TM1 API

TM1DEVTIER_APP=1 TM1 Developer Tier

TM1ARCHITECT_APP=1 TM1 Architect

TM1PERFMOD_APP=1 TM1 Performance Modeler

TM1SAMPLETIER_APP=1 TM1 Sample Tier

You can see the contents of this file in the tm1_location/instlog location in the.ats file.

Setting up an unattended configurationBefore you set up an unattended configuration, you must export a configurationfrom another computer that has the same IBM Cognos TM1 components installed.You can then run IBM Cognos Configuration in silent mode.

The exported configuration contains the properties of the Cognos TM1 componentsthat you installed on the source computer. If you made changes to the globalconfiguration, you must also copy the global configuration file from the sourcecomputer to the computer where you plan to run an unattended configuration.

Before you begin

Ensure that the configuration settings on the local computer are appropriate to useto configure another computer with the same installed components.

Procedure1. In IBM Cognos Configuration, from the File menu, click Export as.2. If you want to export the current configuration to a different folder, in the Look

in box, locate and open the folder.3. In the File name box, type a name for the configuration file.4. Click Save.5. Copy the exported configuration file from the source computer or network

location to the tm1_location/configuration directory on the computer whereyou plan to do an unattended configuration.

6. Rename the file to cogstartup.xml.

270 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 283: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

7. If you changed the global configuration on the source computer, copy thecoglocale.xml file from the source computer to the tm1_location/configuration directory on the computer where you plan to do an unattendedconfiguration.

8. Go to tm1_location/bin directory.9. Type the configuration command:

cogconfig.bat -s

To view log messages that were generated during an unattended configuration,see the cogconfig_response.csv file in the tm1_location/logs directory.

Results

You can check if the unattended configuration was successful by checking thereturn status. A value of zero (0) indicates success and all other values indicate thatan error occurred.

Cognos Configuration applies the configuration settings specified in the local copyof cogstartup.xml, encrypts credentials, generates digital certificates, and ifapplicable, starts the IBM Cognos service or process.

Setting up an unattended uninstallationSet up an unattended uninstallation to automate the removal of components onseveral computers that have the same components or to remove components on aUNIX or Linux environment that does not have Microsoft XWindows.

Procedure1. Go to tm1_locaton/instlog.2. Open the transfer specification .ats file for the product in a text editor.

The filename format of the transfer specification .ats file ists-product_code-version-yyyymmdd_hhmm.ats

See “Setting up an unattended installation” on page 269 for a list of the TM1product codes.You need to edit only one .ats file per product.

3. In the section named [Component List], specify the components to remove.v To remove the component, type 1

v To leave the component installed, type 0

By default, all installed components are set to be removed.4. Save and close the file.5. Repeat steps 2 to 4 for each installed product.6. From the operating system command line, change to the tm1_location/

uninstall directory.7. At the command prompt, type the following command:

v On Windows,uninst -u -s

v On UNIX or Linux,./uninst -u -s

v On UNIX or Linux without XWindows,./uninstnx -u -s

Appendix D. Setting up unattended installations and configurations 271

Page 284: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

272 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 285: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Appendix E. Troubleshooting a problem

Troubleshooting is a systematic approach to solving a problem. The goal oftroubleshooting is to determine why something does not work as expected andhow to resolve the problem.

Answering the following questions can help you to identify the source of aproblem that is occurring with an IBM Cognos product:1. Is the configuration supported?2. What are you doing when the problem occurs?

v Planningv Installing the productv Upgrading or migrating the productv Doing system administration or configuration tasksv Developing applicationsv Launching or deploying the productv Running the productv Installing or making changes to related hardware or software productsv Recovering or restarting the product or systemv Diagnosing a problem or running diagnostic aids

3. Is the problem related to IBM Cognos software? If so, what, if any, errormessages or error codes were issued?

4. Can you reproduce the problem to ensure that it is not just a simple error?5. Did you check file locations, directories, paths, and access?6. Have you reviewed all relevant documentation, including release notes and

technotes?7. Did you check to see if any recent changes in your computing environment

might be responsible for the problem.8. If these questions and answers do not guide you to a resolution, you might

need additional information or you might need to collect diagnostic data. Thisdata is necessary for an IBM technical-support representative to effectivelytroubleshoot and assist you in resolving the problem.

Cognos Information CentersIBM Cognos Information Centers include documentation for each release. Thisdocumentation is also available through product help menus.

All Cognos Information Centers, including all translated documentation, areavailable at the IBM Cognos Business Intelligence and Performance Managementinformation center.

To find links to the latest known problems and authorized program analysisreports (APARs), access the release notes available in each Information Center.

© Copyright IBM Corp. 2007, 2012 273

Page 286: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Support PortalThe IBM Support Portal is a unified, centralized view of all technical support toolsand information for all IBM systems, software, and services.

The IBM Support Portal lets you access all the IBM support resources from oneplace. You can tailor the pages to focus on the information and resources that youneed for problem prevention and faster problem resolution. Familiarize yourselfwith the IBM Support Portal by viewing the demo videos .

Find the Cognos content that you need by selecting your products from the IBMSupport Portal.

Gathering informationBefore contacting IBM Support, you will need to collect diagnostic data (systeminformation, symptoms, log files, traces, and so on) that is required to resolve aproblem. Gathering this information will help to familiarize you with thetroubleshooting process and save you time.

Information on what data to collect is available in the form of MustGathertechnotes.

Service requestsService requests are also known as Problem Management Reports (PMRs). Severalmethods exist to submit diagnostic information to IBM® Software TechnicalSupport.

To open a PMR or to exchange information with technical support, view the IBMSoftware Support Exchanging information with Technical Support page. PMRs canalso be submitted directly by using the Service requests (PMRs) tool, or one of theother supported methods detailed on the exchanging information page.

Support Assistant LiteIBM Support Assistant is a complimentary software offering that provides youwith a workbench to help you with problem determination.

IBM Cognos currently supportsIBM Support Assistant Lite. This utility automatesproduct-specific data collection. It identifies the data files that IBM Supportanalysts need to diagnose and recover from occasional operational problems withIBM products.

Cognos Customer CenterThe IBM Cognos Customer Center provides Cognos-specific information, updates,and troubleshooting resources.

To view Cognos troubleshooting information, access the Cognos Customer Center,and view the information under "Contacting Support" or "TroubleshootingResources"

274 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 287: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Fix CentralFix Central provides fixes and updates for your software, hardware, and operatingsystem.

Use the pull-down menu to navigate to your product fixes on Fix Central. You canalso view Fix Central help..

Problem determination toolsSeveral IBM Cognos problem determination tools are available to diagnose andtroubleshoot common problems.

These tools can be downloaded from the Cognos Diagnostic Utilities page. IBMEducation Assistant provides video and other training resources on some of thesediagnostic tools on theIBM Education Assistant Problem Determination website.

Forums and communitiesIBM Cognos product forums offer a place to share ideas and solutions with yourpeers in the IBM Cognos community.

Active Cognos forums are available at Cognos forums and communities.

Business Analytics Support NotebookBusiness Analytics Support Notebook provides news and updates from IBMBusiness Analytics Support (including Cognos and SPSS®).

View the latest information updates, including video updates, at Business AnalyticsSupport Notebook.

Software Support RSS feedsIBM Software Support RSS feeds are a quick, easy, and lightweight format formonitoring new content added to websites.

After you download an RSS reader or browser plug-in, you can subscribe to IBMproduct feeds at IBM Software Support RSS feeds.

Searching and navigating Cognos productsAccess to IBM Cognos product information can now be configured in the IBMSupport Portal, which provides the ability to see all of your links on a single page.

Best practices for searching and navigating for Cognos product information areavailable on the IBM Cognos Support Portal and Technote Search Best Practicespage.

Appendix E. Troubleshooting a problem 275

Page 288: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

276 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 289: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Notices

This information was developed for products and services offered worldwide.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service. This document maydescribe products, services, or features that are not included in the Program orlicense entitlement that you have purchased.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFNON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties incertain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

© Copyright IBM Corp. 2007, 2012 277

Page 290: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Software GroupAttention: Licensing3755 Riverside DrOttawa, ON K1V 1B7Canada

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

278 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 291: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Trademarks

IBM, the IBM logo, ibm.com, TM1, and Cognos are trademarks or registeredtrademarks of International Business Machines Corp., registered in manyjurisdictions worldwide. Other product and service names might be trademarks ofIBM or other companies. A current list of IBM trademarks is available on the Webat “ Copyright and trademark information ” at www.ibm.com/legal/copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:v Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered

trademarks or trademarks of Adobe Systems Incorporated in the United States,and/or other countries.

v Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.

v Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.

v UNIX is a registered trademark of The Open Group in the United States andother countries.

v Java and all Java-based trademarks and logos are trademarks or registeredtrademarks of Oracle and/or its affiliates.

Notices 279

Page 292: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

280 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 293: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Index

Special characters.blb file extension 24.cfg file 26, 219.cho file extension 24.cub file extension 24.dim file extension 24.dit file extension 24.ini file 26, 259.NET 3.5 SP1 Framework 13.NET framework 18.pro file extension 24.rej file 23.rux file extension 24.sub file extension 24.tbu file extension 24.tqu file extension 24.tru file extension 24.vue file extension 24.xdi file extension 24.xru file extension 24

Numerics32-bit 3332-bit Windows installation 764-bit 3364-bit system commands 118, 12264-bit Windows installation 7

Aaccess

privileges, data directory 25accessibility features 217add and remove programs 46adding a server 69additional components 211Admin server 23Admin Server 22, 34Admin Server service 44AdminHost 221, 260AdminHost parameter 199, 203

SSL 196administrator privileges 54AdminSvrSSLCert Authority 196AdminSvrSSLCertAuthority 260AdminSvrSSLCertID 196, 260AdminSvrSSLCertRevList 196, 260AdminSvrSSLExportKeyID 196, 260AdvancedRulesEditor 260AllowImportCamClients 260AllowImportCAMClients 187AllowReadOnlyChore Reschedule 221AllowSeparateNandCRules 58, 221AllRuleCalcStargateOptimization 222Apache tomcat

undeploy 215application pool 179Architect 25Architect upgrade 47

architecture 21ASCII characters in directory names 54ASPNET 18AuditLogMaxFileSize 223AuditLogMaxQueryMemory 223AuditLogMaxTempFileSize 223AuditLogOn 223AuditLogUpdateInterval 224authentication 163, 165, 186

for TM1 Viewer Portlets 132importing groups into TM1 189integrated login 163integrated login diagram 164

authentication, LDAP 163authentication, LDAP diagram 165

BBack up data 45backing up data 211backup

TM1 Applications 211, 213BI service 44BrowseDisplayReadsRightToLeft 261

CCalculationThresholdFor Storage 224CAMID 165, 186CAMPortalVariableFile 225CAMSSLCertificate 224certificate 204

authority 194revocation 194store 194

certificates 193, 205Changed features 3character encoding 68chart controls 19Chart Controls 13CheckFeedersMaximumCells 225ClassicSliceMode 261classpath 121ClearType Tuner utility

on Web server 152client components 8client installation 7, 93ClientCAMURI 225ClientExportSSLSvrCert 196ClientExportSSLSvrKeyID 196ClientMessagePortNumber 226ClientPingCAMPassport 225ClientPropertiesSyncInterval 226clients 22, 25ClientVersionMaximum 226ClientVersionMinimum 227ClientVersionPrecision 228Cognos Application server

starting 78Cognos authentication 165, 186

© Copyright IBM Corp. 2007, 2012 281

Page 294: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Cognos authentication (continued)defining an administrator 188

Cognos BI securitywith TM1 Applications 153

Cognos Configuration 54, 64Cognos Connection 55Cognos Insight 54

installing 59, 101running 59

Cognos security 186administrator considerations 191user considerations 191with TM1 Applications session timeout 156, 190with TM1 Viewer Portlets 132

Cognos security passport 165, 186Cognos TM1 Applications

architecture overview 29Cognos TM1 Operations Console 118, 122Cognos TM1 Performance Modeler

installing 97CognosGatewayURI 187, 261CognosInterfacePath 229CognosTM1InterfacePath configuration parameter 138components 53components modify 212configuration 15Configuration files 16configure 55, 64configure login page 76, 148configuring components 67configuring validation 185connecting to a server 173ConnectLocalAtStartup 261Contributor upgrade to TM1 Applications 48

Ddata directory

access privileges 25definition 25local server 26multiples 26path 25remote server 26required network access 25security 25

DataBaseDirectory 229, 261decrypt 194default printer 60, 147default settings 14DefaultMeasuresDimension 229deploy 31deploying

TM1 Operations Console 119, 122deployment options 33DHFile-1024 194, 196DHFile-512 194, 196Diffie-Hellman 194DimensionDownloadMaxSize 261DisableMemoryCache 229DisableSandboxing 230DisableWorksheetView 230Dispatch URI 136Display_Info_DBType_R8 230DisplayApplications 261DisplayChores 262DisplayControlCubes 262

DisplayCubes 262DisplayDimensions 262DisplayExplorerPropertiesWindow 262DisplayProcesses 262DisplayReplications 262distributed installation 34DistributedPlanningOutputDir 58, 231domains

account 35installing without 19

DOS command window 168dot as local domain 20DownTime 231

EEnable macros 56encrypt 194ETLDAP

Attributes field 168building LDAP query 171configuring LDAP login parameters 170connecting to a server 173Export button 168export options 174exporting LDAP users to TM1 174Filter field 168LDAP modified record attribute 174LDAP query elements 171mapping LDAP attributes to TM1 fields 173modifying LDAP attributes 167Results table 168running from DOS 168running in update mode 174Search button 168Search DN field 168Search Scope option 168updating TM1 with new LDAP users 174

ETLDAP utility 166ETLDAP, LDAP authentication 185Excel service 18, 44ExcelWebPublishEnabled 232ExpandRowHeaderWidth 262export to PDF locale setting 159ExportAdminSvrSSLCert 196, 263exporting PDF data 60, 147ExportSvrSSLCert 194, 196, 207

Ffile extensions 24finding information xiFirefox 181

GGateway URI 136GO sample 107GO_New_Stores 107

starting 55, 64GOSALES sample database 109group assignments 185GroupsCreationLimit 233

282 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 295: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

Hheartbeat interval 22

IIBM AIX

memory resource limits 67running TM1 with 67unsupported commands with TM1 68

identity key 194IdleConnectionTimeOutSeconds 234IIS 37, 179IIS 5 179IIS 6 179IIS 7 74IIS web server 18IIS_WPG 179initialization file 26, 259Insight

TurboIntegrator function restrictions 159InSpreadsheetBrowser 263install scenario 53installation 14installing 129

IBM Cognos BI 269unattended install 269using transfer specification file (.ats) 269

installing TM1 clients 93integrated login 163, 164, 181

}ClientProperties cube 176access rights 177Architect 182Kerberos 179overview 176setting up 176setting up manually 178TM1 Perspectives 182TM1 Web 179, 183UniqueID field 176

IntegratedLogin 263IntegratedSecurityMode 234Internet Explorer 181interoperability 131Interoperability 7, 225introduction xiIP address 236IPAddress 235

JJava 37

SSL 203Job Queuing 237JobQueueMaxWaitTime 237JobQueueThreadPoolSize parameter 237JobQueueThreadSleepTime 238

KKerberos 179keyboard shortcuts 217

Cognos Configuration 218

Llanguage 35Language 238language codes 142, 143language configuration 142, 144language for clients 263Language parameter for clients 144Language parameter for server 144LDAP

authentication 163, 165building a query 171configuring login parameters 170exporting users to TM1 174mapping attributes to TM1 fields 173modified record attribute 174modifying attributes 167running ETLDAP in update mode 174updating TM1 with new users 174

LDAP authenticationconfiguring validation 185ETLDAP 185modifying group assignments 185parameters 183TM1S.cfg 185validating users 183

LDAP Authentication 183LDAP Load Tool dialog box 168LDAPHost 183LDAPPasswordFile 183, 185, 239LDAPPasswordKeyFile 183, 185, 239LDAPPort 183LDAPSearchBase 183LDAPSearchField 183LDAPUseServerAccount 183, 184, 239LDAPWellKnownUserName 183limiting 28Linux

installation 66start TM1 server 67TM1 server installation 65

Linux server upgrade 47local machine syntax 20local server 26locale setting 35LocalServerNetworkProtocol 264locations 14LockPagesInMemory 239log

file 23logging into

TM1 Operations Console 120, 124LoggingDirectory 240login 190login credentials 57login page configuring 76, 148login, integrated 176Logon As 192logon rules 191LogReleaseLineCount 240

Mmaintain installation 211MainWindowLayoutInfo 264MaskUserNameInServerTools 240MaximumCubeLoadThreads 241

Index 283

Page 296: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

MaximumLoginAttempts 241MaximumMemoryForSubsetUndo 242MaximumSynchAttempts parameter 242MaximumTILockObject 243MaximumUserSandboxSize 243MaximumViewSize 243MaxUndoHoldLineCount 244MessageCompression 244metadata 23Microsoft .Net 54Microsoft Internet Explorer 181Microsoft Visual C++ 54modify installation 212modifying

group assignments 185Mozilla 181multiple Admin Hosts 22multiple computer install 63multiple computer web install 74multiple servers 28

NNetRecvBlockingWaitLimitSeconds 244NetRecvMaxClientIOWaitWithinAPIsSeconds 245new clients 189New installation features 1non-ascii characters and moving 68non-ascii names and locale 68non-SSL clients 194

OOLE DB 33on Websphere 125Optional Tm1s.cfg parameter 185, 239

AllowReadOnlyChore Reschedule 221AllowSeparateNandCRules 221AllRuleCalcStargateOptimization 222AuditLogMaxFileSize 223AuditLogMaxQueryMemory 223AuditLogMaxTempFileSize 223AuditLogOn 223AuditLogUpdateInterval 224CalculationThresholdForStorage 224CAMSSLCertificate 224CheckFeedersMaximumCells 225ClientCAMURI 225ClientMessagePortNumber 226ClientPingCAMPassport 225ClientPropertiesSyncInterval 226ClientVersionMaximum 226ClientVersionMinimum 227ClientVersionPrecision 228CognosInterfacePath 229DefaultMeasuresDimension (OLAP may require) 229DisableMemoryCache 229DisableSandboxing 230DisableWorksheetView 230Display_Info_DBType_R8 230DistributedPlanningOutputDir 231DownTime 231ExcelWebPublishEnabled 232ForceReevaluationOfFeedersForFedCellsOnDataChange 232GroupsCreationLimit 233IdleConnectionTimeOutSeconds 234

Optional Tm1s.cfg parameter (continued)IntegratedSecurityMode 234IPAddress 235IPV6 236JobQueueMaxWaitTime 237JobQueueThreadSleepTime 238JobQueuing 237Language 238LDAPPasswordKeyFile 185, 239LDAPUseServerAccount 184, 239LockPagesInMemory 239LoggingDirectory 240LogReleaseLineCount 240MaskUserNameInServerTools 240MaximumCubeLoadThreads 241MaximumLoginAttempts 241MaximumMemoryForSubsetUndo 242MaximumSynchAttempts 242MaximumTILockObject 243MaximumUserSandboxSize 243MaximumViewSize 243MaxUndoHoldLineCount 244MessageCompression 244NetRecvBlockingWaitLimitSeconds 244NetRecvMaxClientIOWaitWithinAPIsSeconds 245PasswordMinimumLength 245PasswordSource 183, 245PerformanceMonitorOn 246PortNumber 246PrivilegeGenerationOptimization 247ProgressMessage 247ProportionSpreadToZeroCells 248RawStoreDirectory 249ReceiveProgressResponseTimeoutSecs 249RulesOverwriteCellsOnLoad 250RunningInBackground 250SAPLogFilePath 251SAPLoggingEnabled 250SaveTime 251SecurityPackageName 251ServerCAMURI 251ServerLogging 252ServerName 252ServicePrincipalName 252SkipLoadingAliases 252SkipSSLCAMHostCheck 253SpreadingPrecision 253StartupChores 255SubsetElementBreatherCount 254SyncUnitSize 255UseExtendedFetch 256UseLocalCopiesforPublicDynamicSubsets 256UserDefinedCalculations 255UseSQLFetch 256UseSQLFetchScroll 256UseStargateForRules 257ViewConsolidationOptimization 257ViewConsolidationOptimizationMethod 258

PPackage Connector Windows 7 136Parallel Interaction

JobQueueThreadPoolSize parameter 237ParallelInteractiong parameter 245

parametersSSL 194

284 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 297: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

passport 165, 186password

default for samples 14PasswordMinimumLength 245passwords 194PasswordSource 183, 245path data directory 25pdata 25Performance Modeler 54

installing 58PerformanceMonitorOn 246PersistentFeeders parameter 246Perspectives upgrade 47Planning 7Planning Sample 106

starting 55, 64port numbers 14portlets 131PortNumber 246prerequisite software 54Previous version back up 45PreviousAdminHosts 264PreviousDataDirectories 264private key 194PrivilegeGenerationOptimization 247privileges in Service Account 17product codes 269ProgressMessage 247ProportionSpreadToZeroCells 248

Qquery elements

LDAP 171Queuing 237quotation marks 220

RRawStoreDirectory 249ReceiveProgressResponseTimeoutSecs 249regional setting 35remote server 219

data directory 26operations 23

Remove previous version 46replication connection 192Required Tm1s.cfg parameter

AdminHost 221CAMPortalVariableFile 225CAMSSLCertificate (depends on CAM) 224DataBaseDirectory 229UseSSL (for SSL) 256

requirements 13response.ats file 269restore backup files for Oracle 112restore sample database on DB2 109restoring backup sample files for Microsoft SQL 114restoring data after upgrading 50revocation 194Rollup 255RulesOverwriteCellsOnLoad 250Run as Administrator 54RunningInBackground 250

SSample Outdoors Company 108samples 105SAP connectivity 136SAPLogFilePath 251SAPLoggingEnabled 250SaveTime 251saving data 23sdata 25Sdata 106SData

starting 55, 64security 164

for TM1 Viewer Portlets 132IIS 180

security authentication modeTM1 Applications 35, 79, 82, 87, 165

SecurityAssignmentWindowLayoutInfo 264SecurityPackageName 251SentMsgsToServerCountWarning 265server 23, 34

multiple 28server components 8ServerCAMURI 251ServerLogging 252ServerName 252servers

adding 69Service Account TM1 17Service Principal Name 179ServicePrincipalName 252services 15SetSPN.exe 179shortcut keys 217

IBM Cognos Configuration 218ShowAdminHostChangeWarning 265ShowAliasAttributeWarning 265ShowChoresSchedulingWarning 265ShowCubeReplicationWarning 265ShowDimDeleteElementWarning 265ShowDimensionAccessWarning 265ShowDynamicSubsetWarning 265ShowPickOperationWarning 266ShowProcessUNASCIIWarning 266ShowProcessUNODBCWarning 266silent installation 269single computer upgrade 46SkipLoadingAliases 252SkipSSLCAMHostCheck 253SliceNewWorkbook 266software and hardware 13Solaris 17SpreadingPrecision 253, 254SSL 192

parameters 194TM1 Top 203

SSL port 14SSLCertAuthority 194, 196, 207SSLCertificate 194, 196SSLCertificateID 194, 196, 207SSLCertRevocationFile 194, 196SSLPrivateKeyPwdFile 194, 196, 207SSLPwdKeyFile 194, 196, 207start IBM Cognos Configuration 67starting 107

Cognos Application server 78services 55, 64

Index 285

Page 298: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

starting (continued)TM1 Operations Console 120, 124

Starting 127startup 18

property 18StartupChores 255stop Contributor 44stop services 44, 214SubsetElementBreatherCount 254SubsetWindowLayoutInfo 266SupportNonSSLClients 194SvrSSLExportKeyID 194, 196, 207SyncUnitSize parameter 255

TTEMP system variable 54tier 2 31tier 3 32TM1 Admin Server

starting 55, 64TM1 Application

deploying on IBM WebSphere 86installing on separate computers 37server configuration 80, 83, 88with Microsoft IIS 158

TM1 Application server 36, 37TM1 Application Server

deployment options 35TM1 Application Web

running 59TM1 Applications

data tier 32deployment options 35installing on a single computer 36running 58security authentication mode 35, 79, 82, 87, 165uninstalling Applications 214using with multiple TM1 servers 159with IBM Cognos BI security 153with IBM Cognos security session timeout 156, 190

TM1 Applications install 31TM1 Architect

running 57TM1 BI interoperability 131

uninstalling 133TM1 components 8TM1 Excel server

starting 55TM1 Excel Service 60, 147TM1 object names 68TM1 Operation Console 125TM1 Operations Console 60, 127

adding certificates 118, 122creating user groups 119, 123installing 117logging into 120, 124Microsoft Internet Explorer 8 120, 124OpsConfig.xml file 120, 124starting 119, 120, 124

TM1 Package Connector 60TM1 Package Connector requirements 135TM1 Perspectives

running 56TM1 server

starting on Linux 67starting on UNIX 67

TM1 Serverstarting 55, 64

TM1 server install on Linux 65TM1 server install on Unix 65TM1 server installation on Windows 63TM1 Server Service 44TM1 Service Account 17TM1 Top utility

SSL 203TM1 Viewer Portlets 60, 131

uninstalling 133TM1 Web

IIS 7 74running 57running in Windows Vista 153with Windows Vista, Windows 7, and Windows Server

2008 74TM1_Package_Connector environment variable 137TM1Crypt 206TM1Functions.cfg 161tm1p.ini

location 259parameters 259

Tm1p.ini file 26, 259TM1RebuildDefault 266TM1S.cfg 185Tm1s.cfg file 26, 219

location 219parameters 220sample 219

TM1Top 190Tools 129transaction log file 23troubleshooting

identifying problems 273TurboIntegrator

restricting function execution 159TurboIntegrator functions 159

restricting execution of 161types of installations 7

Uunattended installation 269, 271uninstall 212, 271uninstalling

TM1 BI interoperability 133TM1 Viewer Portlets 133

UNIXinstallation 66server 219start TM1 server 67TM1 server installation 65

UNIX installation 7Unix server upgrade 47upgrade overview 43Upgrade planning 43upgrading to Cognos TM1 Applications 48user group for TM1 Operations Console 119, 123user groups for TM1 Operations Console 120, 124user name

default for samples 14UserDefinedCalculations 255username 20users

adding with ETLDAP 166UseSQLExtendedFetch 256

286 IBM Cognos TM1 Version 10.1.0: Installation and Configuration Guide

Page 299: public.dhe.ibm.com€¦ · Deploying Cognos TM1 on a single Windows computer ....................33 Deploying Cognos TM1 Admin Server and TM1 Server ....................34 Deploying

UseSQLFetch 256UseSQLFetchScroll 256UseSSL 196, 256UseStargateForRules 257using Cognos security 189

Vvalidation 185variables_TM1.xml 189ViewConsolidationOptimization 257ViewConsolidationOptimizationMethod 258Viewer Portlets 225Vista

Package Connector 136Visual C++ 2005 SP1 Redistributable Package 13

Wweb application 31web application pool 179

web architecture 26web client 30web server 28Web upgrade 48websheets 59Websphere 125

uninstall 215Windows

installation 63Windows 7 54, 74Windows 7 Package Connector 136Windows Server 2008 54, 74Windows server upgrade 47Windows Vista 54, 74

configuring for TM1 Web 153

Index 287


Recommended