Setting Up Excel Logging to Pulse with Excel Logger

Pulse v5.6 introduces a new Excel Add-in to track Excel. This new logger is written in .NET. It is a lighter version of Extend, it only logs Excel usage to Pulse and has no user interface. This is a silent add-in, meaning you will not see it in the Excel toolbar.

This article describes the steps to follow to set up Excel logging to Pulse with this Excel logger. If you are planning to use Extend instead, you need to follow the steps described in the following article:

After installing Pulse, you will find the new add-in in the following folder:

·        \Pulse for TM1\utils\CWExcelLogger

There is one folder for 32 bit Excel (x86 folder) and one for 64bit Excel (x64 folder).

Excel logger uses the same license file as Extend. If you have already a license for Extend, the same license will work. The license file has to be in the same folder as the Excel Logger.xll:

Similar to Extend, the license is based on your domain, so if your domain has not changed you can use the same license.

To see If the Excel Logger is active, you need to go to the Excel addins (Files > Options > Add-ins):

To set up Excel logging to Pulse you need to open the cwxtndxl.ini which is in the following folder:

  • \AppData\Roaming\CWPulseLogger

To access the AppData folder you can type %AppData% into a Windows Explorer.

Add the Pulse URL to PULSE_SERVER parameter:

You can then choose to put the ini file inside the

  • <Excel Logger directory>\cwxtndxl.ini

This folder contains now all files you need to deploy to other users. Just copy the folder to a new user computer and just add the Excel Logger.xll as a new adds-in.

Connect To MS SQL Server using Windows Authentication

SQL Server logo.png

Since Pulse v5.6, you can choose to use MS SQL Server instead of the default H2 database. To learn how to migrate to MS SQL Server you should check the following article:

Once you have created the new Pulse database into MS SQL Server, you need to add the MS SQL Server information to the Pulse configuration file (Pulse for TM1\conf\Pulse.cfg).

If you want to use SQL Authentication, you need to update the JDBCURL, Username and Password:

  • JDBCURL = localhost:1433;databaseName=Pulse
  • UserName = {The SQL UserName}
  • Password = {The SQL password}

To configure Pulse to set up Windows Authentication with SQL Server, there are two ways to do it:

Use Kerberos Authentication

  1. Stop Pulse services
  2. Pulse for TM1 services need to run with the DB owner login of the MS SQL Server database.
  3. Update the JDBCURL setting in Pulse.cfg
    JDBCURL = localhost:1433;databaseName=TM1Pulse;integratedSecurity=true;authenticationScheme=JavaKerberos
  4. Start Pulse Services

Use Native Authentication

  1. Stop Pulse services
  2. Pulse for TM1 services need to run with the DB owner login of the MS SQL Server database.
  3. Update the JDBCURL setting in Pulse.cfg
    JDBCURL = localhost:1433;databaseName=TM1Pulse;integratedSecurity=true
  4. Download the sqljdbc_auth.dll
  5. Add the file sqljdbc_auth.dll to C:\Windows\System32 folder
  6. Start Pulse Services

    When you use integrated login, you don't need to setup username and password in the Pulse.cfg, you just need to update the JDBCURL setting:

    • JDBCURL = localhost:1433;databaseName=TM1Pulse;integratedSecurity=true
    • UserName = 
    • Password =

    Pulse Database Migration into MS SQL Server

    Pulse v5.6 introduced support to MS SQL Server (2012 and onwards). This article describes the steps that you need to follow to configure Pulse with MS SQL Server.

    Pulse v5.5.1 databases

    Pulse v5.5.1 and prior versions were using two databases, one SQL Lite (Monitor.db) and one H2 database (docs.h2.db). If we take the example of a company who has three environment DEV, UAT and PROD, this is how the architecture will look like:

    Pulse v5.6 uses only one H2 database

    In v5.6, these two databases have been merged into one H2 database by default. The main reasons for this change is to simplify the architecture, this is the first step to centralized database and by having all the data into H2, it is easier to migrate H2 to SQL Server.

    The first time Pulse starts after the upgrade, Pulse will migrate all data from Monitor.db and the docs.h2.db to a new docs.h2.db. Depending how big is your database, you might have to wait a few minutes while Pulse is migrating the data. 

    When Pulse is migrating the data, you will see this message on the top navigation bar of the web client:

    SQL Server4.png

    Some Pulse features will work straight away such as the Live Monitor but you will have to wait that the database is ready before running the documentation:

    Configure Pulse to use MS SQL Server

    You can decide to move to MS SQL Server anytime after the upgrade but you should make sure first that Pulse is working with the new H2 database.

    Instead of using H2, you can now ask Pulse to send the data into a centralized MS SQL Server database.

    The advantage of using MS SQL Server:

    • Better performance in larger Pulse DBs and concurrent active Pulse users.
    • Centralize database, you can now have all your Pulse data into one location instead of one database per server.

    Enable MS SQL Server:

    To Enable SQL Server, you need to do the following step:

    1. Create a new database on your SQL Server called Pulse (ask your DB Administrator to do this)

    2. Create a SQL Server login (user name / password) that has DB owner (DBO) access to the Pulse database.

    3. Stop the Pulse services

    4. Update SQL server settings in \Pulse for TM1\conf\Pulse.cfg

    [SQLServer]

    JDBCURL = localhost:1433;databaseName=Pulse
    UserName = {The SQL UserName}
    Password = {The SQL password}

    The password will be encrypted after Pulse restart.

    5. Start the Pulse services

    The first time you start the Pulse services, it is going to migrate the data from the docs.h2.db to the SQL server database. The time to migrate H2 to SQL server is approximately twice the time of the migration from Monitor.db to docs.h2.db.

    Note: Pulse records the server name and the TM1 service name. Even if you have the same TM1 instance name in DEV, UAT and PROD, you will be able to differentiate the instances with the server name:

    Migrating Pulse to a new server

    This article describes the steps to follow when you want to migrate Pulse from an old server to a new server.

    1. Backing up Pulse from the old server.

    If you want to keep Pulse data from the old server, you will need first to back-up some Pulse folders from the old server: 

    2. Install Pulse on the new server.

    The installation of Pulse is straight forward, follow the installation wizard.

    3. Stop Pulse for TM1 services.

    4. Replace the new Pulse folders with the old ones.

    Copy the back up folders from step 1 into the same location on the new server.

    5. Update Pulse databases if server name or TM1 instance changed.

    Do this last step only if the new server name is different from the old one and if the TM1 instance name changed.

    The server name and TM1 instance name are stored in the Pulse databases, to update the Pulse databases, steps are explained in this article:

    6. Start Pulse for TM1 services

    Update the JVM maximum memory

    The Java application server (pulseas.exe) which runs in the background has a default memory of 1024 MB.

    On a very large TM1 application or on a server with lots of TM1 instances, the JVM of the Pulse application server can reach this value.

    Once it has reached this value, Pulse web client will slow down because it has to make some spaces for the new objects by deleting unused objects in order to keep the memory below 1024 MB, this is called garbage collector.

    If Pulse web client slows down or if Pulse reports server out of memory errors, you should increase this value. This can be done manually:

    • Open regedit:

     

    •  Go to HKEY_LOCAL_MACHINE > SOFTWARE > WOW6432Node > Apache Software Foundation > Procrun 2.0 > PulseAppServer > Parameters > Java > JvmMX
    • Double click on JvmMx and tick decimal to see the value:
    • Update the value and click OK.
    • Restart Pulse services