How To

Setting up Canvas logging to Pulse

Setting up Canvas logging to Pulse is quite straightforward. All the configuration happens on the Canvas side.

Step 1: Open the Canvas admin page of your application by going to the following URL:


Step 2: Enter your Canvas admin credentials

Step 3: Enter Pulse URL in the Log Visits To Pulse Address, tick Log Visits To File and finally click the Save button.

logging pulse 3.png

In the example above, Canvas will send the data to Pulse in the server cw007

Step 4: Check in Pulse Canvas Open page

Now in the Pulse > User Analytics > Canvas Open page, you will see all pages currently open by your users.

When the Logs Visits To File is ticked, Canvas will start populating the following file with the user activity, you will see the page URL, the filters and who opened the page:

You will have to repeat these steps for each Canvas application you want to track.

Configuring Pulse with CAM Security and SSO

This article describes the steps to configure Pulse to connect to a Planning Analytics instance using CAM authentication and SSO (Single Sign-on).

Step 1: Finding the CAM Passport

To connect to the TM1 instance, Pulse will require the CAM Passport from TM1 Web. There are different ways to get the CAM Passport, in this article we are going to grab the CAM Passport from one of the TM1 Web responses:

1) Open your web browser, open the developer console, go to the Network tab and make sure the Preserve log is on and the Disable cache is off.

2) Enter the TM1 Web URL, after logging in (with a TM1 user with admin rights) you should be able to see lots of responses in the Network tab.

The CAM Passport can be found in many responses. If you click on the one called tm1web.html?cam_passeport…, you will find it in the Request URL as shown below:

Step 2: Updating Pulse settings

Copy the CAM Passeport, go to the Pulse instance settings and update the following settings:

  • CAM Passeport: the one you just copied

  • Process to Keep Alive CAM Passeport: You will need to create a blank process which does nothing, Pulse will execute it every 5 min to keep the CAM Passeport alive. In this example the new TM1 process is called zPulseToKeepAliveCAMPasseport.

  • User Name: The user that you used to login to TM1 Web


Note: CAM Namespace is case sensitive, the username that you put in Pulse settings as to have the same case as the one you see in Architect:

That’s it, you can now update the documentation

Cleansing the Pulse data

Pulse v5.8 includes a new job to help removing old data in the Pulse database. By default, Pulse will keep all data from the first time it was installed in its database. To reduce the size of the Pulse database, you can now easily choose to keep only the last 360 days of history.

To do that, a new Maintenance section has been added to the conf/Pulse.cfg file including 5 new parameters:

  • MaintenanceJobHourInterval: The maintenance will execute by default each Sunday at 4:30 am (default: 0 30 4 ? * SUN *). To change this time, you will need to add a new CRON expression, you can use a CRON generator (

  • ServerHistoricDays: The number of days of server history data to keep (Default: 0, means none active)

  • ProcessHistoryHistoricDays: The number of days of process history data to keep (Default: 0, means none active)

  • DumpFilesHistoricDays: The number of days of dump files data to keep (Default: 0, means none active)

  • PulseLogFilesHistoricDays: The number of days of Pulse logs data to keep (Default: 0, means none active)

To activate the maintenance job:

  1. Stop Pulse services

  2. Update the above Maintenance settings in the conf/Pulse.cfg

  3. Start Pulse services

Executing the System Summary Report

Pulse v5.8 introduces a brand-new report, the System Summary report. This report will help TM1 administrators to monitor the health of their TM1 instances.

This report gathers all the most important Pulse data that you should look at when doing a health check of a TM1 instance such as user sessions, wait time and alerts.

Part 1 - Analysing the number of sessions vs number of alerts: This first chart will give you the number of sessions vs number of alerts:

Part 2 - Analysing wait time: On the left side you will see the Top 10 waiting time event and how long was the wait. On the right a bar chart to analyse the maximum wait time by period.

Part 3 - Analysing Alerts: This chart will give you the number of alerts by type over time.

How to run and schedule this report?

This report is only available to Pulse admin users but can be sent to anyone from a notification group. To access it, login as Admin to the Pulse Web client, from the left menu go to Reports > Performance > System Summary:

  • Select one TM1 instance

  • Select date the time frame and test the report

  • Schedule the report:

    • Select how many days of data you want to see

    • Daily Frequency of the report, how often you want it to run

    • Notification group

    • Email subject

Report time breakdown

  • If the number of days selected = 1, the breakdown will be by hours

  • If the number of days selected < 91, the breakdown will be by days

  • If the number of days selected > 90, the breakdown will be by months

 Schedule the report for the last 7 days

An example of the settings to schedule this report to be sent every day at 8:00 am containing the last 7 days of data:

Creating a new validation rule

Pulse comes with a number of built-in rules that identify common pitfalls that may slow the system or make support difficult.

Naming conventions are also validated allowing you to build consistent and easy to maintain systems.

All of these validations can be changed and added to according to your own best practices. This article will explain you how to create a new rule.

Validation rules examples

To see all existing validation rules, from the Pulse web client go to Administration and then Validation Rules, you can click on any rules to see the settings:

How to create a new validation rule

To create a new rule, just click the New button and then fill all the rules information:

  1. Rule Type: defines the type of validation rule, it can be applied against a name of an object or a rule and process.

  2. Name: Rule name.

  3. Enabled: if the rule is enabled.

  4. Description: Rule description.

  5. Remedy: Write how to fix it.

  6. Location: Enter the type of object or location for the validation rule, for multiple options separate by a comma.

  7. Regular Expression: Define the regular expression (a special text string for describing a search pattern) that will be used to search for the offending name or piece of code.

    More information on Regular Expression:

  8. Level: A number from 1 to 100, with 100 being the highest, that specifies the importance of the rule. In the validation report values of 50 or higher are errors and below 50 are warnings.

  9. Case Sensitive: Whether the rule should be case sensitive, for rule and process validation this should be false.

  10. Finally click the Save button.