Cognos (R) 8 Analytic Applications

Transcription

1 Cognos(R) 8 Analytic Applications Installation and Configuration Guide INSTALLATION AND CONFIGURATION GUIDE Cognos (R) 8 Analytic Applications INSTALLATION AND CONFIGURATION GUIDE

2 Product Information This document applies to Cognos (R) 8 Analytic Applications Version 8.2 and may also apply to subsequent releases. To check for newer versions of this document, visit the Cognos Global Customer Services Web site ( Copyright Copyright (C) 2007 Cognos Incorporated. Portions of Cognos(R) software products are protected by one or more of the following U.S. Patents: 6,609,123 B1; 6,611,838 B1; 6,662,188 B1; 6,728,697 B2; 6,741,982 B2; 6,763,520 B1; 6,768,995 B2; 6,782,378 B2; 6,847,973 B2; 6,907,428 B2; 6,853,375 B2; 6,986,135 B2; 6,995,768 B2; 7,062,479 B2; 7,072,822 B2; 7,111,007 B2; 7,130,822 B1; 7,155,398 B2; 7,171,425 B2; 7,185,016 B1; 7,213,199 B2. Cognos and the Cognos logo are trademarks of Cognos Incorporated in the United States and/or other countries. All other names are trademarks or registered trademarks of their respective companies. While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to either the product or the document will be documented in subsequent editions. U.S. Government Restricted Rights. The software and accompanying materials are provided with Restricted Rights. Use, duplication, or disclosure by the Government is subject to the restrictions in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS , or subparagraphs (C) (1) and (2) of the Commercial Computer Software - Restricted Rights at 48CFR , as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA This software/documentation contains proprietary information of Cognos Incorporated. All rights are reserved. Reverse engineering of this software is prohibited. No part of this software/documentation may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos Incorporated.

3 Table of Contents Introduction 7 Using This Document 7 Audience 7 Related Documentation 7 Finding Documentation 8 Using Quick Tours 8 Getting Help 8 Printing Copyright Material 8 Chapter 1: Components Used by Cognos 8 Analytic Applications 9 Cognos 8 Runtime Components 9 Cognos 8 Adaptive Applications Framework Components 9 Third-Party Components 10 Chapter 2: Distribution Options for Cognos 8 Analytic Applications 11 All Components on One Computer 11 Cognos 8 Adaptive Applications Framework Components and Cognos 8 Runtime Components on Different Computers 12 Cognos 8 Runtime Components on Different Computers 13 All Cognos 8 Runtime Components on One Computer 13 Gateways on Separate Computers 14 Application Tier Components and Content Managers on Separate Computers 15 More Than One Content Manager 16 Chapter 3: Workflows for Cognos 8 Analytic Applications 17 Install Cognos 8 Adaptive Applications Framework Components with Cognos 8 Runtime Components 17 Install Cognos 8 Adaptive Applications Framework Components Within an Existing Cognos 8 Environment 19 Install SAP Interface Files 21 Chapter 4: Upgrading Cognos 8 Analytic Applications 23 Plan the Upgrade 23 Review the Documentation 23 Conduct a Site Survey 24 Perform a Trial Upgrade 24 Upgrade Cognos 8 Runtime Components 25 Customized Cognos 8 Runtime Files 25 Install Cognos 8 Runtime Components in the Same Directory 26 Install Cognos 8 Runtime Components in a New Directory 26 Upgrade Cognos 8 Adaptive Applications Framework Components from Cognos 8 Analytic Applications Install Cognos 8 Adaptive Applications Framework Components in the Same Directory 28 Install Cognos 8 Adaptive Applications Framework Components in a New Directory 28 Chapter 5: Installing and Uninstalling Cognos 8 Analytic Applications 31 Verify System Requirements 31 Review Supported Environments 32 Set Up Database Connectivity for the Content Store Database 32 Install Cognos 8 Runtime Components 33 Install Cognos 8 Adaptive Applications Framework Components 35 Installation and Configuration Guide 3

4 Install Application Content Files for the ERP 37 Install SAP Interface Files 37 Install the SAP Gateway Functions 37 Install the SAP Content Interface Files 38 Apply the SAP Gateway Functions and Content Interface Files 38 Install the Cognos Compression Utility 39 Set Access Permissions for the Gateway Functions and Content Interface Files 39 Default Settings for Cognos 8 Analytic Applications 40 Uninstall Cognos 8 Runtime Components 41 Uninstall Cognos 8 Runtime Components for UNIX 41 Uninstall Cognos 8 Runtime Components for Windows 42 Uninstall Cognos 8 Adaptive Applications Framework Components 42 Uninstall Cognos 8 Adaptive Applications Framework Runtime for UNIX 42 Uninstall Cognos 8 Adaptive Applications Framework for Windows 43 Uninstall Application Content Files 44 Chapter 6: Setting Up the Environment 45 Create the Content Store 45 Set Up the Database Client for the Content Store 48 Set Up Environment Variables to Use Scripts 49 Update the Java Environment 50 Configure the Web Server 51 Configure the Web Browser 52 Configure the Router to Test Dispatcher Availability 53 Set Up the Data Source Environment 53 Chapter 7: Configuring Cognos 8 Analytic Applications 55 Start Cognos Configuration 55 Configure Single Computer Installations 56 Set Database Connection Properties for the Content Store 56 Save Your Configuration Settings 57 Test the Installation and Configuration 58 Import the Splash Screen for the Cognos 8 Analytic Applications Portal Page 59 Copy Image Files for Adaptive Analytics Report Icons 59 Finish the Configuration 59 Configure Distributed Installations 60 Set Database Connection Properties for the Content Store 60 Set the Cognos 8 Runtime Gateway and Dispatcher Connections 62 Save Your Configuration Settings 62 Test the Installation and Configuration 62 Import the Splash Screen for the Cognos 8 Analytic Applications Portal Page 63 Copy Image Files for Adaptive Analytics Report Icons 64 Change the Default Configuration Settings 64 Change a URI 64 Change Cryptographic Settings 66 Configure Reporting Components to Use Cognos Application Firewall 67 Configure Temporary File Properties 68 Configure the Gateway to Use a Namespace 68 Enable and Disable Services 69 Specify Resources for the Cognos 8 Service 69 Configure the SSL Protocol 70 Configure SSL for Cognos 8 Adaptive Applications Framework 70 Set Up Shared Trust Between Cognos Servers and Other Servers 72 Select and Rank Cipher Suites for SSL 72 Set Data Manager Runtime Data and Log File Locations 73 Configure Log Messages 73 Set Up the Database Client for a Logging Database 74 Specify the Log Messages Destination 75 4

5 Change Global Settings 76 Customize Language Support to the User Interface 76 Customize Currency Support 77 Customize Content Locale Support 77 Map Content Locales 78 Map Product Locales 79 Customize the Server Time Zone 80 Change Encoding for Messages 80 Customize Cookie Settings 80 Configure Fonts 81 Change the Gateway 82 Configure the Gateway for Cognos Apache Web Server Module 83 Configure a Servlet Gateway 84 Chapter 8: Configuring Cognos 8 Components to Use an Authentication Provider 87 Disable Anonymous Access 88 Restrict User Access to the Cognos Namespace 88 Configuring Cognos 8 Components to Use Active Directory Server 88 Configure an Active Directory Namespace 89 Make Custom User Properties for Active Directory Available to Cognos 8 Components 90 Enabling Secure Communication to the Active Directory Server 90 Include or Exclude Domains Using Advanced Properties 91 Enabling Single Signon Between Active Directory Server and Cognos 8 Components 91 Configuring Cognos 8 to Use Cognos Series 7 Namespace 92 Configure a Cognos Series 7 Namespace 93 Enabling Secure Communication to the Directory Server Used by the Series 7 Namespace 93 Enabling Single Signon Between Cognos Series 7 and Cognos 8 93 Cognos Series 7 Namespaces and the Cognos Series 7 Trusted Signon Plug-in 94 Configuring Cognos 8 to Use a Custom Authentication Provider 96 Configure a Custom Authentication Namespace 96 Configuring Cognos 8 Components to Use LDAP 96 Configure an LDAP Namespace 97 Configure an LDAP Namespace for Active Directory Server 98 Configure an LDAP Namespace for IBM Directory Server 99 Configure an LDAP Namespace for Novell Directory Server 101 Configure an LDAP Namespace for Sun ONE Directory Server 102 Make Custom User Properties for LDAP Available to Cognos 8 Components 104 Enable Secure Communication to the LDAP Server 104 Enabling Single Signon Between LDAP and Cognos 8 Components 105 Replace Operation 105 Configuring Cognos 8 Components to Use etrust SiteMinder 106 Configure a Netegrity SiteMinder Namespace 107 Enabling Secure Communication to the etrust SiteMinder User Directory 108 Enable Single Signon Between etrust SiteMinder and Cognos Protecting the Cognos Web Alias 108 Configuring Cognos 8 Components to Use an NTLM Namespace 108 Configure an NTLM Namespace 109 Enable Single Signon Between NTLM and Cognos 8 Components 109 Test the Namespaces 109 Delete an Authentication Provider 110 Chapter 9: Setting Up an Unattended Installation and Configuration 111 Set Up an Unattended Installation 111 Set Up an Unattended Configuration 113 Installation and Configuration Guide 5

6 Appendix A: Troubleshooting 115 Log Files 115 Use Knowledge Base 117 Call Cognos Support 117 Problems Starting Cognos CFG-ERR-0106 Error When Starting the Cognos 8 Service in Cognos Configuration 118 Unable to Start the Cognos 8 Service Because the Port is Used by Another Process 119 Cognos BI Server Not Available When Starting Cognos Cannot Log On to a Namespace When Using Cognos Connection (PRS-CSE-1255 Error) 122 Cognos 8 Services Fail to Restart After a Network Outage 123 No Warning That Installing a Later Version of Cognos 8 Will Automatically Update the Earlier Version of the Content Store 123 Download of Resource Fails 123 DB2 Returns SQL1224N Error When Connecting from AIX 123 Content Manager Error When Starting Cognos Cannot Open an MS Cube or PowerCube 124 Cannot Open an OLAP Data Source 124 The Page Cannot Be Found When Starting Cognos 8 in Windows The Page Is Not Shown When Opening a Portal After Installing Cognos DPR-ERR-2058 Error Appears in Web Browser When Starting Cognos Report Studio Does Not Start 126 DPR-ERR-2022 Error Appears in Web Browser When Starting Cognos Unable to Download the cognos.xts File 126 Application Server Startup Script Fails 127 Deploying Cognos 8 to an Oracle Application Server or IBM WebSphere Application Server Fails 127 Microsoft Excel 2000 Multipage Report Type Does Not Work 127 Unable to Deserialize Context Attribute Error When Deploying the p2pd.war File to WebLogic 128 Error Appears After Upgrading Cognos 8 on a WebLogic Application Server 128 The Upgrade Message in Cognos Configuration 128 Unable to Uninstall ReportNet Service on Windows 128 Chinese, Japanese, or Korean Characters Are Different After Upgrade 129 Unable to Start the Cognos 8 Service Because the Port is Used by Another Process 129 The Page Cannot Be Found When Starting Cognos 8 in Windows The Page Is Not Shown When Opening a Portal After Installing Cognos Unable to Download the cognos.xts File 130 DPR-ERR-2058 Error Appears in Web Browser When Starting Cognos Index 133 6

7 Introduction This document is intended for use with Cognos 8 Analytic Applications. It contains instructions for installing, configuring, adding content to, and testing Cognos 8 Analytic Applications. Cognos 8 Analytic Applications is a performance management solution that includes a populated data warehouse, packages that describe the data available in the data warehouse, and a set of predefined reports. Using This Document The objectives of the Cognos 8 Analytic Applications documentation are to provide information about the initial deployment of the application to introduce the content of each application and provide a reference to it to help create the data warehouse, and customize and extend the application to help create reports and make them accessible to the business users of the application Audience You should be familiar with reporting concepts database and data warehouse concepts security issues basic Windows and/or UNIX administration skills the existing server environment, enterprise resource planning systems, and the security infrastructure in your organization Related Documentation Our documentation includes user guides, getting started guides, new features guides, readmes, and other materials to meet the needs of our varied audience. The following documents contain related information and may be referred to in this document. Note: If you receive an error message when you click a document name, search the Product Documentation library of the Cognos Global Customer Services Web site ( If you require logon credentials, consult your administrator or send an to support.america@cognos.com. Document Cognos Connection User Guide Cognos 8 Administration and Security Guide Description Using Cognos Connection to publish, find, manage, organize, and view Cognos content, such as scorecards, reports, analyses, and agents Managing servers, security, reports, and Portal Services; setting up Cognos samples; and customizing Cognos 8 Installation and Configuration Guide 7

8 Introduction Document Cognos Configuration User Guide Adaptive Warehouse User Guide Adaptive Analytics User Guide Application user guides Description Using Cognos Configuration to configure Cognos 8 Designing and populating a data warehouse that is used by Analytic Applications Exploring and customizing the content included with Adaptive Analytics, and deploying the reports to report consumers Reference material about the content delivered with Cognos 8 Analytic Applications Finding Documentation Using Quick Tours Getting Help To find the most current Cognos documentation, including all localized documentation, access the Cognos Global Customer Services Web site ( Click the Documentation link to access product documentation. Click the Knowledge Base link to access all documentation, technical papers, and multimedia materials. Product-specific documentation is available in online help from the Help menu or button in Cognos products. You can also download documentation in PDF format from the Cognos Global Customer Services Web site, or click the following link to open a printable version of this document (PDF). You can also read PDF versions of the product readme files and installation guides directly from Cognos product CDs. Quick tours are short online tutorials that illustrate key features in Cognos product components. To view a quick tour, start Cognos Connection and click the Quick Tour link in the lower-right corner of the Welcome page. For more information about using this product or for technical assistance, visit the Cognos Global Customer Services Web site ( This site provides product information, services, user forums, and a knowledge base of documentation and multimedia materials. To create a case, contact a support person, or provide feedback, click the Contact Support link. For information about education and training, click the Training link. Printing Copyright Material You can print selected pages, a section, or the whole book. Cognos grants you a non-exclusive, non-transferable license to use, copy, and reproduce the copyright materials, in printed or electronic format, solely for the purpose of operating, maintaining, and providing internal training on Cognos software. 8

9 Chapter 1: Components Used by Cognos 8 Analytic Applications Cognos components integrate easily into your existing infrastructure by using resources that are in your environment. Some of these existing resources are required, such as a Java Virtual Machine or a third-party database for the content store. Other resources are optional, such as a third-party security provider for authentication. Some Cognos components, including Adaptive Analytics, use an application server. Apache Tomcat is provided as the default application server. Cognos 8 Runtime Components Cognos 8 Analytic Applications uses the following Cognos 8 runtime components. Cognos Connection Cognos Connection is the Web portal for Cognos 8. It provides a single access point to corporate data. It also provides a single point of entry for querying and organizing data. Users can run all their Web-based Cognos 8 applications through Cognos Connection. Other business intelligence applications, and URLs to other applications, can be integrated with Cognos Connection. Cognos Viewer Cognos Viewer is a portlet in which you can view and interact with any type of published Cognos content. It is accessible through Cognos Connection and any existing enterprise portal. Cognos Configuration Cognos Configuration is a tool that you use to configure Cognos 8, and to start and stop its services. Gateway Web communication in Cognos 8 is typically through gateways, which reside on one or more Web servers. A gateway is an extension of a Web server program that transfers information from the Web server to another server. Gateways are often CGI programs, but may follow other standards, such as Internet Server Application Program Interface (ISAPI) and Apache Modules (apache_mod). Content Manager Content Manager is the Cognos 8 service that manages the storage of Cognos data, including security, server configuration data, packages, and models. Content Manager also manages the Cognos namespace. Cognos 8 Adaptive Applications Framework Components Cognos 8 Adaptive Applications Framework consists of the following components. Installation and Configuration Guide 9

10 Chapter 1: Components Used by Cognos 8 Analytic Applications Adaptive Warehouse Adaptive Warehouse is a data modeling environment for users to design and populate a target data warehouse. It provides an interface that facilitates the extraction, transformation, and loading of application-specific data from an enterprise resource planning (ERP) source into the target data warehouse. Adaptive Warehouse Runtime Adaptive Warehouse Runtime is an engine component that is used by the Adaptive Warehouse user interface and scripts. Adaptive Analytics Adaptive Analytics provides a set of reports for performance monitoring, analyses, and operational reporting. These role-based report layouts allow users to quickly start analyzing the data in their warehouse for each performance application. Third-Party Components Cognos 8 Analytic Applications uses the following third-party components. Content Store The content store is a relational database that contains data, such as report packages, that Cognos 8 Analytic Applications needs to operate, and connection information about the external namespace, and the Cognos namespace itself. Log files are not stored in the content store. The Cognos 8 service that uses the content store is named Content Manager. Data Sources Data sources are relational databases or other physical data stores that can be accessed through Cognos 8 Analytic Applications. Application Tier components use data source connections to access data sources. Enterprise Resource Planning (ERP) System Cognos 8 Analytic Applications delivers pre-packaged mappings for different ERP source systems. 10

11 Chapter 2: Distribution Options for Cognos 8 Analytic Applications Cognos 8 Analytic Applications consists of the following installation CDs: Cognos 8 Runtime This CD contains the Cognos 8 runtime components (p. 9). You must install these components if you do not have Cognos 8 installed in your environment your installed version of Cognos 8 is incompatible with the Cognos 8 Analytics Applications installation For more information on Cognos 8 compatible versions, see If you need to install these components, and Cognos 8 is already installed in your environment, you must install them in a different location to Cognos 8. A separate CD is available for each platform on which you can install Cognos 8 runtime components. Cognos 8 Adaptive Applications Framework This Windows CD installs the Adaptive Warehouse and Adaptive Analytics user interface components. You should install these components if you are setting up a demonstration or proof of concept environment you are setting up a user interface development or production environment you want to create scripts that run in a script-based production environment Cognos 8 Adaptive Applications Framework Runtime This CD installs the Adaptive Warehouse Runtime component. You should install this component if you are setting up a script-based production environment that uses a dedicated server to perform regular updates to the database. A separate CD is available for each platform on which you can install the Adaptive Warehouse Runtime component. application content CD This CD contains the application content files for your ERP system. You can install all Cognos 8 Analytic Applications components on one computer, or install them on different computers. The best distribution option depends on your requirements, resources, and preferences. Configuration requirements differ depending on whether you install all components on a single or multiple computers. We strongly recommend that you install the Cognos 8 Adaptive Applications Framework components in a different location to Cognos 8 runtime components. You can change the default installation location for Cognos 8 Adaptive Applications Framework components, but you cannot install them in the same location as Cognos 8 runtime components. The application content files can be installed in any location on any computer. All Components on One Computer You can install the Cognos 8 runtime components, the Cognos 8 Adaptive Applications Framework components, and the application content files on one Windows computer. Choose this scenario for setting up a demonstration or proof of concept environment, where the user load is small. Installation and Configuration Guide 11

12 Chapter 2: Distribution Options for Cognos 8 Analytic Applications You must install Cognos 8 runtime components in a different location on the computer to Cognos 8 Adaptive Applications Framework components. For this scenario, install the Cognos 8 runtime components from the Cognos 8 Runtime CD, followed by Adaptive Warehouse and Adaptive Analytics from the Cognos 8 Adaptive Applications Framework CD. You must also install the application content files from the application content CD. Note: If a compatible version of Cognos 8 is already installed in your environment, the Cognos 8 runtime components are available and it is not necessary to install the Cognos 8 Runtime CD. Because the gateway must be located with the Web server, the single computer must also be running a Web server. Configuration Requirements If you have installed the Cognos 8 runtime components using the Cognos 8 Runtime CD, you must configure your Web server specify connection information to the content store Cognos 8 Adaptive Applications Framework Components and Cognos 8 Runtime Components on Different Computers You can distribute the installation so that Cognos 8 runtime components are installed on one computer and Cognos 8 Adaptive Applications Framework components are installed on a different computer. You must install the Cognos 8 runtime components using the Cognos 8 Runtime CD. Because the gateway must be located with the Web server, the computer on which you install the Cognos 8 runtime components must also be running a Web server. Note: If a compatible version of Cognos 8 is already installed in your environment, the Cognos 8 runtime components are available and it is not necessary to install the Cognos 8 Runtime CD. You can then install the Cognos 8 Adaptive Applications Framework components on a different computer. The CDs that you require for installation depend on the type of environment you are setting up. If you are setting up a user interface development or production environment, or you want to create scripts that run in a script-based production environment, install Adaptive Warehouse and Adaptive Analytics from the Cognos 8 Adaptive Applications Framework CD. If your production environment is script-based and uses a dedicated server to schedule regular updates to the database, install the Adaptive Warehouse Runtime component from the Cognos 8 Adaptive Applications Framework Runtime CD. You must also install the application content files from the application content CD. These files can be installed in any location on any computer. Configuration Requirements for a User Interface Environment To configure the user interface environment, you must configure your Web server (this is not required if Cognos 8 is already installed in your environment) specify connection information to the content store on the computer on which Cognos 8 runtime components are installed (this not required if Cognos 8 is already installed in your environment) set the port numbers for the Cognos 8 gateway and dispatcher, on the computer on which Cognos 8 Analytic Applications are installed Configuration Requirements for a Script-Based Environment To configure the script-based environment for Adaptive Warehouse, you must 12

13 Chapter 2: Distribution Options for Cognos 8 Analytic Applications ensure your Cognos 8 environment is running specify connection information to the data sources set up environment variables so that you can run scripts set the port numbers for the Cognos 8 gateway and dispatcher Cognos 8 Runtime Components on Different Computers When you install Cognos 8 runtime components, you specify where to place the gateways, Application Tier Components, and Content Manager. You can install these components using any of these options: Install all Cognos 8 runtime components on one computer. This option is typically used for a demonstration or in a proof of concept environment. Install the gateway on a separate computer. In this option, the gateway and Web server are on one computer, and the remaining Cognos components are on other computers. You may choose this option if you have existing Web servers available to handle Cognos component requests. Install Application Tier Components and Content Manager on separate computers. Choose this option to maximize performance, availability, capacity, or security based on the processing characteristics of your organization. After installing Cognos 8 runtime components, you must configure them to communicate with each other. If a compatible version of Cognos 8 is already installed in your environment, the Cognos 8 runtime components are available and it is not necessary to install the Cognos 8 Runtime CD. For more information on distribution options for Cognos 8, see the Cognos 8 Installation and Configuration Guide. All Cognos 8 Runtime Components on One Computer You can install all the Cognos 8 runtime components on one computer. Choose this scenario for proof of concept or demonstration environments where the user load is small. Because the gateway must be located with the Web server, the single computer must also be running a Web server. In the following diagram, all Cognos 8 server components are installed on one computer. The content store, data sources, and Adaptive Warehouse and Adaptive Analytics are located on different computers. Installation and Configuration Guide 13

14 Chapter 2: Distribution Options for Cognos 8 Analytic Applications Configuration Requirements If you install all Cognos 8 runtime components on the same computer, you must then configure your Web server to view Cognos content specify connection information to the content store Gateways on Separate Computers The gateway manages communications among Cognos 8 runtime components. It can reside on one or more Web servers. You can install the gateway and a Web server on one computer, and install the remaining Cognos 8 runtime components on different computers. If you have a Web farm, you may want to install a gateway on each Web server. Using multiple Web servers to manage incoming requests provides a better level of service. If you install only the gateway component on the same computer as the Web server, your Web server manages the core Web services and does not process user requests. This separation of processing may be required if you have a firewall between the Web server and your Application Tier Components computers. In the following diagram, two Web servers each have a gateway installed. Incoming requests are passed to either gateway and forwarded to the Application Tier Components computer. 14

15 Chapter 2: Distribution Options for Cognos 8 Analytic Applications Configuration Requirements If you install one or more gateways on separate computers, ensure that you can view Cognos content and that the gateways can communicate with other Cognos components. On each computer where the gateway is installed you must configure cryptographic properties configure your Web server to view Cognos content configure the Dispatcher URIs Application Tier Components and Content Managers on Separate Computers One or more Cognos 8 runtime components use the Cognos Connection interface to balance loads, access data, perform queries, schedule jobs, and render reports. Content Manager stores all report specifications, results, packages, folders, and jobs in the content store. You can install the Application Tier Components and Content Manager on the same computer, or on different computers. Installing on different computers can improve performance, availability, and capacity. To improve scalability in an environment in which there is a large number of requests to process, you can install the Application Tier Components on multiple computers dedicated to processing incoming requests. Installing the Application Tier Components on multiple computers distributes and balances the load among the computers. You also have better accessibility and throughput than on a single computer, as well as support if one computer fails. In the following diagram, incoming requests are routed to a gateway. The gateway forwards the request to one of the Application Tier Components computers. The report server forwards the request to Content Manager, which queries the content store and sends the results back to the report server for rendering. Configuration Requirements If you install one or more Application Tier Components on a separate computer, to ensure that they can communicate with other Cognos 8 runtime reporting components you must configure cryptographic properties specify all Content Manager URIs specify the Dispatcher URIs specify the Dispatcher URI for external applications Installation and Configuration Guide 15

16 Chapter 2: Distribution Options for Cognos 8 Analytic Applications More Than One Content Manager You can install any number of installations of Content Manager, although only one is active at any time. The other installations each act as a standby Content Manager. One becomes active only if the computer on which the active Content Manager is installed fails. For failover support, it is advisable to install Content Manager on two or more computers. Content Manager stores data that Cognos 8 runtime components need to operate, such as report specifications, published models, and the packages that contain them; connection information for data sources; information about the external namespace and the Cognos namespace itself. The content store is a relational database management system (RDBMS). There is only one content store for each Cognos installation. You may choose to install Content Manager separately from the Application Tier Components if your data contains sensitive information. Data is then stored in the data tier along with your security information. When an active Content Manager fails, unsaved session data is lost. When the new active Content Manager takes over, users may be prompted to logon. Configuration Requirements On each computer where you install Content Manager, you must configure cryptographic properties specify connection information to the content store specify the Dispatcher URIs specify all Content Manager URIs specify the Dispatcher URI for external applications 16

17 Chapter 3: Workflows for Cognos 8 Analytic Applications After you decide on the appropriate distribution options (p. 11) for your environment, you must follow a specific workflow to install and configure Cognos 8 Analytic Applications. For example, follow one workflow to install and configure Cognos 8 Analytic Applications on a single computer. Follow another workflow to install and configure Cognos 8 Analytic Applications in a distributed installation. We recommend that you print the workflow that you plan to use. You can then use the printed copy as a checklist to ensure that you complete all tasks. Install Cognos 8 Adaptive Applications Framework Components with Cognos 8 Runtime Components If you do not already have Cognos 8 installed in your environment, you must install the Cognos 8 runtime components provided. The following workflows show the required tasks for installing and configuring a single-computer installation and a distributed installation. For information about installing Cognos 8 Adaptive Applications Framework within an existing Cognos 8 environment, see "Install Cognos 8 Adaptive Applications Framework Components Within an Existing Cognos 8 Environment" (p. 19). For all types of installation, perform the installation in the following order: Cognos 8 runtime components Cognos 8 Adaptive Applications Framework components application content files Single-Computer Installation The following workflow shows the required tasks for a single-computer installation. Installation and Configuration Guide 17

18 Chapter 3: Workflows for Cognos 8 Analytic Applications Distributed Installation for a User Interface Environment The following workflow shows the required tasks for a distributed installation in a user interface environment. 18

19 Chapter 3: Workflows for Cognos 8 Analytic Applications Distributed Installation for a Script-Based Environment The following workflow shows the required tasks for a distributed installation in a script-based environment. Install Cognos 8 Adaptive Applications Framework Components Within an Existing Cognos 8 Environment If you already have a compatible version of Cognos 8 installed in your environment, you can install Cognos 8 Adaptive Applications Framework and configure it so that Adaptive Warehouse and Adaptive Analytics access the necessary Cognos 8 runtime components. The following workflows show the required tasks for installing and configuring a single-computer installation and a distributed installation. For information about installing Cognos 8 Analytic Applications without an existing Cognos 8 environment, see "Install Cognos 8 Adaptive Applications Framework Components with Cognos 8 Runtime Components" (p. 17). For all types of installation, perform the installation in the following order: Cognos 8 Adaptive Applications Framework components application content files Single-Computer Installation The following workflow shows the required tasks for a single-computer installation. Installation and Configuration Guide 19

20 Chapter 3: Workflows for Cognos 8 Analytic Applications Distributed Installation for a User Interface Environment The following workflow shows the required tasks for a distributed installation in a user interface environment. Distributed Installation for a Script-Based Environment The following workflow shows the required tasks for a distributed installation in a script-based environment. 20

21 Chapter 3: Workflows for Cognos 8 Analytic Applications Install SAP Interface Files After you have installed Cognos 8 Analytic Applications in your environment, you must install the SAP interface files if you want to use SAP content. The following workflow shows the required tasks for installing SAP interface files. Installation and Configuration Guide 21

22 Chapter 3: Workflows for Cognos 8 Analytic Applications 22

23 Chapter 4: Upgrading Cognos 8 Analytic Applications Plan the Upgrade If you have a previous version of Cognos 8 Analytic Applications installed you must upgrade to Cognos 8 Analytic Applications 8.2 to use the new features available. To upgrade Cognos 8 Analytic Applications, we recommend that you do the following: Plan the Upgrade Upgrade Cognos 8 Runtime Components Upgrade Cognos 8 Adaptive Applications Framework Components from Cognos 8 Analytic Applications 8.1 We recommend that you plan your upgrade so that you know what to expect at each stage of the process. In the planning stage, you can review the upgrade documentation for information about expected behavior, new features, deprecated features, compatibility between versions, and requirements for preparing your production environment. When you finish the review, you can then conduct a site survey to identify the infrastructure, reports, and custom configuration settings. Finally, you can test the upgrade on a subset of your data so that you can fine tune your reports and data before committing to the full upgrade. Use the following checklist to guide you through the planning process: Review the documentation Conduct a site survey Perform a trial upgrade Review the Documentation Cognos provides documentation from a variety of sources to help you achieve a successful upgrade. All of the documentation is available online at the Cognos Global Customer Services Web site ( 1. Read the rest of the upgrade information in this document. 2. From the Documentation link on the Cognos Global Customer Services Web site ( download and review the latest versions of the following documentation: Cognos 8 Analytic Applications Readme The Readme is regularly updated to document issues that might affect you during an upgrade. the section of the user guide for your application about upgrading applications created in an earlier version The user guide for your application contains information about how the content has changed since the previous release, and about the process of upgrading your application. the section of the Adaptive Warehouse User Guide about upgrading a data warehouse the section of the Adaptive Analytics User Guide about upgrading an Adaptive Analytics project all Best Practices documents about upgrading Installation and Configuration Guide 23

24 Chapter 4: Upgrading Cognos 8 Analytic Applications Conduct a Site Survey Do a site survey to assess the current production environment and identify areas that require attention during an upgrade. The site survey should include information about the infrastructure, users, and configuration settings for Cognos 8 Analytic Applications. 1. Assess the third-party software that you use by doing the following: List third-party software, such as operating systems, Web servers, security, databases, and so on. Compare the list to the supported versions for your target upgrade version, available from the Production Information, Software Environments link at the Cognos Global Customer Services Web site ( Determine whether any third-party components require updating. 2. List your applications, including Adaptive Warehouse models and packages Adaptive Analytics reports 3. List all the reports and do the following: Make note of heavily used reports and high-profile reports for priority treatment during the upgrade. Use audit report data to determine report usage. For more information about audit reports, see the Administration and Security Guide. Make note of reports that fail to run in the current environment. They are unlikely to upgrade successfully. Repair these reports so that they upgrade. Consider retiring unused or little-used reports. 4. List the following information about your configuration: configuration settings that you enabled using Cognos Configuration These settings are preserved through the upgrade. They are stored in two files. For Cognos 8, the files are cogstartup.xml and coglocale.xml. changes to other configuration files Changes to other files must be made manually during the upgrade. If you changed other configuration files, you must assess the changes that you want to preserve in the upgraded environment. This may include.xml,.txt, and.css files in the configuration, templates, webapps, and webcontent directories of the installation location. Important: Changes to.ini files are not supported. If you changed.ini files, please contact Customer Support. Perform a Trial Upgrade We recommend that you perform a trial upgrade several weeks before upgrading your production system. The trial upgrade identifies components that will upgrade with minimal effort and components that may require additional actions before or after the upgrade. 1. In your production environment, back up your data warehouse and export the content files. 2. Prepare the test environment by doing the following: Install your current release system in the test environment and configure it to be similar to your production environment. Restore the data warehouse and test that the data source connections to the data warehouse are valid. 3. Install and configure the target upgrade release in the test environment. 4. Using Adaptive Warehouse and Adaptive Analytics, upgrade your application by upgrading the data warehouse and your Adaptive Analytics project. 24

25 Chapter 4: Upgrading Cognos 8 Analytic Applications For more information, see the user guide for your application. The user guide contains information about the process of upgrading your application. It refers to the Adaptive Warehouse User Guide for information about upgrading a data warehouse, and to the Adaptive Analytics User Guide for information about upgrading an Adaptive Analytics project. 5. Using Cognos Connection, publish the reports from the deployment archive. 6. Review the reports and compare the output between the earlier version and the upgraded version. 7. Troubleshoot any issues and contact Cognos Support about unresolved upgrade issues. When all issues are resolved, you can develop your plan for the full upgrade. Upgrade Cognos 8 Runtime Components If you have a previous version of Cognos 8 Analytic Applications installed, you must upgrade the Cognos 8 runtime components before you can use version 8.2. This section explains how you upgrade these components if you originally installed them using the Cognos 8 Runtime CD. If you previously installed Cognos 8 Analytic Applications within an existing Cognos 8 environment, you must ensure your version of Cognos 8 is compatible, and upgrade it if necessary. For more information on Cognos 8 compatible versions, see For more information on upgrading Cognos 8, see the Cognos 8 Installation and Configuration Guide. You can upgrade Cognos 8 Runtime in the same directory as an earlier version or in a different directory. If you are installing in a new directory, see "Install Cognos 8 Runtime Components in a New Directory" (p. 26). When you back up the configuration data, you store it in a secure directory. The directory must be protected from unauthorized or inappropriate access. An alternative method of upgrading is to export the entire content store to a deployment archive and then import the deployment archive into Cognos 8 Runtime after the upgrade. For more information about deployment, see the Cognos 8 Administration and Security Guide. A deployment upgrade is required if you want to change the type of database that you use for the content store. If you use the deployment upgrade method, only the steps for exporting and restoring the configuration data are different. All other steps are the same as documented in this section. Customized Cognos 8 Runtime Files If you manually edited any configuration files, the changes will be overwritten during the upgrade. You must reapply the changes. Keep a record of any customizations to ensure that they can be reapplied after upgrading. Back up these files so that the original version can be restored if necessary. You may have modified files other than those in the configuration folder. If so, you should also back up the additional files before upgrading. The Cognos 8 Runtime presentation service supports automatic upgrade of some system.xml files. If you made many customization changes to system.xml files, you can use this automatic upgrade feature instead of reapplying the changes manually after upgrading. The system.xml files are overwritten during the installation of Cognos 8 Runtime. You must back up the customized versions of these files and then copy them to the directory after upgrading Cognos 8 Runtime. The automatic upgrade is applied when you start the Cognos 8 service. The system.xml files for which automatic upgrade is supported are in the following directories: c8_location/templates/ps c8_location/templates/ps/portal c8_location/templates/ps/qs Installation and Configuration Guide 25

26 Chapter 4: Upgrading Cognos 8 Analytic Applications Note: The recommended method to upgrade customized files is to manually reapply changes after the new software is installed. Automatic upgrade of system.xml files is to be used only when you have made a large number of customizations to these files. Install Cognos 8 Runtime Components in the Same Directory This section describes how to upgrade Cognos 8 Runtime components in the same directory as an earlier version. 1. Using your database tools, back up the existing content store database. For information on how to do this, see the documentation for your database. 2. Back up the following files to a secure location: coglocale.xml in the c8_location/configuration directory server.xml in the c8_location/tomcat4.1.27/conf directory system.xml in the appropriate directory, if required Ensure that you note the directory path. For example, c8_location/templates/ps 3. In Cognos Configuration, export the configuration data to the same secure location. To make the data usable for upgrading, name the file cogstartup.xml. Important: Because the exported cogstartup.xml file contains unencrypted passwords, ensure that the location is secure. 4. Back up any manually edited files in the c8_location/configuration and other directories to a secure location. 5. Stop all Cognos services. 6. Uninstall Cognos 8 Runtime from every Cognos 8 Runtime computer (p. 41). 7. Install the newer version of Cognos 8 Runtime in the same directory that you used for Cognos 8 Runtime on every computer (p. 31). 8. Copy the.xml files from the secure backup location as follows: Copy cogstartup.xml and coglocale.xml to c8_location/configuration. Copy server.xml to c8_location/tomcat4.1.27/conf. Copy system.xml to the appropriate directory, if required. For example, c8_location/templates/ps If you are prompted to overwrite existing files, click Yes. 9. For files that you manually edited in earlier versions of Cognos 8 Runtime, edit the new versions of these files in the c8_location directory and reapply the changes that you made to the original customized files. Do not copy the earlier versions of the files to the c8_location directories. They may not be compatible. 10. In Cognos Configuration, review the configuration, and then save it. 11. Start the Cognos 8 service. Cognos 8 Runtime automatically upgrades the content store. System.xml files are upgraded, if required, to a Cognos 8 Runtime compatible version. Install Cognos 8 Runtime Components in a New Directory This section describes how to upgrade Cognos 8 Runtime components in a different directory to an earlier version. 1. Using your database tools, copy your existing content store database into a new content store database. 26

27 Chapter 4: Upgrading Cognos 8 Analytic Applications For information on how to do this, see the documentation for your database. 2. Back up the following files to a secure location: coglocale.xml in the c8_location/configuration directory server.xml in the c8_location/tomcat4.1.27/conf directory system.xml in the appropriate directory, if required Ensure that you note the directory path. For example, c8_location/templates/ps In Cognos Configuration, export the configuration data to the same secure location. To make the data usable for upgrading, name the file cogstartup.xml. Important: Because the exported cogstartup.xml file contains unencrypted passwords, ensure that the location is secure. Back up any manually edited files in the c8_location/configuration and other directories to a secure location. 3. Install Cognos 8 Runtime in a new directory (p. 33). 4. Copy the.xml files from the secure backup location to the following directory: Copy cogstartup.xml and coglocale.xml to c8_location/configuration. Copy server.xml to c8_location/tomcat4.1.27/conf. Copy system.xml to the same directory in the new location as it was in the earlier version, if required. For example, c8_location/templates/ps If you are prompted to overwrite existing files, click Yes. 5. For files that you manually edited, edit the new versions of these files in the c8_location directory and reapply the changes that you made to the original customized files. Do not copy the earlier versions of the files to the c8_location directories. They may not be compatible. 6. Configure new Web server aliases (p. 51). 7. In Cognos Configuration, configure Cognos 8 Runtime to point to the new content store, configure new ports and URLs, use a different cookie path, and then save the configuration (p. 55). Ensure that the port numbers and service name for this installation are different from those used for earlier versions so that there are no conflicts. Ensure that security authentication settings are not changed. For example, the namespaces must be the same for policies, users, roles, and groups for security authentication to work correctly. 8. Start the Cognos 8 service. Cognos 8 Runtime automatically upgrades the new content store. System.xml files are upgraded, if required, to a Cognos 8 Runtime compatible version. 9. Open the Administration portal, and unregister the dispatchers that are used with earlier versions of Cognos 8 Runtime. When you open the Administration portal in Cognos 8 Runtime, you may see the dispatchers that are registered for both versions. For more information, see the Cognos 8 Administration and Security Guide. 10. When you are ready to uninstall the previous version of Cognos 8 Runtime, do the following: Stop the Cognos 8 service. Uninstall Cognos 8 Runtime from all computers (p. 41). When you complete the upgrade tasks, Cognos 8 Runtime is fully configured except for new properties and features. If you use Chinese, Japanese, or Korean characters, you may notice differences in some characters after upgrading. For more information, see the Troubleshooting Guide. If you use a DB2 database for the content store, you can tune the database to take advantage of DB2 features. For more information, see the Architecture and Planning Guide. Installation and Configuration Guide 27