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.

Unable to generate the Validation Report

For very large TM1 and Planning Analytics models the validation report can run into 1000's of pages, this can cause issues with the rendering the report.

If the report returns the following message, Unable to generate report: Failed loading..., you will need to turn off the headers and footers.

To turn off the header and footers for all reports you can change the setting in the Pulse.cfg file.

  1. Go to the Pulse.cfg file that is located in the conf directory where Pulse is installed (default: C:\Program Files\Pulse for TM1\conf).
  2. Edit the file with Notepad.
  3. Change 2 settings to true:

    DisableFooter = true
    DisableHeader = true
  4. Save the file. You may need to save the file to your Desktop first and then copy the file to the conf directory due to Windows file restrictions.
  5. Restart the Pulse for TM1 Application Server Windows service.
  6. Run the report again.

Keep Pulse history when migrating Pulse

In Pulse.cfg, a new parameter ServerNameOverride has been added with Pulse v5.7.5. This new parameter enables Pulse to be moved from one server to another and all of the history be kept.
It can also be used in a scenario where the server name is regularly changed, i.e. in a virtual or cloud environment. The ServerNameOverride setting should be the name of the first server Pulse was installed on and configured for. Now when you move the files to another server or change the server name Pulse will continue using the original name.

It might be a bit confusing so let's have a look at an example. Let’s say you are currently using Pulse on one server DEV1, monitoring TM1 instances on the same machine:

1. Install Pulse into a new server DEV2

Now you want to create a new server called DEV2, and migrate the Pulse history from DEV1 to this new server. The first thing you need to do is to install Pulse on this new DEV2 server, you will now have two servers with two Pulse running:

2. Copy accross the Pulse for TM1 folder (ONLY if the Pulse version installed on both servers is the same)

In order to migrate the Pulse history from DEV1 to DEV2, you just need to copy accross the Pulse for TM1 folder:

  • Stop Pulse services on both servers DEV1 and DEV2
  • Delete Pulse for TM1 folder on DEV2 server. Before deleting the folder, backup the license file (The license file is still driven by the server name where Pulse is installed).
  • Copy the Pulse for TM1 folder from DEV1 to DEV2

If Pulse installed on DEV1 and DEV2 are two different versions, copy only the backup folders.

If the Pulse version on DEV2 is different than the one installed on DEV1, copying the all Pulse for TM1 folder will not work. In this case you will have to migrate only the folders described in this article:

3. Update ServerNameOverride parameter in Pulse.cfg

Once copied, you will have to update the Pulse.cfg in DEV2 with ServerNameOverride=DEV1. By doing so Pulse will now run on the DEV2 server using actually DEV1 as a server name. The ServerNameOverride parameter is located in the Monitoring section:

4. Check Pulse license file

The Pulse license file can be based either on your domain or on the server name. If your license file is based on your domain and if DEV1 and DEV2 server are on the same domain, you can then use the same license file on both server.
However if your license file is based on the server name where Pulse is installed. On the DEV2 server, the server name in the Pulse license file has to be DEV2. To check the server name in the license file, just open Pulse for TM1\server\License.xml and look for:


Replacing the server name manually will not work. If you do not have a license file for your new server, you should request a new license by sending the new server name to your local contact at Cubewise.

5. Start Pulse services

On the DEV2 server, Pulse will now run as expected, the only difference is on the backend where it is going to use DEV1 as server name. Pulse on the DEV2 server will only monitor TM1 instances on the DEV2 server.

Search for elements in your TM1 model

If there is something you'd like to know about your TM1 application such as, how a cube is updated, where an attribute is used or where a specific string is referenced, just ask Pulse. You can access this search feature from the top bar:

By default, Pulse will not search for elements in a dimension. To enable the search on elements, you will have to enable the Source Level for this dimension and then run the documentation. In the example below, Source Level has been enabled for the Product dimension:

After running the documentation, you should be able to find elements for this dimension:

Setting Up Windows (SSO) Authentication for Pulse

Starting now with Pulse v5.7.3, you can now use Windows (SSO) Authentication for Pulse. What that means is when you navigate to the Pulse website (or thick client) you can be automatically logged in with your Windows account. 

Windows Authentication provides two major benefits:

  • Users no longer have to remember passwords.
  • All logging of who does what in Pulse will have the persons user name.

1. Create a new Pulse user DOMAIN\username

Once Windows Authentication is turned on, Pulse will automatically create users when they navigate to Pulse for the first time. Users will be created with a user of DOMAIN\user and will have PUBLIC group privileges.

To enable Windows Authentication, just follow these steps:

  • Stop the Pulse services
  • Close your web browser (To clear the cookies)
  • Open Pulse.cfg and update the new parameter WindowsAuthentication = true
  • Open a new web browser 
  • Go to the Pulse URL and Pulse should log you automatically. Pulse will create a new user DOMAIN\user:

This new user will be part of the PUBLIC group, any user of this group sees the same content as someone who isn’t logged in.

2. Give Admin right to your new user DOMAIN\username

To set Admin rights to your new user, you will have to turn off Windows Authentication, login as Admin and give Admin privileges to your new user:

  • Stop Pulse services
  • Close your web browser (To clear the cookies)
  • Open Pulse.cfg and update the new parameter WindowsAuthentication = false
  • Open a new web browser
  • Login with Admin user
  • Go to Administration > Users and tick the Admin box for your new user:

3. Turn on Windows Authentication

Now that you have one user with Admin right setup, you just need now to turn on the Windows Authentication:

  • Stop Pulse services
  • Close your web browser (To clear the cookies)
  • Open Pulse.cfg and update the new parameter WindowsAuthentication = true
  • Open a new web browser
  • Go to the Pulse URL and Pulse should log you automatically. Pulse will create a new user DOMAIN\user:

It can be noted that once Windows Authentication is set up, you cannot log out anymore, each time you click log out, Pulse will log back you in.