Blog

What's happening? What's new? What can I do? Find answers to these questions in the blog.

Archive Results

Blog

IBM #Cognos Analytics 11 JavaScript: What is the difference between a Custom Control and a Page Module?

A scriptable interface is available in IBM Cognos Analytics 11 for many objects in the report output. Reports can be scripted using two types of RequireJS AMD modules: A module that implements the CustomControl Module Interface A module that implements the Page Module Interface When to use a Custom Control To provide your own user interface for: a prompt-like control that reads and sets parameters page navigation buttons (Next, Finish, etc.) authored data such as a list or visualization When to use a Page Module To set the initial state of prompt controls To set prompt control custom validation functions To read current selections from a prompt control (possibly to store) before going to the next page Code (using HTML Item) from a previous release that was executed globally on the page will likely move into the "load" method When to use an HTML Item To insert static HTML into the output To insert static CSS into the output For more information, please view the online documentation. Custom Control Example In the sample named App Bar, we demonstrate how to use a Custom Control: Page Module Example In the sample named Validate Type-In Product Line Code, we demonstrate how to use a Page Module: The instructions for installing and configuring the JavaScript samples can be found at the bottom of this Blog post. Related posts: Scriptable Reports JavaScript Online Documentation Video: Cognos 10 JavaScript Prompt API samples in IBM Cognos Analytics 11 Blog: Cognos 10 JavaScript Prompt API samples in IBM Cognos Analytics 11 JavaScript support in the Interactive Viewer Video: Overview: Scriptable reports (11.0.4+) How to use a custom control with JavaScript to hide and show a filter panel in IBM #Cognos Analytics 11.0.7+ IBM Knowledge Center: Prompt API for IBM Cognos BI IBM Knowledge Center: Adding JavaScript to a report Library of How-To Videos for IBM Cognos Analytics Samples Landing Page Guide to IBM Cognos Analytics sample data sets Please visit our IBM Cognos Analytics channel on YouTube.

Blog

How to use a custom control with JavaScript to hide and show a filter panel in IBM #Cognos Analytics 11.0.7+

Filters (prompts) tend to take up a lot of valuable space on a report. It is often useful to provide users with the ability to hide and show these filters in a panel. There is a new sample in IBM Cognos Analytics 11.0.7 titled Global sales that demonstrates how to use a Block, a Custom Control, and JavaScript to hide and show a panel of filters (Year and Product Line) at the top of the report: Here is a document that explains step-by-step how we created the sample report. Samples There is a set of samples for Scriptable Reports. These sample files are installed (but not configured or imported) with the product in an Easy installation, and are an option in a Custom installation. You can find them here: <Cognos installation directory>\samples\JavaScript\ For your convenience, you can also obtain the samples here. Download the following three files: 1. Follow these setup instructions. If you are using a Gateway, please read Step 6 carefully! 2. Unzip and place these javascript files. 3. Import this report deployment. Related posts: JavaScript support in Interactive Viewer Video: Overview: Scriptable reports (11.0.4+) New Base Samples for IBM Cognos Analytics 11.0.7 Please visit our IBM Business Analytics Support channel on YouTube.

Blog

New sample Extensions for IBM #Cognos Analytics 11.0.7

There are two new sample Extensions for IBM Cognos Analytics 11.0.7. These sample files are installed with the product in an Easy Installation, and are an option in a Custom Installation. After product installation, you can find them here: <cognos_analytics_installation_location>/samples/extensions/ 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. SampleExtensionCustomMedia.zip An extension that adds seven custom images to the Image Library tab in the Widgets panel in Dashboarding and Stories. Only JPG and PNG files are supported at this time. Please note: Themes and Extensions are an incremental feature that changes 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. Related posts: New Base Samples for IBM #Cognos Analytics 11.0.7 Cognos Analytics Customization: Sign In Pages (11.0.6+) Video: How to create Themes and Extensions (11.0.4+) Customization samples (themes and extensions) in 11.0.4 Customizing IBM Cognos Analytics (11.0.4) IBM Knowledge Center: Customizing Cognos Analytics Please visit our IBM Business Analytics Support channel on YouTube.

Blog

IBM #Cognos Analytics Customization: Sign In Pages (11.0.6+)

The sample files SampleLogin.zip and SampleLoginMultiple.zip are examples of views that replace the product’s default sign in page with an alternate customized version. Downloads: SampleLogin.zip SampleLoginMultiple.zip SampleLogin.zip is coded to a single authentication type: SampleLoginMultiple.zip is coded so that the user can choose between two or more authentication types via a dropdown: Caution: These are samples with authentication placeholders. Do not set these samples as your default Sign In Page until you have configured them to match your installation’s authentication type (you won’t be able to log in!). Here are some easy instructions on how to do this: How to Configure the Authentication in SampleLogin.zip and SampleLoginMultiple.zip (11.0.6+) Icons in the Sample If you unzip the file called SampleLoginMultiple.zip and look in the folder SampleLoginMultiple\login\images\, you will find the images that we use in the sample: namespace.svg username.svg password.svg The images are specified in the file called SampleLoginView.html, which is located in the folder SampleLoginMultiple\login\js\views\. If you change the image filenames by adding your own images, you will need to update this file to point to the new images. The images can be SVG, PNG, JPG, or GIF, and they are 24px by 24px. Here is a video overview on creating, using, and uploading extensions: How to create Themes and Extensions in Cognos Analytics The syntax for the declarative JSON in the sample extensions can be found here. This document shows you how to determine the ID of a user interface object. The set of available pre-built action controllers, as well as instructions for creating custom action controllers, are documented here. Extension and Perspective Names An extension is a container. A perspective declaratively defines a new UI screen/capability in the Cognos user interface. There could be multiple perspectives defined in a single extension. Consequently, our best practice is to ensure that the perspectives have names that are different from the extension’s name: Additionally, our best practice when naming an extension is to use an underscore to separate multiple words. When naming a perspective, do not include any spaces, and capitalize each word after the first word. Positioning and Weights Many of the sample extensions allow you to place objects in specific locations. For example, if you extract SampleExtensionButtonWebsite.zip and open spec.json in a text editor, you will see: The line "containerId": "com.ibm.bi.glass.navbarTrailingGroup", specifies the area of the product to display the extension: This document shows you how to determine the ID of a user interface object. The line "weight": 100, specifies the position of the object within the container. The higher the number, the earlier it appears in the container. For example, here are some of the weights for core objects in the product: Please note: Themes and Extensions are an incremental feature that changes 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. Related posts: Customization Samples Video: How to Create Themes and Extensions Customizing IBM Cognos Analytics 11.0.4 IBM Knowledge Center: Customizing Cognos Analytics Please visit our IBM Business Analytics Support channel on YouTube.

Blog

How to use IBM 10.2.2 #Cognos Mashup Service (CMS) Samples in IBM Cognos Analytics 11

As a developer, you can use the IBM Cognos Mashup Service (CMS) to create applications that use a structured view of IBM Cognos outputs as input. CMS allows you to develop applications that expose IBM Cognos outputs, such as reports and analyses, as Web services (both SOAP and REST). Here are the legacy CMS samples (JavaScript only) from IBM Cognos 10.2.2: cms.zip This document provides guidance on how to use the 10.2.2 Cognos Mashup Service samples with Cognos Analytics 11. IBM Knowledge Center: Mashup Service Developer Guide 10.2.2 Related posts: Supplementary (Legacy) IBM Cognos Analytics 11 Samples How to find/install the Samples (11.0.4) New samples for IBM Cognos Analytics 11.0.5 Please visit our IBM Business Analytics Support channel on YouTube.

Blog

Video: Overview: Scriptable reports (11.0.4+)

Using four examples, this is an overview of how to add JavaScript to your reports in IBM Cognos Analytics 11.0.4 and above. There is a new API that supports and expands the existing Prompt API and more. JavaScript is stored in a file and can be shared across reports. You can download detailed technical documentation that describes the new APIs. Samples There is a new set of samples for Scriptable Reports for 11.0.5. These samples are installed by default in an Easy installation, and are an option in a Custom installation. You can find them here: <Cognos installation directory>\samples\JavaScript\ For your convenience, you can also obtain the samples here. Download the following three files: 1. Follow these setup instructions. If you are using a Gateway, please read Step 6 carefully! 2. Unzip and place these javascript files. 3. Import this report deployment. Related posts: JavaScript support in the Interactive Viewer How to use a custom control with JavaScript to hide and show a filter panel in IBM Cognos Analytics 11.0.7 Please visit our IBM Business Analytics Support channel on YouTube.

Blog

IBM #Cognos #Analytics: Custom visualizations used in the samples

Download: All visualizations used in the samples (.ZIP, 1.8MB) All of the customized visualizations that are used in the sample IBM Cognos Analytics reports, up to and including version 11.0.4, are available here. To use the visualizations, download the file above and unzip it. You will see multiple visualization bundles (.ZIPs) that can be further customized in the Visualization Customizer tool, or imported individually to IBM Cognos Analytics using the Import Visualization toolbar button on the Library tab in IBM Cognos Administration: Related posts: Visualization Customizer tool All visualizations Please visit our IBM Business Analytics Support channel on YouTube.

Blog

Video: How to create Themes and Extensions in #Cognos #Analytics

Customization samples are available that demonstrate how to create themes, extensions, and views (perspectives). You can modify these samples to create your own customizations. This video provides an overview of the process. You can download the presentation slides here. Related posts: Customization: Sign In Pages (11.0.6+) Customizing IBM Cognos Analytics in 11.0.4 Customization samples IBM Knowledge Center: Customizing Cognos Analytics Please visit our IBM Business Analytics Support channel on YouTube.

Blog

Customizing IBM #Cognos Analytics in 11.0.4

Have you ever wanted to do more with the IBM Cognos Analytics User Interface? In the latest release of Cognos Analytics 11.0.4, you can customize the IBM Cognos Analytics interface to suit the needs of your organization. The IBM Cognos Analytics user interface is built on an extensible model. In this model, the user interface screens are defined as views (such as home, authoring, dashboard, and modelling). You can customize these views by adding and removing user interface elements, such as buttons and menus as well as define new views to extend the Cognos Analytics user interface. You can replace the default home and sign-in views. You can substitute your own theme (colors, logos, and brand text) for the default theming on all views. Customizations can be exported/imported as deployments. Customizations are packaged as zip archives that contain a spec.json file that defines the customization. The zip archive may also contain other files (i.e., javascript, css, and image), depending on the type of the customization. For additional information on how to create extensions and themes check this link. You can manage customization through the manage area of the system. This panel allows you to upload your customizations, theme, extensions, welcome and login view to the Cognos Analytics server, and to select which customizations to use. Customization samples are available that demonstrate how to create themes, extensions, and views. You can modify these samples to create your own customizations. These samples are shipped out of the box and when you install IBM Cognos Analytics server, these samples are installed in sub-folders of /samples. For more information on Samples please see Customization Samples Blog. If an uploaded extension or view contains errors, it may render IBM Cognos Analytics unusable. In this case, you can run Cognos Analytics with customized extensions and views disabled. Invoke Cognos Analytics by typing the URL :/bi/?factoryMode=true. Client Logging A client logging facility is been added under preferences to enable logging of javascript code and to understand the javacsript anomalies that are not detectable from server environment. When active and set to an appropriate log level, log statements will be sent to the browser console (either the log, debug or which ever trace you enable) and can be used to debug and see where things go off. For additional information on managing logging levels check this link. Related posts: Customization: Sign In Pages (11.0.6+) Video: How to Create Themes and Extensions Customization samples IBM Knowledge Center: Customizing Cognos Analytics Please visit our IBM Business Analytics Support channel on YouTube.

Blog

Customization samples (themes and extensions) in IBM #Cognos Analytics 11.0.4

Customization samples are available that demonstrate how to create themes, extensions, and views (perspectives). You can modify these samples to create your own customizations. These samples illustrate how to implement commonly used customizations. All of these samples work together to create a customized portal for the fictional Sample Outdoors Company. They are best installed in the following order: When you install the IBM Cognos Analytics server, the customization samples are installed in sub-folders of <cognos installation directory>/samples. The following sample customizations are available. deployment sub-folder Samples_for_Install.zip A deployment archive that contains the sample data, reports, and dashboard used by the Sample Outdoors Company example. extensions sub-folder 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. 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. 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. SampleExtensionExcludeDelete.zip An extension that removes the Delete button from the “home” perspective. SampleExtensionExcludeNotifications.zip An extension that removes the Notifications button from the “home” perspective. 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. 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 SampleLogin.zip A customized view for the Cognos Analytics sign-in page for the Sample Outdoors Company example. SampleWelcome.zip A customized view for the Cognos Analytics welcome page for the Sample Outdoors Company example. themes sub-folder theme sub-folder 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: Customization: Sign In Pages (11.0.6+) Video: How to Create Themes and Extensions Customizing IBM Cognos Analytics 11.0.4 IBM Knowledge Center: Customizing Cognos Analytics Samples landing page Please visit our IBM Business Analytics Support channel on YouTube.