Given the unveiling of a more officially supported/documented executable from IBM, TM1RunTI.EXE, I'm putting this utility out to pasture for now. It's still available if you're interested, but overlaps enough with IBM's utility that I'm not planning on developing it further. Some details on that new IBM EXE can be found here for now:
http://www.tm1forum.com/viewtopic.php?f=3&t=5176
If interested in the history behind this utility and its predecessors, feel free to read on in this thread...
Hi Everyone,
It's taken far longer than I would have liked to get this out to everyone, but this is effectively an update of the older TM1ProcessExecute and TM1ChoreExecute command-line interfaces. I'm putting this new version into a separate posting because it's been almost completely rewritten and now combines the 2 executables into one: TIExecute.exe.
Disclaimers:
Just the usual: No guarantees/warranties whatsoever are provided. The software is provided "as-is".
Reporting Problems:
[UPDATE] As noted above, since IBM have released their own version of a similar utility to run TI processes, this one is not being developed further. You can PM me if you like with any issues/questions/suggestions, but I'm very likely going to refer you to the new IBM-created TM1RunTI.EXE [UPDATE]
Hope you find it useful! Detailed notes are below.
Regards,
Mike Cowie
---- Release Notes & Documentation ----
1.0.0 (Initial Release) - CURRENT VERSION
Just to highlight some of the changes for everyone in the updated TI Chore and Process execution command-line utility, TIExecute.exe:
- The utility is now written using C#, targeting the .NET Framework 2.0. It still uses the TM1 C API.
- There are now 32-bit and 64-bit builds of the utility. I don't believe you'll have any luck running this on anything other than a Windows OS given the .NET Framework linkage. I believe you'll need the .NET Framework build that matches the TIExecute.exe build (e.g., 64-bit TIExecute.exe needs .NET 2.0 x64). Otherwise you may get BadImageFormat exceptions.
- The utility uses a TIExecute.config file to specify (currently) 2 main settings:
- Location of TM1 API files. It is important that you specify the location with the correct format of the TM1 API that matches the copy of TIExecute.EXE you are using. For example, if you're using the x86 version of TIExecute.exe, you'll need to refer to the 32-bit version of the TM1 API.
- - Client SSL Configuration for TIExecute.
- The utility now supports the following login methods:
- Native TM1
- TM1 Integrated Login
- CAM Namespace (e.g., for Cognos Express)
- CAM Passport
NOTE: I've been able to test all but CAM Passport, mainly because I'm not sure yet how one goes about testing that option. - The utility has a somewhat simplified (and changed) command-line interface, which will hopefully make it easier to enhance with additional functionality in the future.
- .NET Framework 2.0 (x86 and/or x64 depending on your OS and version of TIExecute.exe you plan to use).
- Unzip these files (for the chosen 32-bit or 64-bit build) to any directory of your choosing:
- TIExecute.exe
- TIExecute.config - Modify TIExecute.config to refer to the location of your TM1 API files. Assuming you have already installed TM1 on the same machine as TIExecute.exe, here are some likely paths to the TM1 API:
64-bit TIExecute.exe on a 64-bit OS:
- Cognos TM1: <add key="TM1APIPath" value="C:\Program Files\Cognos\TM1\Bin\" />
- Cognos Express: <add key="TM1APIPath" value="C:\Program Files (x86)\IBM\Cognos Express\Xcelerator\bin\" />
32-bit TIExecute.exe on a 64-bit OS:
- Cognos TM1: <add key="TM1APIPath" value="C:\Program Files (x86)\Cognos\TM1\Bin\" />
- Cognos Express: <add key="TM1APIPath" value="C:\Program Files (x86)\IBM\Cognos Express Clients\Xcelerator Client\bin\" />
32-bit TIExecute.exe on a 32-bit OS:
- Cognos TM1: <add key="TM1APIPath" value="C:\Program Files\Cognos\TM1\Bin\" />
- Cognos Express: <add key="TM1APIPath" value="C:\Program Files\IBM\Cognos Express Clients\Xcelerator Client\bin\" />
Command-Line Syntax:
- Usage:
TIExecute AdminHost TM1Server TM1CxnString Action ObjectName [<P1>, <P2>, ..., <Pn>] - Where:
AdminHost: TM1 Admin Server. Use machine name or address, or "localhost" for current machine.
TM1Server: TM1 Server Name.
TM1CxnString: One of the following TM1 connection options:
- TM1/LDAP Login: "TM1;<UserID>;<Password>"
- TM1 Integrated: "TM1Integrated"
- CAM Namespace: "CAMNamespace;<Namespace>;<UserID>;<Password>"
- CAM Passport: "CAMPassport:<Passport>"
Action: Currently One of the following possible commands:
- "RunProcess": Runs a Turbo Integrator Process.
- "RunChore": Runs a Turbo Integrator Chore.
ObjectName: Name of the Process/Chore.
[<P1>, <P2>, ..., <Pn>]: Optional list of parameter values for Turbo Integrator process execution. - Sample command to run a process in TM1 using native TM1 login (user: Admin, pwd: apple):
TIExecute "localhost" "Planning Sample x64" "TM1;admin;apple" "RunProcess" "Your Process Name" "P0 Value" "P1 Value" ... - Sample command to run a process in Cognos Express using CAM Namespace login (user: Administrator, pwd: blank):
TIExecute "localhost" "Planning Sample x64" "CAMNamespace;CognosExpress;administrator;" "RunChore" "Your Chore Name"
Other Notes:
- The ZIP includes some very basic TI processes and chores that you can use for simple testing of TIExecute.exe.
- The ZIP includes a text file with some additional sample commands that might be of use.