Client logging

A client-side logging tool is available that can collect data about activity for TM1® clients, such as IBM® Cognos® TM1 Architect and IBM Cognos TM1 Perspectives.

Due to the large amounts of data that can be collected, this tool should only be used under the direction of customer support.

Here is a sample client log:

log4j.rootLogger=DEBUG, R1
#Server Explore
log4j.logger.COrionMainApp=DEBUG
log4j.logger.CCubeView=DEBUG
log4j.logger.CubeViewGrid=DEBUG
log4j.logger.COrionTreeView=DEBUG
log4j.logger.COrionApp=DEBUG
log4j.logger.CMultiSelect=DEBUG
log4j.logger.CCreateSandbox=DEBUG
log4j.logger.loggerViewDimension=DEBUG
#Subset Editor
log4j.logger.CSubsetWnd=DEBUG
log4j.logger.CSubsetEntry=DEBUG
log4j.logger.CSubsetListProp=DEBUG
log4j.logger.CSubsetListBox2=DEBUG
log4j.logger.CSubsetListView1=DEBUG
log4j.logger.CSubsetRegExp=DEBUG
log4j.logger.CSubsetSelByAttr=DEBUG
log4j.logger.CSingleSelect=DEBUG
#ISB
log4j.logger.CXLCtrlsApp=DEBUG
log4j.logger.CConnectServerDlg=DEBUG
log4j.logger.CViewCtrl=DEBUG
log4j.logger.CGetViewDlg=DEBUG
log4j.logger.CubeViewerISB=DEBUG
log4j.logger.ExcelReportPrintDPage=DEBUG
log4j.logger.CTM1Connector=DEBUG
log4j.logger.ExcelReportPrintIncludedSheetsPage=DEBUG
log4j.logger.CAutoExcel=DEBUG
log4j.logger.SubsetEditorIntLog=DEBUG
#Perspectives
log4j.logger.TM1Perspectives=DEBUG
log4j.logger.TM1AF=DEBUG
log4j.logger.TM1ExcelAPI=DEBUG
log4j.appender.R1=org.apache.log4j.RollingFileAppender
log4j.appender.R1.File=c:\\ClientDebugLog.log
log4j.appender.R1.MaxFileSize=10 MB
log4j.appender.R1.MaxBackupIndex=50
log4j.appender.R1.layout=org.apache.log4j.PatternLayout
log4j.appender.R1.layout.ConversionPattern=%X{pid} %t %p %d{%Y-%m-%d %H:%M:%S,%Q} %c %m%n  
log4j.appender.R1.layout.TimeZone=GMT

To turn on client-side logging, create a file called tm1p-log.properties in the C:\Users\<USER>\AppData\Roaming\Applix\TM1 location on the client machine. The TM1p.ini file must be in the same folder.

Be sure that location is also set in the log4j.appender.R1.File=c:\\ClientDebugLog.log line of the log file.

If you put the log files directly on the C drive as in the example , log4j.appender.R1.File=c:\\ClientLog.log

Be sure to use \\ slashes.

If you want to use a temp directory, specify the location using the other slash:

log4j.appender.R1.File=c:/temp/ClientLog.log

Be sure to update the file parameter with the new location if you change the tm1p-log.properties file, for example:

location.log4j.appender.R1.File=c:\<new location>\ClientDebugLog.log

If the presence of this file and at least one component within it is set to DEBUG, client-side logging is collected. log4j.rootLogger=DEBUG can only be set to OFF or DEBUG (which turns client logging ON).

To turn off logging, remove or rename this file. You can turn off logging for an individual component by changing the value from DEBUG to OFF.

To customize the log file, you can change:

Location of the log file is set in log4j.appender.R1.File=c:\\ClientDebugLog.log
Log file max size is set in log4j.appender.R1.MaxFileSize=10 MB. When this size is met a new log file is created.
Backup index is set in log4j.appender.R1.MaxBackupIndex=50.