Reference Type: Supported, Category: TaskMan, Integration Agreement: 10063
This API looks up tasks and retrieves their current status. The status
of a task returned by STAT^%ZTLOAD is expressed in the general terms of whether
the task ran, is running, or will run. ZTSK(1) and (2) return the code and text
of the current status. This status is an abstraction based on the more complex
system used by TaskMan.
An active task is one that either is expected to start or is currently running. An inactive task will not start in the future without outside intervention; this may be because it has already completed, was never scheduled, or was interrupted. The "running" status is not based on direct examination of the system tables but is inferred from TaskMan's information about the task.
When interpreting the output of STAT^%ZTLOAD, consider that:
Make sure to perform the following steps before calling this API:
(required) The task number to look up. It must be defined on the current volume set.
Numeric status code from 0 to 5 indicating the status of the task.
Status text describing the status of the task. Its value corresponds with the status code in ZTSK(1). The possible values and their meanings are as follows:
August 26, 2011