IBM Support

How to log websheets and cube views that are opened by users in TM1 Web ?

Troubleshooting


Problem

This document explains how to log the names of websheets and cube views that are accessed in TM1 Web or Planning Analytics Spreadsheet Services.
This logging can also help to determine which users were logged in TM1 Web as the user names are displayed in the tm1web.log file.
This logging can help determining whether TM1 Web performance issues or JVM memory utilization issues are caused by one or several particular websheets or cube views. The heap memory usage is included in the log.
The present document is valid for TM1 Web versions before 2.0.70.
For more recent versions, follow this other document:

Resolving The Problem

For old TM1 Web (depending on "IBM Cognos TM1" service):
update log4j.properties file in \ibm\cognos\tm1_64\webapps\tm1web\WEB-INF\configuration\
For new Planning Analytics Spreadsheet Services (depending on "IBM Planning Analytics Spreadsheet Services" service):
update log4j.properties file in \ibm\cognos\tm1web\webapps\tm1web\WEB-INF\configuration\
Add the following lines:

log4j.logger.com.ibm.cognos.tm1.web.services.TM1Service=INFO
log4j.logger.com.ibm.cognos.tm1.web.services.TM1ExportService=DEBUG
log4j.logger.com.ibm.cognos.tm1.publish.Workbook=DEBUG
log4j.logger.com.ibm.cognos.tm1.web.services.TM1ServerSessionInfo=DEBUG

The full log4j.properties file now looks like this:

# System logging settings
log4j.rootLogger=ERROR, TextFile
log4j.logger.com.ibm.cognos=ERROR
log4j.logger.com.cognos=ERROR
log4j.logger.com.cognos.org=ERROR
log4j.logger.com.ibm.cognos.perf=ERROR
log4j.logger.com.ibm.cognos.tm1=ERROR
log4j.logger.com.ibm.cognos.tm1.web.clientcontext=INFO
log4j.logger.com.ibm.cognos.tm1.web.services.TM1ExportService=DEBUG
log4j.logger.com.ibm.cognos.tm1.web.services.TM1Service=INFO
log4j.logger.com.ibm.cognos.tm1.publish.Workbook=DEBUG
log4j.logger.com.ibm.cognos.tm1.web.services.TM1ServerSessionInfo=DEBUG

log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p (%x) %c - %m%n

log4j.appender.TextFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.TextFile.File=logs/tm1web.log
log4j.appender.TextFile.DatePattern=.yyyy-MM-dd
log4j.appender.TextFile.layout=org.apache.log4j.PatternLayout
log4j.appender.TextFile.layout.ConversionPattern=%d [%t] %-5p (%x) %c - %m%n

log4j.appender.XMLFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.XMLFile.File=logs/tm1web_log.xml
log4j.appender.XMLFile.DatePattern=.yyyy-MM-dd
log4j.appender.XMLFile.layout=org.apache.log4j.xml.XMLLayout


Next step is to restart the IBM Cognos TM1 Applications server ("IBM Cognos TM1" service) or Planning Analytics Spreadsheet Services.

Now, when a user opens a cube view or a websheet the following entries are written into tm1web.log in \webapps\tm1web\WEB-INF\logs\, for example:
...
2016-03-31 14:55:25,143 [http-9515-6] INFO () com.ibm.cognos.tm1.web.services.TM1Service - New object id requested for websheet 'Applications/Websheets/Budget Input Detail Websheet'.
2016-03-31 14:55:25,246 [http-9515-6] DEBUG () com.ibm.cognos.tm1.publish.Workbook - Creating com.aspose.cells.Workbook for TM1://Planning Sample/blob/PUBLIC/.\}Externals\Book2.xlsx_20160208182055.xlsx.
2016-03-31 14:55:25,247 [http-9515-6] DEBUG () com.ibm.cognos.tm1.publish.Workbook - Current heap memory usage: 289 MB
2016-03-31 14:55:25,504 [http-9515-6] DEBUG () com.ibm.cognos.tm1.publish.Workbook - Finished creating com.aspose.cells.Workbook for TM1://Planning Sample/blob/PUBLIC/.\}Externals\Book2.xlsx_20160208182055.xlsx.
2016-03-31 14:55:25,504 [http-9515-6] DEBUG () com.ibm.cognos.tm1.publish.Workbook - Current heap memory usage: 294 MB
2016-03-31 14:55:25,505 [http-9515-6] DEBUG () com.ibm.cognos.tm1.publish.Workbook - Creating AsposeWorkbook for TM1://Planning Sample/blob/PUBLIC/.\}Externals\Book2.xlsx_20160208182055.xlsx.
2016-03-31 14:55:25,896 [http-9515-6] DEBUG () com.ibm.cognos.tm1.publish.Workbook - Finished creating AsposeWorkbook for TM1://Planning Sample/blob/PUBLIC/.\}Externals\Book2.xlsx_20160208182055.xlsx.
2016-03-31 14:55:25,896 [http-9515-6] DEBUG () com.ibm.cognos.tm1.publish.Workbook - Current heap memory usage: 300 MB
...
This level of logging does not impact performance.

[{"Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSCTEW","label":"IBM Planning Analytics Local"},"ARM Category":[{"code":"a8m50000000KzIpAAK","label":"Performance"},{"code":"a8m0z000000blfjAAA","label":"Troubleshooting"}],"Platform":[{"code":"PF033","label":"Windows"}],"Version":"All Versions","Type":"MASTER"}]

Document Information

Modified date:
08 April 2022

UID

swg21980348

Page Feedback