This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > Backup.Task


persistent class Backup.Task extends %Library.Persistent, %SYSTEM.Help

SQL Table Name: Backup.Task

A backup task is a backup type and an output device with an optional description. There are a set of system defined tasks which cannot be changed.

Property Inventory

Method Inventory


parameter DOMAIN = %Utility;
Default Localization Domain


property Description as %String (MAXLEN = 256);
User-specified description of this backup task. This is stored in the backup history.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Device as %SysPath;
User-specified output device for this backup task. This can be a tape device or a directory where the backup files are stored. If this is blank the default is the Backup subdirectory under the directory which contains the CACHESYS database.
Property methods: DeviceDisplayToLogical(), DeviceGet(), DeviceIsTapeDisplayToLogical(), DeviceIsTapeGet(), DeviceIsTapeIsValid(), DeviceIsTapeLogicalToDisplay(), DeviceIsTapeNormalize(), DeviceIsTapeSet(), DeviceIsValid(), DeviceLogicalToDisplay(), DeviceLogicalToOdbc(), DeviceNormalize(), DeviceSet()
property DeviceIsTape as %Boolean;
True if the output device is a tape.
Property methods: DeviceIsTapeDisplayToLogical(), DeviceIsTapeGet(), DeviceIsTapeIsValid(), DeviceIsTapeLogicalToDisplay(), DeviceIsTapeNormalize(), DeviceIsTapeSet()
property LastFile as %String (MAXLEN = 256) [ ReadOnly ];
Date portion of the filename for the last run of this task. The full filename consists of this property plus the .cbk file extension.

Log files are located in the Backup subdirectory under the directory that contains the CACHESYS database, and their filenames consist of the LastFile property plus the .log file extension.
Property methods: LastFileDisplayToLogical(), LastFileGet(), LastFileIsValid(), LastFileLogicalToDisplay(), LastFileLogicalToOdbc(), LastFileNormalize()
property LastModifiedTime as %String [ ReadOnly ];
The date and time this backup task was last modified.
Property methods: LastModifiedTimeDisplayToLogical(), LastModifiedTimeGet(), LastModifiedTimeIsValid(), LastModifiedTimeLogicalToDisplay(), LastModifiedTimeLogicalToOdbc(), LastModifiedTimeNormalize()
property LastRunStatus as %String [ ReadOnly ];
The status of this backup task's last run. It can be blank if the task has never been run, or else one of the following statuses: "Running", "Completed", or "Failed".
Property methods: LastRunStatusDisplayToLogical(), LastRunStatusGet(), LastRunStatusIsValid(), LastRunStatusLogicalToDisplay(), LastRunStatusLogicalToOdbc(), LastRunStatusNormalize()
property LastRunTime as %String [ ReadOnly ];
The date and time this backup task was last run.
Property methods: LastRunTimeDisplayToLogical(), LastRunTimeGet(), LastRunTimeIsValid(), LastRunTimeLogicalToDisplay(), LastRunTimeLogicalToOdbc(), LastRunTimeNormalize()
property Name as %String [ ReadOnly ];
The name of this task.
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize()
property SwitchJournal as %Boolean;
Indicates whether the journal file should be switched as part of running the backup.
Property methods: SwitchJournalDisplayToLogical(), SwitchJournalGet(), SwitchJournalIsValid(), SwitchJournalLogicalToDisplay(), SwitchJournalNormalize(), SwitchJournalSet()
property SystemTask as %Boolean [ ReadOnly ];
Denotes that this is a system task. Certain tasks are defined by the system and cannot be modified.
Property methods: SystemTaskDisplayToLogical(), SystemTaskGet(), SystemTaskIsValid(), SystemTaskLogicalToDisplay(), SystemTaskNormalize()
property Type as %String (DISPLAYLIST = "/Full/Incremental/Cumulative Incremental", VALUELIST = "/0/1/2");
Type of backup which will be performed.
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()


classmethod HistoryClose(ByRef qHandle As %Binary) as %Status
classmethod HistoryExecute(ByRef qHandle As %Binary, TimeStart As %String = "", TimeEnd As %String = "") as %Status
classmethod HistoryFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status


query History(DateStart As %String = "", DateEnd As %String = "")
Selects Type As %String, Databases As %String, Time As %String, Journal As %String, LogFile As %String, Status As %String
Provides a history of all backup operations that have been executed. The results are in reverse-chronological order.
query List()
Selects Name As %String, Type As %String, Device As %String, SwitchJournal As %Boolean, Description As %String, LastModifiedTime As %String, LastRunTime As %String, Status As %String, ReadOnly As %Boolean, IsTape As %Boolean, LastLogFile As %String, StatusStr As %String
Provides a list of all currently defined tasks.
The four built-in tasks are always returned first, followed by any user-defined tasks.

LastFile only has a value if a log file exists from the last run of the backup.
query ListLogFiles(task As %String = "")
Selects Name As %String,
Returns a list of log files that exist for a specified backup task. If no task is specified, returns a list of all log files for all backup tasks.

Inherited Members

Inherited Methods