TM1ProcessExecute.exe and TM1ChoreExecute.exe
Last Modified: 2008-09-06 by Creeth, Richman & Associates, Inc.


ABOUT THIS FILE:
This readme file contains instructions on how to run the command-line 
executables:
	TM1ProcessExecute.exe (Version 0.2)
	and 
	TM1ChoreExecute.exe (Version 0.2).


PREREQUISITES:
These executables use the TM1 API, which means the following files should
either be in the same folder as these executables or accessible in the 
machine PATH variable:
* TM1API.DLL
* TM1LIB.DLL
* TM1SIP.DLL
* LIBEAY32.DLL (only for TM1 9.1 and higher)
* SSLEAY32.DLL (only for TM1 9.1 and higher)
* \ssl subfolder from TM1 BIN folder (only for TM1 9.1 and higher)
NOTE: These TM1-prefixed files must come from a compatible version as compared
to the TM1 Server version you are connecting to.  If any of the following DLLs
is not found, you will receive an error indicating that the TM1 API could not 
be found.  Also note that LIBEAY32.DLL and SSLEAY32.DLL are open source DLLs,
which means that other, sometimes incompatible, copies of them may exist on
the same machine and result in unable to find TM1 Server messages.

These executables additionally depend on the Microsoft Visual C++ 
Runtime Library 7.1:
* msvcr71.dll
* msvcirt.dll
* msvcp71.dll


INSTRUCTIONS FOR RUNNING TM1ProcessExecute.exe:
  
  The purpose of TM1ProcessExecute.exe is to run a TM1 Turbo Integrator 
  process from a command-line given the required parameter information.
  
  The correct usage is as follows:

  TM1ProcessExecute AdminServer TM1Server UserID Password ProcessName P1 P2 ...
	
  * AdminServer is the name of machine running the Admin Server service on 
  	your network.
  * TM1Server is the visible name of your TM1 Server (not the machine name of 
    the machine running TM1.
  * UserID is a TM1 user ID with credentials to see the TI Process.
  * Password is the TM1 user ID's password to the TM1 Server.
  * ProcessName is the name of requested process to be run.
  * P1, P2, ... denotes parameter values of the process, in order.

  If no parameters are needed then the correct usage is:
  TM1ProcessExecute AdminServer TM1Server UserId  Password ProcessName

  NOTE: If a parameter is blank you need to specify 2 double quotes: ""
        If a paramter value contains spaces you should wrap it in double
        quotes: "This value has spaces"

  This program returns 0 if the requested process is successfully run, otherwise 
  it returns 1 if any errors occured.  The application will output 
  informational and error messages to the console window or output file, 
  depending on how you configure the output of the command.


INSTRUCTIONS FOR RUNNING TM1ChoreExecute.exe:
  
  The purpose of TM1ChoreExecute.exe is to run a TM1 Turbo Integrator 
  chore from a command-line.
  
  The correct usage is as follows:

  TM1ChoreExecute AdminServer TM1Server UserID Password ChoreName  
	
  * AdminServer is the name of machine running the Admin Server service on 
  	your network.
  * TM1Server is the visible name of your TM1 Server (not the machine name of 
    the machine running TM1.
  * UserID is a TM1 user ID with credentials to see the TI Process.
  * Password is the TM1 user ID's password to the TM1 Server.
  * ChoreName is the name of requested chore to be run.
  
  NOTE: If a parameter is blank you need to specify 2 double quotes: ""
        If a paramter value contains spaces you should wrap it in double
        quotes: "This value has spaces"

  This program returns 0 if the requested chore is successfully run, otherwise 
  it returns 1 if any errors occured.  The application will output 
  informational and error messages to the console window or output file, 
  depending on how you configure the output of the command.

