Anyone that has ever worked in TM1, specifically a TurboIntegrator (TI) process, knows that trying to diagnose issues with a data loading process can be problematic. It is hard to know if the issue lies in the underlying data, or if there is something is wrong with the coding in the TI process. Many of us developers have created our own manual solution of using the “ASCIIOUTPUT” function to export the data to a flat file, which allows the opportunity to examine the underlying data and think through how each record will be handled. Those days might be coming to an end…IBM recently released within their latest fix pack release (10.2.2 Fix Pack 7) a new tool which allows TM1 developers to now debug their TurboIntegrator (TI) processes. The TurboIntegrator Debugger tool now allows a user to set breakpoints and step through TI process to identify possible issues and errors in TI scripts.
Download the latest Turbo Debugger files from here. Turbo Debugger files do not need to be in the same location as TM1 Data folder, but should be in a folder path which is quickly referenced.
After the download, start by edit the tm1s.cfg file with the following items:
##Enable ODATA on the TM1 Server
HTTPPortNumber = XXXX (Replace XXXX with a valid port number)
##Enable TI Debugging
EnableTIDebugging = True
Restart the TM1 service.
Run the TurboDebugger.bat file to use the default SSL certificates. If you are using your own certificates, you will need to edit the .bat file to use the appropriate ones. After running the TurboDebugger.bat file, the TI Debugger will automatically start.
TM1 Server API HTTP URL: TI Debugger communicates to the TM1 service via the REST API. To determine the correct URL for the TM1 server, find the address of the TM1 server machine (machine name, IP address or Url), and HTTPPortNumber and UseSSL setting from TM1s.cfg
Update the generated TI Debugger URL localhost:HTTPportnumber. If the tm1s.cfg file says SSL = T, the http has to be changed to https.
TM1 service running on a machine called “sandbox-tm1-01” with an HTTP port number of 8000 and UseSSL = F: http://sandbox-tm1-01:8000/api/v1/
TM1 service running on a machine at IP address 10.0.1.10 with an HTTP port number setting of 8901 and UseSSL = T: https://10.0.1.10:8901/api/v1/
CAM Namespace: If not automatically populated, go to perspectives/architect and copy the namespace (circled part, see screen shot example below).
If CAM Namespace has been greyed out, click on Login WITHOUT entering a UserID and password. An error will appear, but will be fixed upon next login. A properties file is generated after the first run of the TI Debugger.
User Name: TM1 service user name
Password: TM1 service password
The TurboIntegrator Debugger tool is a long awaited tool by TM1 developers. The tool allows developers to step through and debug their processes by line instead guessing which line(s) of code is the troublemaker. The tool is more realtime debugging than previous work arounds using ASCIIOutput or ProcessQuit functions. No more character per line limits, casting numbers to strings or managing multiple output files. The values of the variables are visible as the process steps through the code.
The TurboIntegrator Debugger tool is supported on TM1 10.2.2 Fix Pack 7 and Planning Analytics Local.
Questions? Comments? Feel free to reach us directly at:
Lacie Baumgartner, firstname.lastname@example.org
Hrolfr Gertsen-Briand, email@example.com