This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


class %SYS.Task.RunLegacyTask extends %SYS.Task.Definition

This class provides a way for users of previous versions of Task Manager to easily migrate their tasks which were based on 'ExecuteCode'. It is shown as a 'Task type' in the Task Scheduler Wizard so that users may enter their code there.

Note that all new user-defined tasks should be created by subclassing %SYS.Task.Definition and editing the OnTask() method. See examples in the [SAMPLES]Sample.Task and Sample.Task* classes.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter TaskName = RunLegacyTask;
Inherited description: This defines the user-visible name of this task; This is defined in subclasses.


property ExecuteCode as %String);
The value of this property is used as the argument to an XECUTE command when OnTask is run. The user may also set the value of the variable "Status" to a return code if they wish.

Note that this is provided only for backwards compatibility. All new user-defined tasks should be created by subclassing %SYS.Task.Definition and editing the OnTask() method.
Property methods: ExecuteCodeDisplayToLogical(), ExecuteCodeGet(), ExecuteCodeIsValid(), ExecuteCodeLogicalToDisplay(), ExecuteCodeLogicalToOdbc(), ExecuteCodeNormalize(), ExecuteCodeSet()


method OnTask() as %Status
This method is responsible for executing the task.
At the scheduled time, the Task Manager creates an instance of this object, sets any property values using the stored "settings" for the task, and then invokes this method to execute the task.
The user's code may set the value of "Status" to return a status code.
method executeCode(code)

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)