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 (http://www.cronmaker.com/)

  • 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.

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:

    [PDF]
    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.