Cognos Analytics

Cognos Analytics

Connect, learn, and share with thousands of IBM Cognos Analytics users! 

 View Only

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

By Samples Team posted Tue May 08, 2018 11:27 AM

  

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:


Please visit our IBM Cognos Analytics channel on YouTube.


Tags:
#Cognos Analytics
#Documentation
#samples
#Resources
#Scriptable report
#JavaScript
#reporting
#advanced



#2019 Year in Review


#Administration
#authoring
#classicviewer
#CognosAnalyticswithWatson
#home
#LearnCognosAnalytics
0 comments
59 views

Permalink

https://community.ibm.com/community/user/blogs/steven-macko/2018/05/08/ibm-cognos-analytics-11-javascript-what-is-the-difference-between-a-custom-control-and-a-page-module