Cognos 8 - Customizing the Cognos 8 Welcome Page

  • View
    87

  • Download
    0

Embed Size (px)

Text of Cognos 8 - Customizing the Cognos 8 Welcome Page

Proven Practice

Customizing the IBM Cognos 8 Welcome PageProduct(s): IBM Cognos 8 Area of Interest: Infrastructure

Customizing the IBM Cognos 8 Welcome Page

2

Copyright Copyright 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company. While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to the information contained in this document will be documented in subsequent editions. This document contains proprietary information of Cognos. All rights are reserved. No part of this document may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos. Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries, or both. All other names are trademarks or registered trademarks of their respective companies. Information about Cognos products can be found at www.cognos.com This document is maintained by the Best Practices, Product and Technology team. You can send comments, suggestions, and additions to cscogpp@ca.ibm.com .

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Page

3

Contents1 2 3 4 INTRODUCTION ............................................................................................ 4 CUSTOMIZATION OPTIONS .......................................................................... 4 CREATE OR USE YOUR OWN CUSTOM WELCOME PAGE ............................... 8 LOCALIZATION AND STYLES....................................................................... 12

5 MODIFYING THE ORDER AND ADDING CUSTOM SECTIONS TO THE WELCOME PAGE...................................................................................................... 12 6 APPENDIX REFERENCE THE REQUIRED GROUPS OR ROLES IN THE SYSTEM.XML FILE................................................................................................... 15

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Page

4

1

IntroductionIBM Cognos 8 has a predefined Welcome page that all users are directed to when they first login. This Welcome page varies on the users style. Although the Welcome page provides a good starting point into IBM Cognos products, most customers will inevitably want to customize this page or bypass it altogether. In IBM Cognos 8, users and administrators have the capability to set any view as their home or Welcome page. An administrator can customize the existing Welcome page, use their own custom HTML page, or use a hybrid of their custom Welcome page and sections of the existing Welcome Page. Furthermore, users can choose to set any portal tab as their home page. This document provides technical details on how this can be done as well as details on how this can be localized.

2

Customization Options

Administrators can customize the Welcome Page in the following ways: Change the colors, fonts, and text of the existing Welcome Page. Set their own HTML page as their default Welcome Page. Using this approach, administrators can still embed the links and text of the default Welcome Page within their own custom page. Set any portal tab as their default start page.

Customizing the existing Welcome PageHere is a look at the default IBM Cognos 8 Welcome Page for the Corporate style:

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Page This page can be customized to use its own colors, text, and fonts to match your corporate branding.

5

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Page

6

Files Used /c8/webcontent/skins/corporate/portal/default.css /c8/templates/ps/messages/portal_en.xml /c8/webcontent/corporate/fonts.css

Modifying the Colors of the Welcome Page The default.css file controls the colors used in the existing Welcome Page.The following parameters can be modified to customize this Welcome Page:Controls the outer blue background on the Welcome page..welcomePageFull { background-color: #ffffff; padding: 0%; }

Controls the outer-most border and the blue vertical lines on the right hand side of the page..welcomeContentPanel { border-style: solid; border-width: 0px; border-color: #000000; padding:0px; background-image: url(../branding/welcome_back.gif); }

Controls the image used at the top of the Welcome Page.welcomeLogoContainer { height: 55px; width: 225px; background-image:url(../branding/bank.gif); background-repeat: no-repeat; }

Controls the text color of the user thats logged in..welcomeUserNameContainer { padding-right:8px; color: #333300; padding-bottom: 5px; font-weight: bold; white-space:nowrap; }

Controls the left-hand Welcome Panel.welcomeLeftPanel { background-color: #c5c58a; height: 100%; margin-right:1px; text-align: middle; vertical-align:top; } .welcomeTitle { color: #333300; text-align: left; border-bottom: 3px solid #666633;

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Pagewidth:100%; white-space:nowrap; font-weight: bold; padding-left: 10px; padding-right: 10px; padding-top: 10px; font-size: 120%; }

7

Controls the background and text color in the main section of the page..welcomeToolPanel { height:100%; background-color: #eeeecf; margin-left:1px; padding-top: 15px; padding-left: 15px; padding-right: 15px; } .welcomeToolHeading { font-size: 70%; font-weight: bold; color: #333300; padding-bottom:3px; } .welcomeToolDescription { font-size: 70%; color: #333300; }

Change the color of the hyperlinksa { color: #333399; }

Controls the Show this page in the future.welcomeHideShowText { padding-left:5px; font-size: 70%; color: #333300; }

Controls the Quick Tour button.welcomeQTContainer { margin-top:15px; float:right; background-color: #e4e4c5; border:1px solid #333300; padding: 1px; } .welcomeQTButton { background-color: #e4e4c5; cursor:pointer; color: #333300; font-size: 70%; padding:5px; font-weight: bold; white-space:nowrap; } .welcomeLegalNotice {

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Pagemargin-top:20px; font-size: 70%; color: #ffffff; } .welcomeSlogan { font-size: 50%; color:#ffffff; white-space:nowrap; }

8

End Result

Changing the Default Text on the Welcome Page The text that appears on the Welcome Page comes from message files. In particular, the text for the Welcome Page is located in the /c8/templates/ps/messages/portal_language.xml file. To modify the English text used in the Welcome page, you would need to modify the portal_en.xml file. All other languages have a prefix to specify their language. To modify the text, search for the appropriate text string you wish to modify and modify it directly within this file. Please note that the IBM Cognos 8 service needs to be restarted for these changes to take effect.

3 Create or Use your Own Custom Welcome PageIn many instances, administrators may wish to have a Welcome Page that matches a very specific style or they may want their users to enter IBM Cognos through another web site. Instead of using the existing Welcome Page, you can create your own custom Welcome Page using any standard HTML page.

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Page

9

To configure IBM Cognos 8 to use its own Welcome Page: 1. Edit the /c8/templates/ps/portal/system.xml file 2. Enter the following parameter in this file.http://server/cognos8/customwelcomepage.html

Make sure that this parameter is entered inside the node and outside of the node. 3. Restart the IBM Cognos 8 service. When you launch IBM Cognos 8, this new Welcome Page will be used. Additionally, the link through Help > Go to Welcome Page will point to this new Welcome Page as well. Any standard HTML page can be used as your new Welcome Page. However, as an administrator, you may wish to also place the appropriate links and login parameters to IBM Cognos 8. There are a few different techniques that you can be used to do this. Using Links-Only to the Welcome page Administrators can embed only the links from the standard Welcome Page into their own custom Welcome page. With this approach, only the links and text of the main section of the Welcome Page will appear, without the extra colors and banners used in the standard Welcome Page. This approach is especially beneficial as it allows you to embed the Welcome Page within a frame of any HTML page while preserving capabilities. To do this: A. Place the following URL within a frame of your HTML page:http://server-name/cognos8/cgibin/cognos.cgi?b_action=xts.run&m=portal/welcome/welcome.xts&basewelcome=yes &wtarget=top

B. Modify the default.css (of your style) to change background colors of the main section of the welcome page..welcomeToolPanel { height:100%; background-color: #ffffff; margin-left:1px; padding-top: 15px; padding-left: 15px; padding-right: 15px; }

C. Once the URL is placed with a frame of an HTML page, the result may

look as follows:

Cognos Proprietary Information

Customizing the IBM Cognos 8 Welcome Page

10

With this approach, all capabilities and permiss