Cognos® TM1 Web URL API overview

The URL API provides a framework for creating URLs that display Cognos TM1® Web Websheet and CubeViewer objects in your own custom web pages.

You can use the URL API to include Websheet and CubeViewer objects in any HTML-based solution such as web pages, web applications, and dashboards. The URL API provides access to Websheet and CubeViewer objects by using a special set of URLs and parameters.

Development tools

To create a solution with the URL API, you need knowledge of HTML and an optional knowledge of JavaScript.

For testing purposes and simple examples, you can use the URL API right in the address bar of a web browser. To create a solution with the URL API, you can use a simple text editor or any development environment that works with HTML and JavaScript.

The URL API uses HTML inline frames (<iframe> tag) as the primary way to display CubeViewer and Websheet objects in your custom web pages.

Features

You can assemble URLs that provide the following capabilities in your custom web pages:
  • Websheet and CubeViewer
    • Access and display CubeViewer and Websheet objects
    • Set title dimension elements
    • Control properties such as turning the toolbar on or off
  • CubeViewer
    • Display in either grid, chart, or grid and chart mode
    • Change chart type
    • Enable/disable auto-recalculation
    • Save the layout of a cube view
    • Recalculate the view
  • Websheet
    • Rebuild Active Forms
Parent topic: Cognos TM1 Web URL API