IBM Support

Documentation update - TurboIntegrator function LogOutput

Product Documentation


Abstract

The LogOutput TM1 TurboIntegrator function was added for TM1 version 10.2.2 but is not included in the documentation.

Content

LogOutput

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

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 desired level. For example, adding TM1.TILogOutput=DEBUG to tm1-log.properties enables logging for all severity levels. For details on the tm1-log.properties file, see http://www.ibm.com/support/knowledgecenter/SS9RXT_10.3.0/com.ibm.swg.ba.cognos.tm1_op.10.3.0.doc/c_configuringandenablinglogging_n160682.html%23ConfiguringandEnablingLogging_N160682

As with all TurboIntegrator function names, 'LogOutput' is a reserved word that should not be used as a variable name in TurboIntegrator processes.


Syntax:

LogOutput('SeverityLevel', 'MessageString');


ArgumentDescription
SeverityLevelThe severity level that initiates logging to the tm1server.log file.

Valid values for this argument are:
  • 'DEBUG'
  • 'INFO'
  • 'WARN'
  • 'ERROR'
  • 'FATAL'
MessageStringThe message you want to write to the tm1server.log file.

The message string can be a string enclosed in single quotes or can be another TurboIntegrator function that returns a string.

Examples:

LogOutput('WARN', 'TI process encountered a warning condition');
LogOutput('ERROR', TM1User() );

[{"Product":{"code":"SS9RXT","label":"Cognos TM1"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"TM1 Turbo Integrator","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF010","label":"HP-UX"}],"Version":"10.2.2","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
17 June 2018

UID

swg27047744