LogOutput

LogOutput writes a message to the tm1server.log file and optionally the process log file when an error of a specified severity level is encountered in a TurboIntegrator process.

This function is valid in TM1® TurboIntegrator processes only.

Prerequisite

To enable message logging from TurboIntegrator, you must add the TM1.TILogOutput debugger to the tm1-log.properties file and set the debugger to the wanted level. For example, adding TM1.TILogOutput=DEBUG to tm1-log.properties enables logging for all severity levels. For more information on the tm1-log.properties file, see Configuring and Enabling Server Message Logging in TM1 Operations.

Syntax

LogOutput('SeverityLevel', 'MessageString', 'ProcessLog');
Argument Description
SeverityLevel The severity level that initiates logging to the tm1server.log filelog files. Valid values for this argument are:
  • 'DEBUG'
  • 'INFO'
  • 'WARN'
  • 'ERROR'
  • 'FATAL'
MessageString The message that you want to write to the tm1server.log filelog files. The message string can be a string that is enclosed in single quotation marks or can be another TurboIntegrator function that returns a string.
ProcessLog Optional. If set to 1, this function also writes the message to the TurboIntegrator process log file in addition to the tm1server.log file.

If set to 0 or not defined, the function writes messages to just the tm1server.log.

Examples

LogOutput('WARN', 'TI process encountered a warning condition');
LogOutput('ERROR', TM1User(), 0); 
LogOutput('INFO', 'TI process execution finished normally', 1);