ProcessReturnCode function for IBM Planning Analytics (TM1)
Where can the ProcessReturnCode function be used?
Which TM1 Server version is the ProcessReturnCode function available for?
What is the syntax for ProcessReturnCode?
- StatusCode:
- ProcessExitByBreak() = Indicates that the process exited because it encountered a ProcessBreak function.
- ProcessExitByChoreQuit() = Indicates that the process exited due to execution of the ChoreQuit function.
- ProcessExitByChoreRollback() = Indicates that the process exited because it encountered a ChoreRollback function.
- ProcessExitByProcessRollback() = Indicates that the process exited because it encountered a ProcessRollback function.
- ProcessExitByQuit() = Indicates that the process exited because of an explicit quit command.
- ProcessExitMinorError() = Indicates that the process was executed successfully but encountered minor errors.
- ProcessExitNormal() = Indicates that the process is executed normally.
- ProcessExitOnInit() = Indicates that the process aborted during initialization.
- ProcessExitSeriousError() = Indicates that the process exited because of a serious error.
- ProcessExitWithMessage() = Indicates that the process exited normally, with a message written to tm1server.log.
Relevant Functions
- DataMinorErrorCount = Counts minor errors that occur in Data tab
- ExecuteCommand = Executes a command line
- ExecuteHttpRequest = Executes an HTTP request to a server over the web, enabling the retrieval of web pages, data and other resources
- ExecuteJavaN = Executes a Java TurboIntegrator process that returns a number
- ExecuteJavaS = Executes a Java TurboIntegrator process that returns a string
- ExecuteProcess = Executes a process
- GetProcessErrorFileDirectory = Returns the full path name, with trailing slash, of the directory where error files are written
- GetProcessErrorFilename = Returns the name of the error log file associated with the process
- GetProcessName = Returns the name of the process
- HttpResponseGetStatusCode = returns the status code
- HttpResponseGetHeader = returns content from the header
- HttpResponseGetBody = returns content from the body
- If = Uses a conditional expression to check if an expression is true or false
- ItemReject = Skips the current source data transaction like ItemSkip
- ItemSkip = Skips the current transaction in the process
- MetadataMinorErrorCount = A global variable that counts minor errors that occur in the Metadata portion in a process
- ProcessBreak = Stops processing any data and moves straight to the Epilog
- ProcessError = Immediately terminates the process and produces an error
- ProcessExists = Checks if a process exists. 1 is returned if the process exist, 0 if it does not exist
- ProcessExitByChoreRollback = triggers a chore rollback and exits with an error code that discards all pending edits and stops further processing in a TurboIntegrator process.
- ProcessExitByProcessRollback = triggers a process rollback and exits with an error code that discards all pending edits and stops further processing in a TurboIntegrator process.
- ProcessQuit = Immediately terminates the process and returns a Process Quit message
- ProcessReturnCode = A global variable that stores the exist status of the most recently executed process
- ProcessRollback = Terminates the process and begins a rollback
- PrologMinorErrorCount = A global variable that counts minor errors that occur in the Prolog
- RunProcess = Run multiple processes in parallel. This function can speed up data loads and other processes by dividing work into multiple parts
- Sleep = Pauses a process for a specified interval
- Synchronized = Forces processes to run in sequence
- While = Repeats a set of command until a condition is true
