Enable TM1 Web Logging to Pulse

Pulse can be integrated with TM1 Web to allow the usage of web sheets and cube views to be logged to TM1. To enable this integration you need to follow the steps below.

NOTE: It is recommended that you enable TM1 Web logging out of hours as user sessions may be terminated resulting in lost work.

TM1 Web Is Installed Side-By-Side with TM1

It is very straight forward to add the required files to TM1 Web when it is installed on the same server as TM1:

  1. Log into Pulse
  2. Go to Administration -> Configuration
  3. Check the box Insert Web Logging Script

TM1 Web Installed on a Separate Server

Because TM1 Web is on a different server you need to manually integrate the relevant Pulse files. The setup is slightly different depending on the version of TM1 Web you are using 10.1 or before (IIS/.NET) or 10.2 or greater (Tomcat/Java).

10.1 or Before (IIS/.NET)

  1. Copy the PulseLog.aspx file from <Pulse Install Location>\Resources\TM1WebDotNet\PulseLog.aspx to <TM1 Web Location>\PulseLog.aspx
  2. Copy the pulse.js file from <Pulse Install Location>\Resources\TM1WebDotNet\pulse.js to <TM1 Web Location>\scripts\pulse.js
  3. Open PulseLog.aspx file in Notepad
  4. Enter the name of the server that is hosting the Pulse server in the pulseServerAddress variable, for example:

    string pulseServerAddress = null;

    becomes (double quotes around the server name)

    string pulseServerAddress = "SYDTM101";

  5. If you are using SSL on the Pulse server (this is NOT on by default) change the pulseSSL to true:
  6. If you have change the web port for Pulse from the default 8099 you need to enter your port number in the pulsePortNo setting:

    int pulsePortNo = 8099;

  7. Save the PulseLog.aspx page, you may need to save it to the Desktop and then copy the file to the directory due to Windows UAC restrictions.
  8. Open the TM1WebTop.aspx file in Notepad
  9. Find the HTML element </HTML>, it should be at the bottom of the file.
  10. Insert above this line the following code:

    <script language="javascript" src="scripts/pulse.js"></script>

  11. Save the TM1WebTop.aspx, at this point any users logged in will have their session terminated.

10.2 or greater (Tomcat/Java)

  1. The default location for TM1Web is: C:\Program Files\ibm\cognos\tm1_64\webapps\tm1web
  2. Copy the pulseLog.jsp file from <Pulse Install Location>\Resources\TM1WebJava\pulseLog.jsp to <TM1 Web Location>\pulseLog.jsp
  3. Copy the pulse.js file from <Pulse Install Location>\Resources\TM1WebJava\pulse.js to <TM1 Web Location>\pulse.js
  4. Open pulseLog.jsp file in Notepad
  5. Enter the name of the server that is hosting the Pulse server in the pulseServerAddress variable, for example:

    String pulseServerAddress = "localhost";

    becomes

    String pulseServerAddress = "SYDTM101";

  6. If you are using SSL on the Pulse server (this is NOT on by default) change the pulseSSL to true, you will also need to change the port number. The default SSL port number is 8093.
  7. If you have change the web port for Pulse from the default 8099 you need to enter your port number in the pulsePortNo setting.
  8. Save the pulseLog.jsp page, you may need to save it to the Desktop and then copy the file to the directory due to Windows UAC restrictions.
  9. Open the home.jsp file in Notepad
  10. Find the HTML element, it should be towards the top of the file:

    <script language="javascript" src="scripts/dojo/dojo.js" type="text/javascript"></script>

  11. Insert below this line the following code:

    <script language="javascript" src="pulse.js" type="text/javascript"></script>

  12. Save the home.jsp.
  13. Repeat steps 9 to 12 with applications.jsp file
  14. Repeat steps 9 to 12 with UrlApi.jsp file
  15. Restart the IBM Cognos TM1 Application Server Windows service.