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

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %SYS.Task.BackupSuper

Super class for backup tasks.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter TaskName;


property Device as %String (MAXLEN = 1024) [ InitialExpression = ##class(%File).NormalizeDirectory("Backup") ];
Property methods: DeviceDisplayToLogical(), DeviceGet(), DeviceIsValid(), DeviceLogicalToDisplay(), DeviceLogicalToOdbc(), DeviceNormalize(), DeviceSet()
property SaveToTape as %Boolean [ InitialExpression = "0" ];
Property methods: SaveToTapeDisplayToLogical(), SaveToTapeGet(), SaveToTapeIsValid(), SaveToTapeLogicalToDisplay(), SaveToTapeNormalize(), SaveToTapeSet()
property TapeDevice as %String [ InitialExpression = "47" ];
Back up tape device if it is save to tape
Property methods: TapeDeviceDisplayToLogical(), TapeDeviceGet(), TapeDeviceIsValid(), TapeDeviceLogicalToDisplay(), TapeDeviceLogicalToOdbc(), TapeDeviceNormalize(), TapeDeviceSet()


private method %OnValidateObject() as %Status
This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

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.
In order to execute a real task, override this method in a subclass.