Synchronizing SUBNM and URL

This article describes how to make the SUBNM component to sync with the URL whenever it changes. This will also describe how the SUBNM's initialization works.

The problem

Let's take the following page which has one SUBNM, every time the SUBNM is updated, the URL is updated as well.

One common issue that you might have, is when you print the report in PDF, instead of showing the current value (England), the value in the SUBNM always shows the default value (Total Europe).

To understand why, when you refresh the page or when you print the page, the value displayed in the SUBNM is always the default value, we will go through the code of of the HTML page.

Define the default value

In the controller there are two variables:

  • defaults.region: the default value is set to 1 (Total Europe).
  • selections.region: The variable which is going to be updated from the SUBNM.
    $scope.defaults = {
        region: '1'

    $scope.selections = {
        region: $scope.defaults.region


In the HTML page, we have a basic SUBNM driven by the Default subset of the Region dimension.

  • tm1-default-element enables us to set the default value of the SUBNM to the selections.region.
  • ng-model is used to store the value chosen by the SUBNM in the variable selections.region.
  • tm1-change is used to trigger an action each time the SUBNM value is updated. Every time the value of the SUBNM is updated, the function setRegion is triggered.

The function setRegion is defined in the controller. This function updates the selections.region variable and update the URL:

$scope.setRegion = function(region){
  $scope.selections.region = region;
  if(region != $scope.defaults.region){
    // Set the URL parameter
    $"region", region);
   else {
     // If the parameter equals the default value remove it from the URL
     $"region", null);

We use to get the value from the URL. If there is a value in the URL, when you refresh the page, the selections.region will be set to this value:

        $scope.selections.region = $;

SUBNM Deep Dive:

When you refresh the page, the SUBNM initializes following these two steps:

Step 1: The SUBNM retrieves the elements from the subset.

Step 2: It initializes the ng-model (ng-model="selections.region"). It means that it initializes the selections.region variable with the first element in the subset (Total Europe).

Even if the selections.region value was defined in the controller, this value is overwritten by the SUBNM.

Step 3: The SUBNM checks the value defined in tm1-default-element attribute, selections.region. At this stage the selections.region is currently equal to Total Europe.

Each time you refresh the page the selections.region variable is set back to Total Europe (the first element in the subset).

That is why the variable used for the tm1-default-element and the ng-model has to be different.

The solution:

To do that, replace the selections.region with a new variable values.urlRegion:

  • tm1-default-element="{{values.urlRegion}}"


This new variable will be used only to update the URL and set the SUBNM default value.

In the controller, the URL is now driven by this new variable values.urlRegion:

    $scope.values = {
        urlRegion: $scope.defaults.region,
        $scope.values.urlRegion = $;
    $scope.setRegion = function(region){
        $scope.values.urlRegion = region;
        if(region != $scope.defaults.region){
            // Set the URL parameter
            $"region", region);
        else {
            // If the parameter equals the default value remove it from the URL
            $"region", null);

Now when you print the report or if you refresh the page, the SUBNM value will match the URL value:

Repeat more than one row in your table

This article describes how to repeat two rows for one item using the angular directive, ng-repeat-start:

The easiest way to create a table in Canvas is to use the angular directive ng-repeat. In a table, ng-repeat is going to repeat one row or one column per items. If you do not have lots of space in your dashboard showing too much information in one row might look a bit too squashed:

To make some room in your table, instead of showing everything in one row, you could create two rows per product, one with the alias and a second row with the year and months values:

Create one row using ng-repeat

Instead of using ng-repeat="product in lists.products" which creates one row for each product with:

  • One column for Product description.
  • One column for Year value.
  • One column per months.
<tr ng-repeat="product in lists.products" ng-hide="selections.zeroSuppress && product.yearTotal=='0'">
    <td style="font-weight:bold">
    <td ng-repeat="period in lists.periods">

We are going to use the Angular directives ng-repeat-start and ng-repeat-end. This is how our HTML structure will look like:

<tr ng-repeat-start="product in lists.products">
<tr ng-repeat-end>


The ng-repeat-start directive works the same as ng-repeat, but will repeat all the HTML code (including the tag it's defined on) up to and including the ending HTML tag where ng-repeat-end is placed.

In our example we use ng-repeat-start to create a first row with the product description and a small chart.

We actually created only one data column <td>, and we made this column the same size as the 13 columns of our table by using a <td> attribute, colspan="13"

<tr ng-repeat-start="product in lists.products" ng-hide="selections.zeroSuppress && product.yearTotal=='0'">
    <td class="padding-left" colspan="13" style="background-color:#E5E5E5">
        <div class="pull-right" style="width:15%">
                tm1-data-decimal="0" tm1-hide-controls="true" tm1-height="20" tm1-margin="{top:2,bottom:2,left:2, right:2}"
                tm1-legend="none" tm1-color-scheme='["#05668D", "#028090" ,"#00A896"]' tm1-axis-label-y=""
                tm1-state="{{product.yearTotal}}" tm1-axis-label-x="">
                    ng-repeat="month2 in lists.periods" tm1-label="{{month2.alias}}" 
                    tm1-instance="dev" tm1-cube="Retail" 
        <div style="width:85%;font-weight:bold"> 

Even if {{product["Description"]}} is on the left of the chart, it is good practice to put the chart first, because the chart determine the height of that section. We use the Bootstrap class pull-right to push the chart to the right:


Now, we use ng-repeat-end to create the second row which shows the Year and the months values:

<tr ng-repeat-end ng-hide="selections.zeroSuppress && product.yearTotal=='0'" style="border-top:none!important;border-bottom:none!important">
    <td style="font-weight:bold">
    <td ng-repeat="period in lists.periods">

This is how your table will look like:

You can use the Angular directive ng-repeat-start with any HTML components, more information can be found in the AngularJS website.

Customize PDF export layout with CSS and Bootstrap

One of the great feature of Canvas is that the style of your dashboard can be different regardless of viewing it in a web browser or as PDF format.

For instance, your dashboard could have a grey background in the browser but when you print it, the background could change to white and the buttons could be replace with text:

You can achieve this outcome with just a few lines of CSS and one bootstrap class.

Update background when printing

Inside the internal style sheet (<style> </style>), first define the grey background (#EAEAEA) of the page (page-view) and then to change the background when printing you need to define a new page-view background color inside the @media print CSS query:

        #page-view {
            background-color: #EAEAEA;

        @media print {
            #page-view {
                background-color: #FFF;

All CSS defined inside the @media print CSS query will be applied only when the dashboard will be printed into PDF.

Replace buttons

To replace the buttons with their values, we need first to hide the buttons using CSS and then we use a Bootstrap class to show the filters value only when printing.

To hide buttons when printing, you just need to add the following code inside the @media print CSS class:

.btn {
      display: none;

Note that the above code will hide all buttons in the page.

If you want to hide only a specific button, you will need to add an id to the HTML component so you can specify that out later. Take for instance a filter:

<div  id="filter" >

Now we then add the CSS code to @media print query:

#filter {

CSS Selectors:

Take a note also that we now use '#' instead of '.' in front of the id, we have just created. There should be lot of articles discussing CSS Selectors. To help on this article, just remember:

  • '.' means selecting all HTML elements with that CSS class. 
  • '#' means selecting all HTML elements with that ID.  

For those other sections that you only want to show during printing, you can use the visible-print-block Bootstrap class. For example, if we want to show the values of the filters on the section we have hidden previously, we can create another section and add the class there:

<div class="col-md-6 visible-print-block"> 
    <h3> Filters: {{selections.version}} - {{selections.month}} {{selections.year}} - {{selections.region}} - {{selections.category}}

All HTML element inside the visible-print-block div will be shown only when report will be printed into PDF.

To learn more about how to customize your report depending on screen size or devices, you should check CSS Media Queries page on the w3school website.

Configuring SheetJS (Optional Library)

Beginning with Canvas version 1.2.2, optional libraries will be included within assets folder but will need to be enabled before it can be used. This will involve:

  • Adding the link to the JS/CSS file in the header
  • Pushing the Angular module of the library into your application

Enable SheetJS

SheetJS a library that helps working with spreadsheets on the web! Check their website for more info. 

To enable the functionality in Canvas, do the following steps:

    1. Update WEB-INF/pages/header.library.ftl file with the following:

<script src="assets/js/optional/libs.opt.sheetjs.js"></script>

    2. Update WEB-INF/pages/header.script.init.ftl file by adding below line of code:


It is now enabled!

Create upload button

To check it out, create a simple Canvas Blank page with the following HTML line of code:

<js-xls onread="read" onerror="error"></js-xls>

And on the page's corresponding controller:

$ = function (workbook) {
      /* DO SOMETHING WITH workbook HERE */
$scope.error = function (e) {

You should be able to see on your HTML page, something similar to:

Clicking the "Choose File", will open up a Windows dialog to select an Excel file example to load. You will get the following response in the console showing the contents of the file:

That is it!

Which files are overwritten during a Canvas upgrade

During a Canvas upgrade, the installer can upgrade either the Cubewise Application Server or the application folders (webapps) or both. That is why you have to be careful about which files you can and can't be changed to allow upgrades to work smoothly.

In this article we use the following color coding:

  • red: all files should not be manually modified.
  • yellow: some files can be manually modified.
  • blue: all files can be manually modified.


  • backups: contains all application folders backups created during an upgrade.
  • conf: you can update the server.xml file to update the Canvas port number.
  • webapps: contains all Canvas applications.


    In the Conf folder the only file you should update is the server.xml file where you can update the Cubewise Application Server's port number. But do note that this will be overwritten if the option "Install Canvas Application Server" is selected. So migrate your settings after upgrade.

    In the Conf folder you will find the license file (Canvas.xml).



    In the webapps folder, the files inside samples folder are overwritten during an upgrade when the "samples" application is checked.



    An application folder

    • css: global format settings of the application.
    • html: all HTML pages.
    • images: all images.
    • js: all controllers.
    • menu: left pane menu structure.
    • WEB-INF: configuration.






    You can create as many HTML pages as you want. We recommend to use the Page Creator to create a new page.


    In the JS folder you will find all controllers, you can add as many controllers but just do not touch the admin and system folders.


    You can update manually the menu.json and the states.json file but you need to be aware that these files can be updated from the user menu management page in the admin section.


    • config: security settings such as updating admin password.
    • pages: index.ftl file, check the following article.
    • resources: Define all MDX queries.
    • instances.json: TM1 connection settings

    License file

    The Canvas application server will not work without a license file. To get a license file, you need to send the server name to your Cubewise local office. You need one license file per server.

    1. Once you have received the license file (Canvas.xml), put it in the CWAS\Conf:

    2. Then restart the Cubewise Application Server.

    3. Clear the cache (SHIFT + F5) and then refresh your browser, the "invalid license" message should have disappeared.

    If the message is still there, you can first check if the server name is correct in the license file. To see if the license has not expired, you can check the expiration date:

    Page break in PDF report

    When printing a report using Canvas, you can customize as much as you like the PDF output. There are lots of CSS properties that you can use such as CSS Media Queries to update for instance the background color of the PDF. The PDF can be very different from the HTML page.

    One thing to be careful about when you print your page is the page break. To avoid a table or a chart to be divided between two pages, you can define in your HTML page where you want the page break to appear.

    If you do not specify any page break in the HTML page when printing, your report can break anywhere:

    This article describes how the page break works in the sample print:

    • http://localhost:8080/samples/#/sample/print

    Create a CSS class

    At the top of the page, first you need to create a new CSS class. In the example below we create a new class called other-pages with the property page-break-before:always:

            page-break-before: always;

    page-break-before always insert a page break before an HTML element it is assigned to. There are other CSS properties that you can use such as page-break-after which insert a page break after an HTML element it is assigned to.

    Add the CSS class to an HTML element

    In the print example, we assigned the new CSS class to a div but you can add this class to any HTML element where you want the page break to happen:

    <div class="row other-pages"  >

    This div has now the CSS property to always break the page before, if you print the page you will see the page break just before the chart:

    To add a third page to your report you just need to add a new div with the other-pages property:

    <div class="row other-pages"  >
            Add a third page

    It is important to notice that the page break will appear only in the PDF, in the HTML page, it will be like a normal div:

    After printing you will see a new page:

    Override the default number format

    Canvas includes the accounting.js library. With accounting.js you can do advance formatting for number, money and currency.

    The default number format is:

    • Thousands separator: ","
    • Decimal separator: "."

    There are two ways to update the default format.

    1. Override the format for the all application

    The default number format is defined by applications. To update the default format for the all application, you need to update the client.startup.js:

    • C:\CWAS\webapps\<application name>\js\client.startup.js

    For example to show "." as thousands separator and "," as decimals, you will need to add the following lines:

        accounting.settings.currency.thousand = '.';
        accounting.settings.currency.decimal = ',';

    It is going to update the format for all numbers:

    2. Override the format for a specific DBR

    To override the format for a specific DBR, you need to add to the DBR the attribute tm1-accounting-settings-override. For example to show a "," as thousands, "." as decimal and a precision of 2, you need to add:

    • tm1-accounting-settings-override="{currency:{thousand:',',decimal:'.',precision:'2'}} "

    Save the file and refresh the page, now you should see the DBR with the new format:

    The attribute tm1-accounting-settings-override overrides the attribute tm1-data-decimal. For example if you have tm1-data-decimal="2" and  tm1-accounting-settings-override="{currency:{thousand:',',decimal:'.'}} " in the same tm1-ui-dbr:

    It will show a value with no decimal because the default precision of accounting.js is 0. To see a precision of 2 you need to add precision:'2' to tm1-accounting-settings-override:

    Index.ftl structure

    Canvas is a single page application SPA. Each Canvas application has a single web page which swaps and loads its different contents, depending on what the user click. All HTML pages are loaded in the container (blue). A single page (red) is loaded, that is why you see a “#” between the URL and the HTML path:

    The red area is defined by the index.ftl file and the blue area is your HTML page. The index.ftl file is used to update everything that you find in the red area such as logo, headers, menu and homepage.

    Prior v1.2, to update the logo or add a custom library you had to update the index.ftl in the following folder:

    • C:\CWAS\webapps\<application name>\WEB-INF\pages

    We moved the index.ftl to the following new folder:

    • C:\CWAS\webapps\< application name>\WEB-INF\pages\system

    So updating you logo is now done through the navigation.logo.ftl file.

    Important: If you upgrade your existing Canvas application to Canvas v1.2. You will have to migrate all changes you made from your index.ftl (WEB-INF\pages\) into the different new ftl files (WEB-INF\pages\). The index.ftl file which is used by the Canvas application is in \WEB-INF\pages\system.

    We did this in order to split the index.ftl file between the area you can update and the area you should not update. Starting with v1.2, the WEB-INF\pages\system\index.ftl file should not be updated anymore. The area you can update is now separated into different files that you can find in \WEB-INF\pages. The new index.ftl will include these new customizable ftl file during application load.

    There are now 9 ftl files:

    • header.library.ftl: To add links to your custom libraries.
    •  header.script.init.ftl: For configuring your SSO and adding your angular modules.
    • header.script.others.ftl: Configure your accounting.js settings and other initializations.
    •  navigation.body.custom.ftl: Make your own navigation body.
    • navigation.logo.ftl: Update the logo.
    • For adding items into the top left navigation bar.
    • For adding items into the top right navigation bar.
    • page.footer.ftl: Add your custom page footer.
    • page.header.ftl: Add your custom page header.

    The contents of these files get inserted into the index.ftl file when your Canvas application loads. Should you want to know more about the expected content of each FTL file, you can check out the index.ftl file to see where these files will be inserted and what HTML elements are near it.

    Schedule jobs to send PDF reports

    Starting with Canvas v1.2, you can now print your Canvas page into a PDF report and schedule a job to send it by email at a specific day or time. This article describes the steps how to create a job scheduler.

    Set up SMTP configuration

    Canvas allows you to send email alerts, to do this it needs to access an SMTP server. For most corporate networks the SMTP server will accept any email send requests from servers in the same network.

    To update the SMTP configuration go to the setings page in the Admin section, you can find below the settings of an office 365 account:

    For more information about SMTP configurations, you can check the following Help article: Email settings.

    Go to Reports Manager

    To create a job, you have to open Reports Manager.

    • http://localhost:8080/<application name>/admin#/reports-manager

    You will see first the job list, click the + button to create a new job:

    Create a new Job

    First you need to enter the Job details such as Name, Subset, Recipients and the Email Body:

    To add more recipients, just separate their email addresses with ",":

    Schedule the job

    Click on the icon to pop up the Scheduler Helper. There are different options to choose from for scheduling your job such as every month, week, day, etc.:

    Click the Check Schedule button to see the next runs. Finally click Apply Schedule.

    Do not forget to add the name, the name will be shown in the job list.


    Attachments are the URL path to the Canvas pages, Canvas uses the URL to create PDF reports. If you want to send the report with the filter England, you have to make sure that the filter is in the URL, if not it will always print the report with the default filters. To learn how to dynamically update the URL, you can check the following help article : Update the URL before printing.

    Do not forget to add the credentials to login to the TM1 instances (instance name, user name and Password).

    Click the save button to make sure your new job is set up correctly. You can test your job by clicking Execute button:

    If you go back to the job list, you should now see your new job:

    Update the URL before printing a page

    With Canvas v1.2, you can now print and schedule a report. Canvas uses the page URL to print a report in PDF. If you do not update the URL, Canvas will always print the report with the default criteria.

    This article explains how you can update the URL without reloading the page.

    In the "print" dashboard, if you click on one of the KPI at the top, for instance Gross Margin, the URL will be updated:

    The print button in Canvas, uses the current URL to create the PDF report.

    If the URL is not updated, when you click on the print button, Canvas will print the default URL:

    • http://localhost:8080/samples/#/sample/print

    instead of printing the report with Gross Margin:

    • http://localhost:8080/samples/#/sample/print?driver=Gross%20Margin

    To modify the URL without reloading the page, we are going to add a new function in the controller (JS page) and from the HTML page, we are going to call this function.

    1. Create the function in the controller

    $ definition

    To update the URL, we are using the search method of the angular service $location. The $location service parses the URL in the browser address bar and makes the URL available to your application.

    How does it work:

    1. $location makes the URL available to our application
    2. We use search method to update the URL.

    Add $location as a new controller argument

    To be able to use $location service in our controller we have to add it as a new argument in our controller:

    Declare variables

    We need two variables:

    • $scope.defaults.driver: default values to be used before selections are made
    • $ value which will be updated during navigation

    In the example below we have three defaults variables (defaults.region, defaults.department and defaults.driver) and 6 variables that we are going to use in our HTML page (page.region, page.departement, page.version, page.driver, page.segment and page.subset):

    Get a value from the URL

    To get a value from the URL we use the search method: $

    In our example we want to get the driver value so we attach driver to $

    • $

    If the URL is http://localhost:8080/samples/#/sample/print?driver=Operating%20Expenses then $ will be equal to Operating Expenses.

    Initialize the page variable

    If there is a driver value in the URL we initialize the page.driver variable:

            $ = $;

    Send a value to the URL:

    We're going to create a new function called setDriver which will be called from the HTML page. The objective of this function is to update the URL if the driver in the page ( is different from the default driver (defaults.driver):

    $scope.setDriver = function(driver){
            $ = driver;
            if(driver != $scope.defaults.driver){
                // Set the URL parameter
                $"driver", driver);
            else {
                // If the parameter equals the default value remove it from the URL
                $"driver", null);

    2. Update the HTML page

    In the HTML page, we just need to call the setDriver function created in the controller when we click on a button:

    • ng-click="setDriver(item.description)"

    In this example when we click, we send the item.description to the URL.

    Create a new page using Page Creator

    To create a new page, it is recommended to use the Page Creator which you can find in the Admin section. Each Canvas application has its own Admin section. In the following example, our application name is training. You can access the Admin section of the training application via the following URL:

    The default log in is ‘admin’ and leave the password blank, then click the Login button:

    If you forgot the admin password, you can reset it by following these steps.

    You can access the Page Creator via the left pane menu, then click Blank Canvas Page:

    • Page Name: Visualisation
    • Menu Name: Visualisation
    • Menu Icon: fa-bar-chart

    Click the Create button and then go back to the training application:

    Refresh the page (or press F5) and you should be able to see the new page, Visualisation:

    When you click the create button, Canvas will create an HTML page with just the icon and the title defined.

    When you use the Page Creator to create a new page, Canvas creates a new HTML file with the same name in the <application name>\html folder. Canvas generates a basic HTML code, the header with the title and icons you chose (in orange) and an empty row with 3 blocs (in yellow), just to pre-define the structure of the page.

    Note that Canvas will also create a controller (JS file) in the controller folder (js/controllers).

    Query an external database from Canvas

    With Canvas you can display data coming from your TM1 server and also from an external database. An example can be found in the samples:

    • http://localhost:8080/samples/#/sample/sql

    Define ODBC Connection

    For Canvas to access the datasource, you have to first set up the ODBC Connection. Note that if the samples application has been selected during installation, a corresponding ODBC connection should come pre-configured and will be shown as below:

    Define the SQL query

    The SQL query and configuration are created on the server so you only have to pass through parameters from JavaScript. It also adds an important layer of security, it is generally a bad practice to allow SQL or MDX to be created/modified in a user interface as it allows users or third parties the ability to change what is executed. This could include changing a SELECT statement to an INSERT, UPDATE or even a DELETE command.

    To create a new query, you can create a new file based on the <application name>/api/samples/sql.jsp and then replace the SQL settings:

    • In red, this is where you define the connection to the database.
    • In blue, the SQL query.
    • In black, the parameters, one for each “?” in the query.

      query.setString(1, department); represents the first “?” in the SQL query.

    Initialize the data in the controller

    Once the SQL query is set up in the jsp file, the next step is to call the query from the controller and store the result of the query into the $ variable ($ =

    $scope.query = function() {
            $http.get("api/samples/sql.jsp?instance=dev&department=" + $ + "&skip=0&max=" + ${
                $ =;

    If you are using a new query stored in a new file called newsql.jsp, access your SQL query by sending a GET request to the following path: api/samples/newsql.jsp.

    Call the query from HTML page

    Once the $ is defined in the controller, in the HTML page you can display the result of the query by using data variable:

    <tr ng-repeat="item in data">
            <td>{{item.Amount | number}}</td>

    Change the default colors of a chart

    There are 3 different ways to update charts colors in Canvas:

    •      Update the default application color scheme.
    •      Define the color scheme in the chart property.
    •      Define the color of a specific chart element.

    Update the default application colour scheme

    In Canvas, when you create a chart, if you do not specify any colors, the chart will take the default application colors. These default colors are defined in the instances.json file in the WEB-INF folder of your application:

    Colours are defined in CSS colour format. You can find lots of colour supported by all browser in w3schools website:

    You can get more colours by clicking on the Shades button:

    Let’s update the instances.json file with the following colours:

     "chartColorScheme"=["#0000ff", "#3333ff", "#6666ff", "#9999ff", "#b3b3ff"]

    For Canvas to pick up the changes in the instances.json file, you have to restart the Cubewise Application Server. Then refresh your page and you should see the new colours:

     Define the colour scheme in the chart property.

    You can override the application default scheme by adding the tm1-color-scheme attribute to the tm1-ui-chart:

    tm1-color-scheme='["#009900", "#00b300", "#00cc00", "#00e600", "#00ff00"]':

    Save the page and refresh your web browser, you should now see new colours:

    Define the colour of a specific chart element

    You can override the chart colour scheme for a specific bar by adding the tm1-color attribute to the tm1-ui-chart-dbr:

     tm1-color ="#000000”

    Let’s add this attribute to the first bar:

    Save and refresh your page, you should now see the first bar with a black colour:

    Debug a Canvas page (Controllers and Debugger)

    Each browser has each of its own debugging tools to help you troubleshoot your web application. And each tool gives you different views and helpful information about your HTML page. 
    On this article, we will be using Chrome as the browser and how we can debug by enabling breakpoints.

    To debug a web page, there are 2 steps that you will need to do beforehand. First you need to mark a stop in your code where you want the browser to stop when its refreshing the page. Then, once the browser stopped, you can start debugging by going through your code step by step.

    Set up the debug point

    Inside the JavaScript codes

    Note that the Developer Console (press F12) must be open before proceeding. Here are the two common ways that you can do to enter debugging mode:

    var i = 0;
    // other logics here...
    debugger; // pause here

    Adding this line of code into your JavaScript will tell Chrome to halt execution up to this point. 

    Inside the browser:

    A second way is: on the Sources tab, navigate to the JS file that you wanted to debug. The contents of this file will be shown on the right which should also show the line numbers for each code. Clicking on the line number for which you want to halt execution will enable/disable breakpoint.

    Start debugging

    Now that you have setup your debug points, it is time to start examining!
    Let us say, we have a page debug.html, with the following SUBNM where we would like to do something when the value of the SUBNM changes (tm1-change="page.onSubNmChange(page.year)"):


    and a controller debug.js with the following code:

    $ = {};
    $ = function(data){
      for(var i = 1; i < 10; i++){
        console.debug('i: %o', i);  
      console.debug('onSubNmChange %o', data);

    As you can see, there is a line of code containing 'debugger;'. Once you reload the page, your console should look like this:

    Notice the debugger was highlighted in blue. We are now in debug mode!

    On debug mode, there a few more buttons now available that can help you. Hovering the mouse pointer over them will give you the keyboard shortcuts to trigger them.

    For simplicity purposes, we will just focus on two functions: F8 and F10. You will see these on the main browser screen too.

    Pressing F8 means it will continue on until the next breakpoint or debugger; line. Whereas pressing F10 means, "execute this line of code, and go to the next".  Since we are in debug mode already, do explore the Sources tab and hover over some variables. Think of this as a way of examining processed variables at certain point of execution! And this is how it can look like as you hover (I hovered over the variable i, to see what is the current value):

    Pressing F10 and examining the variables along the way will give you an idea on what and how it is currently working. This should also help you trace through your various functions, especially if you are calling a function within a function!

    Create a table from a MDX statements

    MDX is a powerful query language similar in structure of standard SQL. Where it differs is it ability to deal with multidimensional data as opposed to the flat structure of a table in a relational database.

    Canvas has many helpful components that enable you to avoid the complexity of writing MDX statements but if you want to dive deeper into the internals of TM1 you can still do this via Named MDX statements.

    Named MDX statements are created on the server so you only have to pass through parameters from JavaScript. It also adds an important layer of security, it is generally bad practice to allow SQL or MDX to be created/modified in a user interface as it allows users or third parties the ability to change what is executed. This could include changing a SELECT statement to an UPDATE or DELETE command.

    Named MDX statement structure

    Named MDX statements are stored in a JSON file on your Canvas server. The file is located at:

    • <Canvas Install Location>\<Application>\WEB-INF\resources\mdx_named.json
    • Example: C:\CWAS\webapps\ROOT\WEB-INF\resources\mdx_named.json

    The file contains an array of named mdx statements in JSON format:

        "id": "P&L",
        "mdx": [
          "SELECT NON EMPTY {[Period].[Oct], [Period].[Oct YTD], [Period].[Year]} * {[Version].[Actual], [Version].[Budget]} ON COLUMNS,",
          "NON EMPTY {[Account].AllMembers} * {[Department].AllMembers} ON ROWS",
          "FROM [General Ledger]",
          "WHERE ([Year].&[{{Year}}], [Region].&[{{Region}}], [General Ledger Measure].&[Amount], [Currency].&[Local])" 
        "mdxParams": [
            { "name":"Year", "value":"2012" },
            { "name":"Region", "value":"3", "escaped": true }

    The file has the following properties:

    • id (string): This is a unique id used to identify the statement you want to execute.
    • mdx (array of strings): This is the MDX statement itself, instead of a single string it is an array of strings to make it more readable. Note the use of [ ] square brackets around each of the strings.
    • mdxParams (array of parameters):
      • name (string): The name of the parameter used in the MDX statement. In the MDX statement the parameter should be used like this {{ParameterName}}.
      • value (string): The default value of the parameter, if the parameter is not passed to when executing the MDX the default value will be used.
      • escaped (optional boolean): Whether to escape the any closing square brackets ( ] ) in the parameter values. The default value is true.

    include NAMED MDX STATEMENT in a HTML page

    The easiest way to show data  from a MDX statement into a Canvas page is to use the Canvas directive tm1-ui-table-mdx:

       tm1-instance="Instance Name"
       tm1-cube="Cube Name"
       tm1-mdx-id="MDX ID"

    tm1-ui-table-mdx is going to manage how the data will be displayed depending on the MDX statement. If two dimensions are on rows, the directive will merge the cells to avoid elements to be replicated many times. 

    An example of the tm1-ui-table-mdx can be found in Canvas components called MDX Table:


    Let's build a new tm1-ui-table-mdx using the P&L MDX statement already written in mdx_named.json.

    In a new page, add the following HTML code:

       tm1-cube="General Ledger"

    If you save your HTML file and refresh the Canvas page, you should see the table as below:

    Use tm1-dimension-attribute to show dimensions alias

    To show alias instead of the elements id for dimensions on rows and columns, we need to add the parameter tm1-dimension-attribute="{<dimension name>:<attribute name>"}:

       tm1-cube="General Ledger"
       tm1-dimension-attribute="{Account:'Description', Department:'Description', Period: 'Short Description', Version: 'Description'}"

    Save and refresh the page, you should see now the aliases on rows and dimensions:

    Dynamic MDX statement

    Currently the structure of our MDX statement is static, one way to show data from a different year is to go to the mdx_named.json file and update the MDX statement. The P&L MDX statement has 2 parameters Year and Region. Let's replace 2012 with 2011:

    Save the mdx-named.json and refresh the Canvas page, you should see now 2011 values:

    Another way to update these parameters is to add tm1-mdx-parameters="{Parameter Name:Parameter Value}" to the tm1-ui-table-mdx. Using the tm1-mdx-parameters will enable you to pass the parameters value from the HTML page to the JSON file where the MDX query is defined:

       tm1-cube="General Ledger"
       tm1-dimension-attribute="{Account:'Description', Department:'Description', Period: 'Short Description', Version: 'Description'}"
       tm1-mdx-parameters="{Year:'2011', Region:'England'}">

    Customize the tm1-ui-table-mdx

    To customize the look of the tm1-ui-table-mdx such as removing the pagination, you'll need to update the code behind the tm1-ui-table-mdx. You can find an example in the samples called Named MDX:

    You can copy the HTML code behind this table and start customizing the table. For instance to remove the pagination, you'll need to delete the red part below:

    Manage multiple screen sizes with matchMedia

    Canvas includes the matchMedia library. This Angular library helps you to check which screen size is your page displaying and returns true if the current screen width matches what you need or false if not.

    You can use this angular service to show or hide columns depending on the screen size:

    • xs: Extra small < 576px
    • sm: Small ≥ 576 px
    • md: Medium ≥ 768px
    • lg: large ≥ 992px
    • xl: Extra large ≥ 1200px

    For example, let's say that we have the following table with LY, Year and the 12 months on columns:

    On a small screen you do not want to show all months, you just want to show LY and Year.

    In order to do that you will need to update the controller and then the HTML file.

    Update the controller

    In the controller you will need to enable the library by adding screenSize as one of the dependencies. You can do this by updating the top part of your script / controller as done below:

    app.controller('DataEntryCtrl', ['$scope', '$rootScope', '$tm1UiTable', 'screenSize', function($scope, $rootScope, $tm1UiTable, screenSize) {

    and then, to make it available for use on your HTML page too, create and assign a screenSize property into your $scope and assigned the 'screenSize' library into this variable:

    $scope.screenSize = screenSize;

    The controller will look like this:

    Update the HTML file

    In the html table you will need to use ng-if to show the months columns only if the size is medium (md) or large (lg). To do this, just add the ng-if="'md, lg')" inside the table header:

    <th ng-if="'md, lg')" 
        ng-repeat="month in page.months">{{month}}</th>

    and inside the table data:

    <td ng-if="'md, lg')" 
        ng-repeat="month in page.months" class="text-right" >

    More information about matchMedia can be found into its GitHub page.

    An example of matchMedia can be found in the training session8 (Remove columns chapter):

    Upload files and images

    Aside from the reading and writing back numbers and strings into TM1, Canvas further extends TM1 functionality by allowing you to save URL paths that you can then use to display images for example, or embed link and control access to these links - the TM1 way.

    To start uploading files, it is as simple as writing the following:

    <tm1-ui-upload tm1-instance="dev"></tm1-ui-upload>

    This will give you the following:

    Clicking on the "Select File" on your page will open up a dialog box which will ask you for a file to open/upload. And that is it!

    Now, where did the file go?

    Let us create a full example to better explain what is going on by re-writing the previous example so that we can:

    1. Get the URL path
    2. Save this URL path into TM1
    3. Display an image wherever applicable

    This is the HTML mark up now of our code:

    <tm1-ui-upload tm1-instance="dev" 
    <tm1-ui-dbr-image tm1-instance="dev" 
                      tm1-cube="System Info" 
                      tm1-elements="Current Date, Comment"></tm1-ui-dbr-image>

    And this is the corresponding function updatePreview, on our controller file:

    $scope.updatePreview = function(file){
            // uncomment to see what is being returned
            // console.debug(file); // instance, name, path
            $tm1Ui.cellPut(file.path, 'dev', 'System Info', 'Current Date', 'Comment').then(function(data){
                // uncomment to see what is being returned
                // console.debug('data %o', data);

    Below is the sequence of events:

    1. The tm1-after-upload is an attribute by tm1-ui-upload directive that allows you to specify a function to be called after it has finished the upload.
    2. Within the function, we then use a simplified script in saving data into TM1.
    3. The directive tm1-ui-dbr-image is a variation of DBR that allows you to show images from a properly formatted URL in TM1.

    The files are uploaded, relative to your Canvas application, within files/<instance> folder by default. If you want to save it into a different folder instead, go into your Canvas' Admin console --> Settings and update the following:

    Hide the context buttons

    In Canvas, when you click on a cell which contains a tm1-ui-dbr, the context button will appear. Once you click on this button you'll see a dropdown list with the following options.

    • Reference: Get the TM1 cell reference
    • Spread: Do a spreading
    • Drill: If a drill is set up in TM1, you'll be able to access it.
    • Comment: Input comments using cell annotation or comment measures

    If you want to hide the context button, you need to set to false the 4 following attributes to the tm1-ui-dbr:

    • tm1-hide-reference: hides the Reference
    • tm1-hide-comment: hides the comment
    • tm1-hide-spread: hides the Spread
    • tm1-hide-drill: hides the drill
    • tm1-hide-context-menu: disable the context button

    Different types of DBR

    Similar to TM1 and Excel, Canvas has adopted a cell based approach to application design.  This means each cell in Canvas has its own DBR formula to retrieve and to update TM1. 

    There are 4 different types of DBR:


    A DBR-like implementation for retrieving cube data from TM1. You need to use this directive to build a data entry template. This is the only directive with the write back feature.


    A DBR-like implementation for retrieving cube data from TM1 that is hidden and to be used with ng-model to retrieve cube values. For example, if you need a value to suppress zero, you can use this directive to get a value which will not be displayed in your page. The advantage of using tm1-ui-dbr-hidden instead of tm1-ui-dbr is that if there is a picklist in the cell, tm1-ui-dbr-hidden will retrieve only the value instead of the all picklist.


    A DBR-like implementation for retrieving cube data from TM1 that is always read-only and to be used with ng-model to retrieve cube values.

    tm1-ui-dbr-read-only has been created in order to make your Canvas page even faster. For example, it will not retrieve any picklist values as compared to the tm1-ui-dbr which retrieves not just the values, but also the whole picklist options.

    When you build a dashboard where you do not need to input data, it is recommended to use tm1-ui-dbr-read-only.

    Using tm1-ui-dbr with the attribute tm1-read-only=”true” or  tm1-ui-dbr-read-only will display the same thing on your Canvas page but the difference is that  tm1-ui-dbr-read-only is much faster.

    tm1-ui-dbr vs tm1-ui-dbr-hidden and tm1-ui-dbr-read-only

    Some tm1-ui-dbr functionalities have been removed and recreated into tm1-ui-dbr-hidden and tm1-ui-dbr-read-only. These 2 directives are much lighter and make the rendering of an HTML page faster:



    A DBR-like implementation for retrieving cube data containing paths to images uploaded via tm1-ui-upload from TM1.