Sending Email Alerts from TM1 Using Pulse

IBM Planning Analytics (TM1) does not include a built-in mechanism for sending email notifications. Pulse fills this gap with its proactive alerting features, allowing administrators and developers to trigger email alerts based on server events, log messages, and custom conditions written directly in TI processes.

Use Case: Data Reconciliation Failure Alert

A common scenario is a nightly chore that loads data but where the data may not reconcile correctly between cubes. The following approach uses Pulse to send an email when a reconciliation check fails.

Step 1 – Write to the TM1 Message Log from a TI Process

From TM1 v10.2.2 onwards, the LogOutput function allows you to write a message to tm1server.log from within a TI process:

LogOutput('SeverityLevel', 'MessageString');

Example — check whether two cube values reconcile and log a failure message if they do not:

IF( nValueGL <> nValueRetail );
  message = 'Cost of Sales reconciliation failed between GL ( ' | sValueGL | ' ) and Retail ( ' | sValueRetail | ' ) for ' | cVersion | ' - ' | cYear;
  LogOutput('INFO', message);
ENDIF;

Step 2 – Define a "Message In Log" Alert in Pulse

In Pulse, create a Message In Log alert:

Filter pattern: *failed* (or any wildcard matching your log message)
Notification Group: the group of users or admins to email (e.g. TM1Admin)
Instance: set to a specific instance or leave blank to apply to all instances

Result

Every time the TI process writes a matching message to tm1server.log, Pulse sends an email alert to the notification group. The email includes:

The matched text pattern found in the log
A snapshot of the instance's TM1 Top data at the time of the alert

This approach works for any custom condition you can express in TI — data reconciliation, process completion, threshold breaches, and more.