Beruflich Dokumente
Kultur Dokumente
Copyright
Your use of this document is subject to the Terms of Use governing the
Cognos software products and related services which you have licensed or
purchased from Cognos. The information contained in this document is
proprietary information of Cognos Incorporated and/or its licensors and is
protected under copyright and other applicable laws. You may use the
information and methodologies described in this document 'as is' or you may
modify them, however Cognos will not be responsible for any deficiencies or
errors that result from modifications which you make. Copyright 2006 (c)
Cognos Incorporated. All Rights Reserved.
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
providing internal training on, operating, and maintaining the Cognos
software.
This document is maintained by the Best Practices, Product and Technology
team. You can send comments, suggestions, and additions to Best Practices,
Product and Technologies.
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 3
Cognos Connection
Contents
1 INTRODUCTION............................................................................................................................. 4
2 COGNOS CONNECTION.................................................................................................................. 4
3 USING THE SYSTEM.XML FILE ......................................................................................................4
4 HOW TO REMOVE A CUSTOM SECTION IN COGNOS CONNECTION FOR ALL USERS................... 5
5 HOW TO REMOVE A CUSTOM SECTION IN COGNOS CONNECTION FOR SPECIFIC USERS,
GROUPS, AND ROLES ................................................................................................................................... 5
6 ADDING A NEW SECTION IN COGNOS CONNECTION .................................................................. 7
7 HOW TO REMOVE A CUSTOM SECTION IN COGNOS CONNECTION USING URLS........................ 8
8 APPENDIX A ................................................................................................................................... 9
8.1 LIST OF SECTION THAT CAN BE HIDDEN ........................................................................................................ 9
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 4
Cognos Connection
1 Introduction
This document describes how administrators can add and hide specific sections
within the Cognos Connection UI. Using the system.xml file, parameters can be
added to add or remove UI components for all users or for specific users, groups,
and roles.
2 Cognos Connection
Cognos Connection provides some easy and quick ways to add custom sections and
to remove particular areas in the UI. Removing sections is especially popular – as it
allows administrators to simplify the end user interface. For example, in the
screenshot below, specific sections in the headers were removed providing this much
simpler UI for consumers.
The functionality does not end here. A fine level of granularity is available – allowing
administrators to removing specific links and buttons and replacing them with their
links. Finally, an administrator can assign these custom sections to particular users,
groups, and roles.
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 5
Cognos Connection
add and remove sections of the UI using this file. The system.xml file is located in
the <install-dir>/c8/templates/ps/portal directory.
In addition to removing this header, suppose that want to remove all headers,
except the portal tabs and the main logo header.
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 6
Cognos Connection
A pop-up window will appear with an ID. The object ID will appear in this window.
In the screenshot below, the ID for this group is: xOkNvbnN1bWVycw_.
Within a system.xml file, define this group. For example, the following syntax shows
how I can define multiple groups within this file:
<param name="ui_groups">
<group id="g1">xOkNvbnN1bWVycw_</group>
<group id="g2">xOm5ldyBncm91cHM6dWlfUjI_</group>
<group id="55">xOf5ldyBnc4htcHM6dAlfUjI_</group>
</param>
Note: If you are using one of the following five groups, you do not need to create a
new group.
User Description ID
Anonymous Users who can access Cognos 8 without being prompted Anonymous
for authentication
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 7
Cognos Connection
Query Studio Users who have the Query Studio capability QSUsers
Users
Report Studio Users who have the Report Studio capability RSUsers
Users
Within the same section of the system.xml file, add the following parameters:
<param name="ui_hide">
<RV_TOOLBAR_BUTTONS_XLS show="Administrators g1 g2
RSUsers"/>
<RV_TOOLBAR_BUTTONS_CSV show="Administrators g1 g2
RSUsers"/>
<RV_TOOLBAR_BUTTONS_XLS show="Administrators g1 g2 RSUsers"/>
<RV_TOOLBAR_BUTTONS_CSV show="Administrators g1 g2 RSUsers"/>
<RV_TOOLBAR_BUTTONS_XLWA show="Administrators g1 g2 RSUsers"/>
<RV_TOOLBAR_BUTTONS_singleXLS show="Administrators g1 g2 RSUsers"/>
</param>
Where the “show = “ are exceptions. More specifically, the users and groups listed
above are those users that will see these options. This means that Administrators,
g1, g2, and RSUsers will see these options, but all other users will not see these
options.
To add a custom section to the top right header, add the following parameter:
<param name="ui_add">
<CRN_HEADER_OPTIONS>
<item>
<url>http://www.google.com</url>
<target>_blank</target>
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 8
Cognos Connection
<label xml:lang="en">Google</label>
<tooltip xml:lang="en">Google</tooltip>
<icon>action_search.gif</icon>
</item>
</CRN_HEADER_OPTIONS>
</param>
Where CRN_HEADER_OPTIONS is the section where this custom link will appear.
Additionally, tooltips, language specific links, and buttons can be added in addition to
the links.
h1 t m1
h2 t m2
h3 t m3
h4 t m4
Notes:
This only applies within Cognos Connection or Cognos Viewer.
A header contains both a title and a menu. For example, &ui=h1 will perform the
same actions as &ui=t1m1.
When viewing a report, to remove all headers and toolbars, simply append this
parameter to the end of the URL:
http://server-name/Cognos8/cgi-
bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.tool=CognosViewer&ui.acti
on=run&ui.object=/content/package[@name='GO Sales and
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 9
Cognos Connection
8 Appendix A
8.1 List of Section That Can be Hidden
User Interface Element Description
<CRN_HEADER/> The Cognos Connection
top header (h1)
<CRN_HEADER_TITLE/> Left-hand side of the
Cognos Connection top
header (h1)
<CRN_HEADER_OPTIONS/> Right-hand side of the
Cognos Connection top
header (h1)
<CRN_HEADER_OPTIONS_rs/> Report Studio link
<CRN_HEADER_OPTIONS_qs/> Query Studio link
<CRN_HEADER_OPTIONS_mm/> Metric Studio link
<CRN_HEADER_OPTIONS_ags/> Event Studio link
<CRN_HEADER_OPTIONS_ps/> Analysis Studio link
<CRN_HEADER_OPTIONS_cc/> Cognos Connection link
(Cognos Viewer only)
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 10
Cognos Connection
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 11
Cognos Connection
New Connection
<CC_TOOLBAR_BUTTONS_newdataSourceConnection/>
Configuration folder
<CC_TOOLBAR_BUTTONS_configuration_properties/> properties
<CC_TOOLBAR_BUTTONS_order/> Order
<CC_TOOLBAR_BUTTONS_enable_schedule/> Enable Schedule
<CC_TOOLBAR_BUTTONS_disable_schedule/> Disable Schedule
<CC_TOOLBAR_BUTTONS_view_events/> View Events
<CC_TOOLBAR_BUTTONS_page_sizes/> Page sizes option in
configuration tool
<CC_TOOLBAR_BUTTONS_search/> Search
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 12
Cognos Connection
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.
How to Add and Hide UI Elements in 13
Cognos Connection
Copyright © 2008 Cognos ULC (formerly Cognos Incorporated), an IBM Company. All rights reserved.