COGNOS (R) ENTERPRISE PLANNING SERIES

Transcription

1 COGNOS (R) ENTERPRISE PLANNING SERIES COGNOS PLANNING CONTRIBUTOR CLIENT LOADER INSTALLATION GUIDE Contributor Client Loader User Guide DD-MM-YYYY Contributor Client Loader please update with product version as defined in Trakker Type the text for the HTML TOC entry Contributor Client Loader Online Help Cognos Planning version 7.2 Cognos Planning version 7.2 INSTALLATION GUIDE THE NEXT LEVEL OF PERFORMANCE TM

2 Product Information This document applies to Cognos Planning version 7.2 and may also apply to subsequent releases. To check for newer versions of this document, visit the Cognos support Web site ( Copyright Copyright (C) 2004 Cognos Incorporated. Architect is protected by one or more of the following U.S. Patents: 6,609,123B1; 6,611,838B1. Cognos ReportNet is protected by one or more of the following U.S. Patents: 6,609,123B1. 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. 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. Information about Cognos Products and Accessibility can be found at

3 Table of Contents Introduction 5 Additional Materials 7 Chapter 1: Client Loader 9 System Requirements 9 Installing Client Loader 9 Configuring Client Loader 10 Add CAB Files to Contributor Web Server 10 Add a Client Extension to a Contributor Application 10 Remove a Client Extension from a Contributor Application 11 Organize Extensions in Groups 11 Configure a Client Extension 11 Enable and Disable Client Extensions 12 Uninstalling Client Loader 12 Index 15 Installation Guide 3

4 4 Cognos Planning Contributor Client Loader

5 Introduction This Installation Guide contains instructions for installing Contributor Client Loader. This document is available as online help.for information about related documents, see "Additional Materials" (p. 7). Cognos Planning - Contributor Contributor is a Web-based planning product that can involve thousands of people in multiple locations in the collection of data from managers and others. Information is stored in a single data repository, providing complete planning data for Cognos Planning-Analyst. Contributor Client Loader Contributor Client Loader is an extension to the Contributor client. You use it to load data from outside sources into Contributor and to transfer data within Contributor. Client Loader is configured by the Contributor administrator and is installed on the administration machine. Also, it is installed on the client machines through a one-time download of the necessary components. The Contributor administrator grants access to Client Loader through the Contributor Administration console. Questions or Comments? For additional technical information about using this product, visit the Cognos support Web site ( Installation Guide 5

6 Introduction 6 Cognos Planning Contributor Client Loader

7 Additional Materials In this document, we refer to the following topics in other Cognos documents. Topic Installing and configuring Cognos Planning products Getting to know Cognos Planning - Analyst Using Cognos Planning - Analyst and Manager Getting to know Cognos Planning - Analyst Add-in for Excel Administration of Cognos Planning - Contributor Automation of Cognos Planning - Contributor administration Using the Cognos Planning - Contributor Web client Extending the functionality of Cognos Planning - Contributor Cognos Enterprise Planning Series solutions Location Cognos Planning Installation Guide Analyst Tutorial Analyst and Manager Help Analyst Add-in for Excel Tutorial Contributor Administration Guide Contributor Automation Guide Contributor Browser Help Contributor Administration Guide Cognos Enterprise Planning Series Integration Guide Integrating Cognos Enterprise Planning Series Products The Cognos Enterprise Planning Series Integration Guide discusses how to create solutions such as integrating Cognos Consolidation with Cognos Planning - Analyst and integrating Cognos Analytic Applications with Analyst. For information about how to use the Contributor extensions to create solutions with other Cognos products, see the Contributor Administration Guide. Formats Our documentation includes user guides, tutorial guides, reference books, and other materials in various formats, including PDF and HTML help to meet the needs of our varied audience. Online Help Some information is available in online help. Online help is available from the Help button in a Web browser or the Help menu and Help button in Windows products. Installation Guide 7

8 Additional Materials Books for Printing 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 providing internal training on, operating, and maintaining the Cognos software. You can read the product readme files, installation guides and product documentation directly from Cognos Planning product CDs. 8 Cognos Planning Contributor Client Loader

9 Chapter 1: Client Loader System Requirements Contributor Client Loader is an extension to the Contributor client. You use it to load data from outside sources into Contributor and to transfer data within Contributor. In order to use Client Loader, you must: have Cognos Enterprise Planning Series version 7.2 SP1 installed. be a user in Cognos Contributor with review access to at least one tab in an existing Contributor application. For an up-to-date list of the software environments supported by Cognos products, see the Cognos support site ( The support site includes information about operating systems, system requirements, patches, browsers, Web servers, directory servers, database servers, OLAP servers, and more. Updates to the software are made available on the Cognos support Web site ( These updates contain the latest set of quality improvements that were completed after the release of this software. We recommend that you review these updates and apply them once you have completed the installation. Installing Client Loader When you install Client Loader, you are transferring files to your machine and updating the current configuration to include Client Loader. Steps 1. From the download location, double-click Setup.exe. 2. Click Install Cognos Planning-Client Loader Extension. The installation begins. 3. In the Welcome dialog box of the Installation Wizard, read the message and then click Next. 4. In the License Agreement dialog box, read the agreement, click I accept, and then click Next. 5. In the Installation Location dialog box, do one of the following: click Next to accept change the default installation location for the Client Loader components, and then click Next. 6. If you are satisfied with your selection, click Next, or click Back to make corrections, and then click Next. 7. In the Component Configuration dialog box, select Open the Configuration Manager to customize component configuration and then click Next to open Configuration Manager. 8. In Configuration Manager, on the Welcome page, click the Start tab. 9. Click Open the current configuration. 10. In the Explorer window, expand Cognos Planning, EP Client Loader. 11. Right-click EP Client Loader and select Validate Selection. This checks for errors in Client Loader. Installation Guide 9

10 Chapter 1: Client Loader 12. Right-click EP Client Loader and select Apply Selection. This implements the changes made by installing Client Loader. 13. Close Configuration Manager. 14. In the Finish dialog box, click Finish or review the other options. Configuring Client Loader You must configure Client Loader before users can use it. Follow this process to set up Client Loader: add client extension CAB files to the Contributor Web server (p. 10) add client extensions to the Contributor application (p. 10) remove a client extension from a Contributor application (p. 11) create an extension group (p. 11) edit an extension group (p. 11) re-order an extension group (p. 11) delete an extension group (p. 11) configure client extension (p. 11) enable and disable client extensions (p. 12) Add CAB Files to Contributor Web Server In order for a client extension to automatically be installed on the client machine, you must add the extension CAB files to the CONTROLS directory of the Contributor Web site. When users first click on the Extension button in the Grid, they are prompted to download the extension, which uses the CAB file located in the CONTROLS directory. Steps 1. Open the Extensions CABs folder, typically C:\Program Files\Cognos\cer3\Contributor\webtemplate\CONTROLS, and copy the necessary CAB files. This step is only necessary if the Web directory was not created by copying the webtemplate directory. 2. Copy the Ext72Dependencies.cab file if you were required to install the Extension Dependencies prior to installing the extension. 3. Open the Contributor Web site s CONTROLS directory on the Contributor Web site, typically C:\Program Files\Cognos\cer3\contributor\contributorapplicationname\CONTROLS, and paste the CAB files into that folder. Add a Client Extension to a Contributor Application For a user to have access to a Client extension, you must add it to your Contributor application. Steps 1. In the Contributor Administration Console application tree, go to Production, Extensions, Client Extensions, and select the Configure Extensions tab. 2. Click Add. A window appears listing the extensions that are installed on this computer but have not yet been added to this Contributor application. 10 Cognos Planning Contributor Client Loader

11 Chapter 1: Client Loader 3. Select the extensions you want to add, and click OK. The extensions appear in the Extension list. Remove a Client Extension from a Contributor Application Deleting a client extension from your Contributor application removes the extension settings from your application, but does not delete the extension from your computer. Steps 1. In the Contributor Administration Console application tree, go to Production, Extensions, Client Extensions, and select the Configure Extensions tab. 2. Select the extension and click Delete. 3. You will be prompted to confirm the deletion. Click Yes. Organize Extensions in Groups Use Extension Groups to organize client extensions. Extension Groups appear as buttons on the Contributor grid page. If no extensions are assigned to a group, then the button does not appear on the client s grid. If more than one extension is assigned to an Extension Group, a list of the extensions appears when you click the group button. For example, if you installed more than one export extension, you create an Extension Group named export to organize the export extensions. Steps to Create an Extension Group 1. In the Contributor Administration Console application tree, go to Production, Extensions, Client Extensions, and click the Extension Groups tab. 2. Click Add. 3. In the Extension Groups box, type a name for the new group. Extension group names must be 15 characters or less and should be meaningful. 4. Click OK. The name of the new extension group appears in the Extension Group list. Tip: You can rename an extension group by clicking Edit in the Extension Groups dialog box. You can reorder extension groups by using the arrow buttons on the Extension Group tab. Steps to Delete an Extension Group 1. Ensure that no extensions are assigned to this button before you delete an Extension Group, You do this by going to the Configure Extensions tab and reassigning any extensions assigned to the button you wish to delete. 2. Select the button you want to delete and click Delete in the Extension Groups tab. Configure a Client Extension Steps 1. In the Contributor Administration Console application tree, click Production, Extensions, Client Extensions, and click the Configure Extensions tab. 2. Select the extension you want and click Configure. The Extension Properties dialog box appears. In the CAB filename box, the name of the CAB file, including the.cab extension is automatically displayed. The CAB file contains the files the client needs to run the extension and is located in the CONTROLS directory of the Contributor client Web site. Installation Guide 11

12 Chapter 1: Client Loader 3. In the Display Name box, rename the extension or leave the default name. If the extension is configured for manual activation, this name is also used for the activation button. 4. In the Activation Mode box, select one of the following options to choose how you want the extensions activated: Manual - these extensions run when user clicks the Extension Group button in the Contributor grid or activated using the right-click menu. To complete this box, you need to enter the appropriate information for each extension as shown in the following table. Automatic - these extensions run automatically when the Contributor grid opens. No activation button is added to the grid toolbar. Custom - only applies to the Print to Excel extension. Modifies the standard Print button on the Contributor grid so that the Print to Excel extension is activated instead of the default print feature in Contributor Web. The following table lists the parameters for configuring Client Loader. Extension Name CAB filename Default Display Name Available Activation Modes EP Client Loader ExtClientLoader.cab EP Client Loader Manual 5. If you selected the manual activation mode, click the appropriate Extension Group for this extension to do the following: Click Next. In the Extension Properties-Users dialog box, either click Select All or select which users you want to have access. Click Next. Choose whether to enable this extension now, by clicking Yes or No. 6. Click Finish. Enable and Disable Client Extensions You can control when an extension is available for Web client users by enabling and disabling it through the Contributor Administration Console. You must enable a client extension before users can use it. Steps On the Configure Extensions tab, right-click on the extension and click Enable or Disable. Uninstalling Client Loader Steps 1. From the Start menu, click Settings, Control Panel. 2. Double-click Add/Remove Programs. 3. Select Cognos Series 7 Version 2 and Enterprise Planning Series and do one of the following: For Windows NT, click Add/Remove. For Windows 2000, click Change/Remove. The Uninstall Wizard begins. 4. Click Next. 5. Select the check box beside Cognos Planning-Client Loader Extension, and then click Next. 12 Cognos Planning Contributor Client Loader

13 Chapter 1: Client Loader 6. Click Yes to confirm the uninstallation. Installation Guide 13

14 Chapter 1: Client Loader 14 Cognos Planning Contributor Client Loader

15 Index A Analyst integration with Analytic Applications, 7 integration with Consolidation, 7 Analytic Applications integration with Analyst, 7 C CAB files, 10 Configuration Client Loader, 10 Consolidation integration with Analyst, 7 copyright, 2 D document version, 2 E Extension Groups, 10 Extensions integration, 7 I Installation Client Loader, 9 uninstalling Client Loader, 12 Integration Guide Analytic Applications integration with Analyst, 7 Consolidation integration with Analyst, 7 P product version, 2 V version product, 2 Installation Guide 15

16 Index 16 Cognos Planning Contributor Client Loader