| Note: Samples are functional examples. Many are code samples with narrow requirements and a specific use case, providing you with a baseline. They do not include every possible feature/interactivity or environment/configuration. You can use these samples as-is (supported by IBM), or you can modify/extend these samples to suit your business needs (not supported). IBM will provide support if these assets do not work as described for the product version(s) identified. However, we are unable to provide custom support for you such as adding features or troubleshooting environmental issues. These will be logged in our system as future Feature requests. |
[Updated: Nov 15, 2021]
You can customize the IBM Cognos Analytics interface to suit the needs of your organization. A set of Customization samples are included with the Base Samples. These ZIP files demonstrate how to create themes, extensions, and views (perspectives). You can modify these samples to create your own customizations. For example, you can replace the default home and login views. You can substitute your own theme (colors, logos, and brand text) for the default theming on all views. You can add a button to the Navigation Bar to open a specific dashboard.
Extensions and themes are uploaded to IBM Cognos Analytics via the Manage > Customization panel.
Please Note:
- Themes and Extensions are an incremental feature that may change with each product release. The samples included with each release have been verified with that release only and may not support backward or forward compatibility.
- The samples covered in this Blog are included with the Base Samples during a Cognos Analytics install are all fully supported by IBM. There are additional extension samples on the IBM Accelerator Catalog that are not supported and should be considered to be examples only.
List of Extension Samples
After product installation, you can find the Base Sample extension files here: [IBM Cognos Analytics installation directory]/samples/extensions
The following existing sample extensions were modified to take advantage of the new 11.2 user interface, specifically the new Open Menu (AKA “hamburger” menu):
- LearnPanelLink.zip Adds an extension to the Custom Widgets panel in Dashboarding and Stories that allows authors to add buttons that open specific topics in the Learn Pane.
- LinkWidget.zip Adds an extension to the Custom Widgets panel in Dashboarding and Stories that allows authors to add buttons that open specific URLs.
- SampleExtensionOpenDashboard_11_2.zip Adds a menu item to the hamburger menu to open a dashboard in all perspectives.
- SampleExtensionOpenFolder_11_2.zip Adds a menu item to the hamburger menu to open a folder in all perspectives.
- SampleExtensionOpenReport_11_2.zip Adds a menu item to the hamburger menu to open a report in all perspectives.
- SampleExtensionOpenWebsite_11_2.zip Adds a menu item to the hamburger menu to open a website in all perspectives.
- SampleExtensionOpenPerspective_11_2.zip Creates a new view called "Sample view" and then adds a hamburger menu item to open it from all perspectives.
- SampleExtensionMenuQuicklinks_11_2.zip Adds a menu to the application bar (across top of screen). Common reports and dashboards are accessed directly from this menu.
- SampleExtensionMenuUrlLinks_11_2.zip Adds a menu to the AppBar that contains two menu items that open external URLs. The URLs are opened in a separate browser tab.
- SampleExtensionOpenFolderShowHideParent_11_2.zip Shows the use of the skipAncestors option when opening a folder.
- SampleWelcome_11_2.zip Creates a customized view for the Cognos Analytics welcome page for the Sample Outdoors Company example.
- SampleExtensionExcludeDelete_11_2.zip Removes the Delete button from the "home" perspective for all objects in the content pane.
The following existing samples continue to function in 11.2:
- SampleExtensionContextMenuItem.zip An extension that adds a new menu item to the context menu for all report objects. The new menu item launches a controller that displays information about the selected object in a popup window.
- 11.0.7 SampleExtensionCustomMedia.zip An extension that adds seven custom images to the Image Library tab in the Widgets panel in Dashboarding and Stories. JPG and PNG files are supported.
- 11.0.8 SampleExtensionCustomMediaAll.zip This sample extension will add eight custom images to the Image Library tab in the Widgets panel in Dashboarding and Stories. It will also add the eight custom images to the Image Picker dialog in Reporting in the Image Gallery. JPG and PNG files are supported.
- 11.0.5 SampleExtensionCustomShape.zip An extension that adds custom shapes that can be used in dashboards.
- SampleExtensionExcludeNotifications.zip An extension that removes the Notifications button from the “home” perspective.
- 11.0.6 SampleLogin.zip A customized view for the Cognos Analytics sign-in page for the Sample Outdoors Company example. Not available in 11.1.0 and 11.1.1.
- 11.0.7 SampleLoginMultiple.zip A custom Sign In page where the user can choose between two or more authentication types via a dropdown. Please visit this Blog post for more information. Not available in 11.1.0 and 11.1.1.
The following sample extensions are for IBM Cognos Analytics 11.1.7 and below only:
- SampleExtensionButtonDashboard.zip An extension that adds a button to open a dashboard in all perspectives.
- SampleExtensionButtonFolder.zip An extension that adds a button to open a folder in all perspectives.
- SampleExtensionButtonOpenPerspective.zip An extension that creates a new view called “Sample view” and then adds a button to open it from all perspectives. Not available in 11.1.0 and 11.1.1.
- SampleExtensionButtonReport.zip An extension that adds a button to open a report in all perspectives.
- SampleExtensionButtonWebsite.zip An extension that adds a button to open a website in all perspectives.
- SampleExtensionExcludeDelete.zip An extension that removes the Delete button from the “home” perspective.
- 11.1.0 - 11.1.5 SampleExtensionHelpMenu.zip An extension that adds a customized URL to the Help icon menu in the top Application Bar in all perspectives.
- 11.0.6 SampleExtensionMenuQuicklinks.zip An extension that adds a menu to the application bar (across top of screen). Common reports and dashboards are accessed directly from this menu.
- SampleExtensionMenuUrlLinks.zip This sample extension demonstrates how to add a menu to the AppBar that contains two menu items that open external URLs. The URLs are opened in a separate browser tab.
- SampleExtensionOpenFolderShowHideParent.zip An extension that shows the use of the skipAncestors option when opening a folder.
- SampleExtensionsAll.zip An extension that combines all of the following extensions into one:
- SampleExtensionExcludeNotifications.zip
- SampleExtensionExcludeDelete.zip
- SampleExtensionButtonWebsite.zip
- SampleExtensionButtonReport.zip
- SampleExtensionButtonDashboard.zip
- SampleExtensionButtonFolder.zip
- SampleExtensionMenuQuicklinks.zip
- SampleExtensionContextMenuItem.zip
- 11.0.5 SampleExtensionTabs.zip An extension that adds a collection of tabs to the home view that provide quick access to certain reports and dashboards.
- SampleWelcome.zip A customized view for the Cognos Analytics welcome page for the Sample Outdoors Company example. themes sub-folder. Not available in 11.1.0 and 11.1.1.
A Note about Images
Many of the sample extensions use images (e.g. SampleExtensionOpenDashboard_11_2.zip). If you do not see an image (and you are expecting one) after you upload an extension, please read this Online Help topic.
The sample extensions are designed to work with the default theme, IBM Carbon X, which has a dark background. However, if you apply a theme with a light background, these icons may become indiscernible against it.
List of Theme Samples
After product installation, you can find the Base Sample theme files here: [IBM Cognos Analytics installation directory]/samples/themes
The following existing sample themes were modified to take advantage of the new 11.2.0 user interface:
- SampleTheme_11_2.zip A theme that modifies the branding and color scheme for the Cognos Analytics user interface, optimized for the Sample Outdoors Company example.
- SampleThemeBlueGreen_11_2.zip A theme that modifies the color scheme for the Cognos Analytics user interface using a blue-green palette.
- SampleThemeDarkBlue_11_2.zip A theme that modifies the color scheme for the Cognos Analytics user interface using a dark blue palette.
- SampleThemeLight_11_2.zip A theme that modifies the color scheme for the Cognos Analytics user interface using a light palette.
The following sample themes are for IBM Cognos Analytics 11.0.4 - 11.1.7 only:
- SampleTheme.zip A theme that modifies the branding and color scheme for the Cognos Analytics user interface, optimized for the Sample Outdoors Company example.
- SampleThemeBlueGreen.zip A theme that modifies the color scheme for the Cognos Analytics user interface using a blue-green palette.
- SampleThemeDarkBlue.zip A theme that modifies the color scheme for the Cognos Analytics user interface using a dark blue palette.
- SampleThemeLight.zip A theme that modifies the color scheme for the Cognos Analytics user interface using a light palette.
Related posts:
Please visit our IBM Cognos Analytics playlist on YouTube.
Tags:
#11.0.5
#11.0.6
#11.0.7
#11.0.8
#CognosAnalytics
#CognosAnalyticswithWatson
#extensions
#home
#LearnCognosAnalytics
#Notebook
#samples
#themes