CancelJobs function for IBM Planning Analytics (TM1)
CancelJobs cancels asynchronous processes launched by the RunProcess function and is blocked under these conditions: lock acquisition on an object used by the process, wait for another process to finish, and execute the Sleep function within the process. When a job is cancelled, any pending changes are rolled back.
In this video, CancelJobs is used to wait for both asynchronous processes to complete before continuing to the next line.
Where can the CancelJobs function be used?
TurboIntegrator
Which TM1 Server version is the CancelJobs function available for?
Version 12
What is the syntax for CancelJobs?
CancelJobs(ID1, ID2, etc.)
- ID1, ID2, etc = The job ID of a process that can be obtained using GetJobStatus()
Relevant Functions
- CancelJobs: cancel asynchronous processes that were launched by the RunProcess function and are blocked due to certain conditions. Any pending changes in a job cancelled with CancelJobs are rolled back.
- GetJobStatus: return the status for a specified process.
- WaitforAllJobs: instructs the main process to wait for all specified asynchronously executed processes to complete before continuing the main process.
- WaitForAnyJobs: instruct a main process to wait for any specified asynchronously executed processes to complete before continuing the main process.
- WaitForInternalJobs: wait for all asynchronous jobs that are directly launched by the current process to complete before continuing the current process.