Skip to main content


SQL Table Name: %SYS.TaskSuper

This class is for internal use only. Please see %SYS.Task for a Task API.

Property Inventory

Method Inventory


parameter DOMAIN = %Utility;
parameter Version = 2.9;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.


property DailyEndTime as %Time (XMLTIMEZONE = "IGNORE") [ InitialExpression = 0 ];
See DailyFrequency property for legal values
Property methods: DailyEndTimeDisplayToLogical(), DailyEndTimeGet(), DailyEndTimeIsValid(), DailyEndTimeLogicalToDisplay(), DailyEndTimeLogicalToOdbc(), DailyEndTimeLogicalToXSD(), DailyEndTimeNormalize(), DailyEndTimeOdbcToLogical(), DailyEndTimeSet(), DailyEndTimeXSDToLogical()
property DailyFrequency as %Integer (DISPLAYLIST = ",Once,Several", VALUELIST = ",0,1") [ InitialExpression = 0 ];
How often each day to run the task.
This property governs how the properties DailyFrequencyTime, DailyIncrement, DailyStartTime, and DailyEndTime are interpreted.

Valid parameters for DailyFrequency are:

0 - ONCE - Run once on the day scheduled
DailyFrequencyTime - "", ignored
DailyIncrement - "", ignored
DailyStartTime - Time for task to run in $H format($p($h,",",2))
DailyEndTime - "",ignored

1 - SEVERAL - Run Several times in a day
DailyFrequencyTime - 0 - Run every x minutes
DailyFrequencyTime - 1 - Run every x hours
DailyIncrement - # of minutes between runs or # of hours between runs
DailyStartTime - Time for tasks to start running in $H format($p($h,",",2))
DailyEndTime - Time for task to stop running in $H format($p($h,",",2))


Run once at 5:00 pm

Run every 60 minutes between 5:00 pm and 9:00 pm

Run every hour between 5:00 pm and 9:00 pm

Run every two hours between 5:00 pm 9:00 pm

By default, if the Daily parameters are not set when a task is created, it will run once on the day scheduled at 12:00 am.
Property methods: DailyFrequencyDisplayToLogical(), DailyFrequencyGet(), DailyFrequencyIsValid(), DailyFrequencyLogicalToDisplay(), DailyFrequencyNormalize(), DailyFrequencySet(), DailyFrequencyXSDToLogical()
property DailyFrequencyTime as %Integer (DISPLAYLIST = ",Minutes,Hourly", VALUELIST = ",0,1");
See DailyFrequency property for legal values
Property methods: DailyFrequencyTimeDisplayToLogical(), DailyFrequencyTimeGet(), DailyFrequencyTimeIsValid(), DailyFrequencyTimeLogicalToDisplay(), DailyFrequencyTimeNormalize(), DailyFrequencyTimeSet(), DailyFrequencyTimeXSDToLogical()
property DailyIncrement as %String;
See DailyFrequency property for legal values
Property methods: DailyIncrementDisplayToLogical(), DailyIncrementGet(), DailyIncrementIsValid(), DailyIncrementLogicalToDisplay(), DailyIncrementLogicalToOdbc(), DailyIncrementNormalize(), DailyIncrementSet()
property DailyStartTime as %Time (XMLTIMEZONE = "IGNORE") [ InitialExpression = 0 ];
See DailyFrequency property for legal values
Property methods: DailyStartTimeDisplayToLogical(), DailyStartTimeGet(), DailyStartTimeIsValid(), DailyStartTimeLogicalToDisplay(), DailyStartTimeLogicalToOdbc(), DailyStartTimeLogicalToXSD(), DailyStartTimeNormalize(), DailyStartTimeOdbcToLogical(), DailyStartTimeSet(), DailyStartTimeXSDToLogical()
property DayNextScheduled as %Date (XMLPROJECTION = "NONE") [ ReadOnly ];
$h Value of when the task is next scheduled to run
Property methods: DayNextScheduledDisplayToLogical(), DayNextScheduledGet(), DayNextScheduledIsValid(), DayNextScheduledLogicalToDisplay(), DayNextScheduledLogicalToOdbc(), DayNextScheduledLogicalToXSD(), DayNextScheduledNormalize(), DayNextScheduledOdbcToLogical(), DayNextScheduledXSDToLogical()
property Description as %String (MAXLEN = 100, TRUNCATE = 1);
Description of task
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property DisplayDayNextScheduled as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayDayNextScheduledCompute(), DisplayDayNextScheduledDisplayToLogical(), DisplayDayNextScheduledGet(), DisplayDayNextScheduledIsValid(), DisplayDayNextScheduledLogicalToDisplay(), DisplayDayNextScheduledLogicalToOdbc(), DisplayDayNextScheduledNormalize(), DisplayDayNextScheduledSQLCompute(), DisplayDayNextScheduledSet(), DisplayDayNextScheduledSetT()
property DisplayEndDate as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayEndDateCompute(), DisplayEndDateDisplayToLogical(), DisplayEndDateGet(), DisplayEndDateIsValid(), DisplayEndDateLogicalToDisplay(), DisplayEndDateLogicalToOdbc(), DisplayEndDateNormalize(), DisplayEndDateSQLCompute(), DisplayEndDateSet(), DisplayEndDateSetT()
property DisplayErrorDate as %Date [ Transient ];
Property methods: DisplayErrorDateCompute(), DisplayErrorDateDisplayToLogical(), DisplayErrorDateGet(), DisplayErrorDateIsValid(), DisplayErrorDateLogicalToDisplay(), DisplayErrorDateLogicalToOdbc(), DisplayErrorDateLogicalToXSD(), DisplayErrorDateNormalize(), DisplayErrorDateOdbcToLogical(), DisplayErrorDateSQLCompute(), DisplayErrorDateSet(), DisplayErrorDateSetT(), DisplayErrorDateXSDToLogical()
property DisplayErrorNumber as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayErrorNumberCompute(), DisplayErrorNumberDisplayToLogical(), DisplayErrorNumberGet(), DisplayErrorNumberIsValid(), DisplayErrorNumberLogicalToDisplay(), DisplayErrorNumberLogicalToOdbc(), DisplayErrorNumberNormalize(), DisplayErrorNumberSQLCompute(), DisplayErrorNumberSet(), DisplayErrorNumberSetT()
property DisplayFinished as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayFinishedCompute(), DisplayFinishedDisplayToLogical(), DisplayFinishedGet(), DisplayFinishedIsValid(), DisplayFinishedLogicalToDisplay(), DisplayFinishedLogicalToOdbc(), DisplayFinishedNormalize(), DisplayFinishedSQLCompute(), DisplayFinishedSet(), DisplayFinishedSetT()
property DisplayInterval as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayIntervalCompute(), DisplayIntervalDisplayToLogical(), DisplayIntervalGet(), DisplayIntervalIsValid(), DisplayIntervalLogicalToDisplay(), DisplayIntervalLogicalToOdbc(), DisplayIntervalNormalize(), DisplayIntervalSQLCompute(), DisplayIntervalSet(), DisplayIntervalSetT()
property DisplayNextScheduled as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayNextScheduledCompute(), DisplayNextScheduledDisplayToLogical(), DisplayNextScheduledGet(), DisplayNextScheduledIsValid(), DisplayNextScheduledLogicalToDisplay(), DisplayNextScheduledLogicalToOdbc(), DisplayNextScheduledNormalize(), DisplayNextScheduledSQLCompute(), DisplayNextScheduledSet(), DisplayNextScheduledSetT()
property DisplayNextScheduledBrief as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayNextScheduledBriefCompute(), DisplayNextScheduledBriefDisplayToLogical(), DisplayNextScheduledBriefGet(), DisplayNextScheduledBriefIsValid(), DisplayNextScheduledBriefLogicalToDisplay(), DisplayNextScheduledBriefLogicalToOdbc(), DisplayNextScheduledBriefNormalize(), DisplayNextScheduledBriefSQLCompute(), DisplayNextScheduledBriefSet(), DisplayNextScheduledBriefSetT()
property DisplayRun as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayRunCompute(), DisplayRunDisplayToLogical(), DisplayRunGet(), DisplayRunIsValid(), DisplayRunLogicalToDisplay(), DisplayRunLogicalToOdbc(), DisplayRunNormalize(), DisplayRunSQLCompute(), DisplayRunSet(), DisplayRunSetT()
property DisplayRunAfter as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayRunAfterCompute(), DisplayRunAfterDisplayToLogical(), DisplayRunAfterGet(), DisplayRunAfterIsValid(), DisplayRunAfterLogicalToDisplay(), DisplayRunAfterLogicalToOdbc(), DisplayRunAfterNormalize(), DisplayRunAfterSQLCompute(), DisplayRunAfterSet(), DisplayRunAfterSetT()
property DisplayStartDate as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayStartDateCompute(), DisplayStartDateDisplayToLogical(), DisplayStartDateGet(), DisplayStartDateIsValid(), DisplayStartDateLogicalToDisplay(), DisplayStartDateLogicalToOdbc(), DisplayStartDateNormalize(), DisplayStartDateSQLCompute(), DisplayStartDateSet(), DisplayStartDateSetT()
property DisplayStarted as %String (MAXLEN = 255) [ Transient ];
Property methods: DisplayStartedCompute(), DisplayStartedDisplayToLogical(), DisplayStartedGet(), DisplayStartedIsValid(), DisplayStartedLogicalToDisplay(), DisplayStartedLogicalToOdbc(), DisplayStartedNormalize(), DisplayStartedSQLCompute(), DisplayStartedSet(), DisplayStartedSetT()
property DisplayStatus as %String (MAXLEN = 1024) [ Transient ];
Property methods: DisplayStatusCompute(), DisplayStatusDisplayToLogical(), DisplayStatusGet(), DisplayStatusIsValid(), DisplayStatusLogicalToDisplay(), DisplayStatusLogicalToOdbc(), DisplayStatusNormalize(), DisplayStatusSQLCompute(), DisplayStatusSet(), DisplayStatusSetT()
property ER as %String (XMLPROJECTION = "none");
$lb(date,index) in %ER global on error
Property methods: ERDisplayToLogical(), ERGet(), ERIsValid(), ERLogicalToDisplay(), ERLogicalToOdbc(), ERNormalize(), ERSet()
property EmailOnCompletion as list of %String (MAXLEN = 255);
A comma separated list of email addresses to send a completion notification to.
Property methods: EmailOnCompletionBuildValueArray(), EmailOnCompletionCollectionToDisplay(), EmailOnCompletionCollectionToOdbc(), EmailOnCompletionDisplayToCollection(), EmailOnCompletionDisplayToLogical(), EmailOnCompletionGet(), EmailOnCompletionGetObject(), EmailOnCompletionGetObjectId(), EmailOnCompletionGetSwizzled(), EmailOnCompletionIsValid(), EmailOnCompletionLogicalToDisplay(), EmailOnCompletionLogicalToOdbc(), EmailOnCompletionNormalize(), EmailOnCompletionOdbcToCollection(), EmailOnCompletionSet(), EmailOnCompletionSetObject(), EmailOnCompletionSetObjectId()
property EmailOnError as list of %String (MAXLEN = 255);
A comma separated list of email addresses to send an error notification to.
Property methods: EmailOnErrorBuildValueArray(), EmailOnErrorCollectionToDisplay(), EmailOnErrorCollectionToOdbc(), EmailOnErrorDisplayToCollection(), EmailOnErrorDisplayToLogical(), EmailOnErrorGet(), EmailOnErrorGetObject(), EmailOnErrorGetObjectId(), EmailOnErrorGetSwizzled(), EmailOnErrorIsValid(), EmailOnErrorLogicalToDisplay(), EmailOnErrorLogicalToOdbc(), EmailOnErrorNormalize(), EmailOnErrorOdbcToCollection(), EmailOnErrorSet(), EmailOnErrorSetObject(), EmailOnErrorSetObjectId()
property EmailOnExpiration as list of %String (MAXLEN = 255);
A comma separated list of email addresses to send notification if the task expires.
Property methods: EmailOnExpirationBuildValueArray(), EmailOnExpirationCollectionToDisplay(), EmailOnExpirationCollectionToOdbc(), EmailOnExpirationDisplayToCollection(), EmailOnExpirationDisplayToLogical(), EmailOnExpirationGet(), EmailOnExpirationGetObject(), EmailOnExpirationGetObjectId(), EmailOnExpirationGetSwizzled(), EmailOnExpirationIsValid(), EmailOnExpirationLogicalToDisplay(), EmailOnExpirationLogicalToOdbc(), EmailOnExpirationNormalize(), EmailOnExpirationOdbcToCollection(), EmailOnExpirationSet(), EmailOnExpirationSetObject(), EmailOnExpirationSetObjectId()
property EmailOutput as %Library.Boolean [ InitialExpression = 0 ];
If an output directory and output file are chosen, and EmailOutput is set to 1 the output from the entry will be emailed to the email addresses in the EmailOnCompletion property.
Property methods: EmailOutputDisplayToLogical(), EmailOutputGet(), EmailOutputIsValid(), EmailOutputLogicalToDisplay(), EmailOutputLogicalToXSD(), EmailOutputNormalize(), EmailOutputSet(), EmailOutputXSDToLogical()
property EndDate as %Date;
$p($h,",",1) value when to stop scheduling the task
Default is to never stop scheduling
Property methods: EndDateDisplayToLogical(), EndDateGet(), EndDateIsValid(), EndDateLogicalToDisplay(), EndDateLogicalToOdbc(), EndDateLogicalToXSD(), EndDateNormalize(), EndDateOdbcToLogical(), EndDateSet(), EndDateXSDToLogical()
property Error as %String (MAXLEN = 1024, TRUNCATE = 1);
Untrapped error from User task, or "Success"
Property methods: ErrorDisplayToLogical(), ErrorGet(), ErrorIsValid(), ErrorLogicalToDisplay(), ErrorLogicalToOdbc(), ErrorNormalize(), ErrorSet()
property Expires as %Boolean [ InitialExpression = 1 ];
Whether this entry expires. Expiration is only checked if this flag is set to 1. Expiration is determined by whichever is first: 1) The current time passed the next submit time. 2) Expiration Offsets (Days, Hours, Minutes).
Property methods: ExpiresDisplayToLogical(), ExpiresGet(), ExpiresIsValid(), ExpiresLogicalToDisplay(), ExpiresLogicalToXSD(), ExpiresNormalize(), ExpiresSet(), ExpiresXSDToLogical()
property ExpiresDays as %Integer;
Property methods: ExpiresDaysDisplayToLogical(), ExpiresDaysGet(), ExpiresDaysIsValid(), ExpiresDaysLogicalToDisplay(), ExpiresDaysNormalize(), ExpiresDaysSet(), ExpiresDaysXSDToLogical()
property ExpiresHours as %Integer;
Property methods: ExpiresHoursDisplayToLogical(), ExpiresHoursGet(), ExpiresHoursIsValid(), ExpiresHoursLogicalToDisplay(), ExpiresHoursNormalize(), ExpiresHoursSet(), ExpiresHoursXSDToLogical()
property ExpiresMinutes as %Integer;
Property methods: ExpiresMinutesDisplayToLogical(), ExpiresMinutesGet(), ExpiresMinutesIsValid(), ExpiresMinutesLogicalToDisplay(), ExpiresMinutesNormalize(), ExpiresMinutesSet(), ExpiresMinutesXSDToLogical()
property IsBatch as %Boolean [ InitialExpression = 0 ];
Batch mode restricts the job to a small section of the buffer pool.
0 - Don't run in batch mode (default)
1 - Run in batch mode
Property methods: IsBatchDisplayToLogical(), IsBatchGet(), IsBatchIsValid(), IsBatchLogicalToDisplay(), IsBatchLogicalToXSD(), IsBatchNormalize(), IsBatchSet(), IsBatchXSDToLogical()
property JobGUID as %String;
Unique Identifier assigned to each job
Property methods: JobGUIDDisplayToLogical(), JobGUIDGet(), JobGUIDIsValid(), JobGUIDLogicalToDisplay(), JobGUIDLogicalToOdbc(), JobGUIDNormalize(), JobGUIDSet()
property LastFinished as %String [ InitialExpression = 0 ];
$h Value of when the task was last finished
0 - did not finish
Property methods: LastFinishedCompute(), LastFinishedDisplayToLogical(), LastFinishedGet(), LastFinishedIsValid(), LastFinishedLogicalToDisplay(), LastFinishedLogicalToOdbc(), LastFinishedNormalize(), LastFinishedSQLCompute(), LastFinishedSet(), LastFinishedSetT()
property LastSchedule as %String [ InitialExpression = 0 ];
$h Value of when the task was last scheduled to run
0 - Never run
Property methods: LastScheduleDisplayToLogical(), LastScheduleGet(), LastScheduleIsValid(), LastScheduleLogicalToDisplay(), LastScheduleLogicalToOdbc(), LastScheduleNormalize(), LastScheduleSet()
property LastStarted as %String [ InitialExpression = 0 ];
$h Value of when the task was last started
0 - Never started
Property methods: LastStartedDisplayToLogical(), LastStartedGet(), LastStartedIsValid(), LastStartedLogicalToDisplay(), LastStartedLogicalToOdbc(), LastStartedNormalize(), LastStartedSet()
property MirrorStatus as %Integer (DISPLAYLIST = ",Primary,Non-Primary,Any", VALUELIST = ",1,2,3") [ InitialExpression = 1 ];
Used to control the execution of tasks when the system is part of a Mirror. Tasks may be scheduled to run on each Mirror Member, but will only be executed if the current status matches what is indicated by this property. This property is ignored by the Task Manager if the system is not a Mirror member. Status = 1 - run only on Primary Mirror member (default)
Status = 2 - run only on a Non-Primary Mirror member
Status = 3 - run on Any Mirror member regardless of status
Property methods: MirrorStatusDisplayToLogical(), MirrorStatusGet(), MirrorStatusIsValid(), MirrorStatusLogicalToDisplay(), MirrorStatusNormalize(), MirrorStatusSet(), MirrorStatusXSDToLogical()
property Name as %String (TRUNCATE = 1);
Name of the task. Must be 16 characters or less, first character must be a letter.
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property NameSpace as %String (MAXLEN = 64) [ InitialExpression = "%SYS" ];
Namespace to run the task in (default="%SYS")
Property methods: NameSpaceDisplayToLogical(), NameSpaceGet(), NameSpaceIsValid(), NameSpaceLogicalToDisplay(), NameSpaceLogicalToOdbc(), NameSpaceNormalize(), NameSpaceSet()
property OpenOutputFile as %Library.Boolean [ InitialExpression = 0 ];
If the output from the executed code is to be directed to an output file, open the output file. If the executed code handles the open and close this value should be 0.
Property methods: OpenOutputFileDisplayToLogical(), OpenOutputFileGet(), OpenOutputFileIsValid(), OpenOutputFileLogicalToDisplay(), OpenOutputFileLogicalToXSD(), OpenOutputFileNormalize(), OpenOutputFileSet(), OpenOutputFileXSDToLogical()
property OutputDirectory as %String (MAXLEN = 1024);
If an output directory and output file are chosen, the output from the entry will be directed there.
Property methods: OutputDirectoryDisplayToLogical(), OutputDirectoryGet(), OutputDirectoryIsValid(), OutputDirectoryLogicalToDisplay(), OutputDirectoryLogicalToOdbc(), OutputDirectoryNormalize(), OutputDirectorySet()
property OutputFileIsBinary as %Boolean [ InitialExpression = 1 ];
When emailing the output file this flag will indicate if the file should be sent as binary
Property methods: OutputFileIsBinaryDisplayToLogical(), OutputFileIsBinaryGet(), OutputFileIsBinaryIsValid(), OutputFileIsBinaryLogicalToDisplay(), OutputFileIsBinaryLogicalToXSD(), OutputFileIsBinaryNormalize(), OutputFileIsBinarySet(), OutputFileIsBinaryXSDToLogical()
property OutputFilename as %String (MAXLEN = 255);
If an output directory and output file are chosen, the output from the entry will be directed there. Note that if OutputDirectory is blank, this may contain the full file name.
Property methods: OutputFilenameDisplayToLogical(), OutputFilenameGet(), OutputFilenameIsValid(), OutputFilenameLogicalToDisplay(), OutputFilenameLogicalToOdbc(), OutputFilenameNormalize(), OutputFilenameSet()
property Priority as %Integer (DISPLAYLIST = ",Normal,Low,High", VALUELIST = ",0,1,2") [ InitialExpression = 0 ];
Background Job priority 0 - Normal (Default)
1 - Low
2 - High
Property methods: PriorityDisplayToLogical(), PriorityGet(), PriorityIsValid(), PriorityLogicalToDisplay(), PriorityNormalize(), PrioritySet(), PriorityXSDToLogical()
property RescheduleOnStart as %Boolean [ InitialExpression = 0 ];
If true, when the CheckSchedule class method is called with SystemStart=1 any jobs pending in the task queue will be removed, and rescheduled for their next time. For example, the journal switch is scheduled for midnight. If the system goes down at 11 pm, and then restarts at 1 am, the journal switch would normally run. But since we just started, we don't really want it to switch, so we reschedule it for the next time.
Property methods: RescheduleOnStartDisplayToLogical(), RescheduleOnStartGet(), RescheduleOnStartIsValid(), RescheduleOnStartLogicalToDisplay(), RescheduleOnStartLogicalToXSD(), RescheduleOnStartNormalize(), RescheduleOnStartSet(), RescheduleOnStartXSDToLogical()
property RunAfterGUID as %String;
Execute this job when specified job completes
Property methods: RunAfterGUIDDisplayToLogical(), RunAfterGUIDGet(), RunAfterGUIDIsValid(), RunAfterGUIDLogicalToDisplay(), RunAfterGUIDLogicalToOdbc(), RunAfterGUIDNormalize(), RunAfterGUIDSet()
property RunAsUser as %String;
Username of user to run as User must have %Admin_Secure role to define task to run as another user
Property methods: RunAsUserDisplayToLogical(), RunAsUserGet(), RunAsUserIsValid(), RunAsUserLogicalToDisplay(), RunAsUserLogicalToOdbc(), RunAsUserNormalize(), RunAsUserSet()
property RunningJobNumber as %String;
$J value of the job when running
Property methods: RunningJobNumberDisplayToLogical(), RunningJobNumberGet(), RunningJobNumberIsValid(), RunningJobNumberLogicalToDisplay(), RunningJobNumberLogicalToOdbc(), RunningJobNumberNormalize(), RunningJobNumberSet()
property StartDate as %Date [ InitialExpression = $H+1 ];
$p($h,",",1) value when to schedule the task first
Default is to start tomorrow
Property methods: StartDateDisplayToLogical(), StartDateGet(), StartDateIsValid(), StartDateLogicalToDisplay(), StartDateLogicalToOdbc(), StartDateLogicalToXSD(), StartDateNormalize(), StartDateOdbcToLogical(), StartDateXSDToLogical()
property Status as %String (MAXLEN = 1024, TRUNCATE = 1, XMLPROJECTION = "none") [ InitialExpression = 1 ];
Return value of the method %OnTask If not defined by the task default success will be 1 If the job is currently running (JobRunning) Status will be -1 If there was an untrapped error (JobUntrappedError) Status will be -2 If there was an error before execution (JobSetupError) Status will be -3 If the task timed out trying to job (JobTimeout) Status will be -4 If there was an error after execution JobPostProcessError) Status will be -5 The text of the status code will be in the property Error
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property SuspendOnError as %Boolean [ InitialExpression = 0 ];
Option to suspend a Task if it encounters an error during a run. By default the Task is just rescheduled for it's next run.

Note that this only applies to errors returned by OnTask. Errors encountered in Task Manager code will suspend the Task.
Property methods: SuspendOnErrorDisplayToLogical(), SuspendOnErrorGet(), SuspendOnErrorIsValid(), SuspendOnErrorLogicalToDisplay(), SuspendOnErrorLogicalToXSD(), SuspendOnErrorNormalize(), SuspendOnErrorSet(), SuspendOnErrorXSDToLogical()
property Suspended as %Integer (DISPLAYLIST = ",,Suspend Leave,Suspend Reschedule", VALUELIST = ",0,1,2") [ InitialExpression = 0 ];
0 - Not suspended (default)
1 - Suspend the task, but leave it in task queue
2 - Suspend the task, remove from task queue, and reschedule for next time
Property methods: SuspendedDisplayToLogical(), SuspendedGet(), SuspendedIsValid(), SuspendedLogicalToDisplay(), SuspendedNormalize(), SuspendedSet(), SuspendedXSDToLogical()
property TaskClass as %String (MAXLEN = 255);
A class in the specified 'NameSpace' which inherits from %SYS.Task.Definition
Property methods: TaskClassDisplayToLogical(), TaskClassGet(), TaskClassIsValid(), TaskClassLogicalToDisplay(), TaskClassLogicalToOdbc(), TaskClassNormalize(), TaskClassSet()
property TimeNextScheduled as %Time (XMLPROJECTION = "NONE") [ ReadOnly ];
$h Value of the times the task is next scheduled to next run,
each time separated by a "~"
Property methods: TimeNextScheduledDisplayToLogical(), TimeNextScheduledGet(), TimeNextScheduledIsValid(), TimeNextScheduledLogicalToDisplay(), TimeNextScheduledLogicalToOdbc(), TimeNextScheduledLogicalToXSD(), TimeNextScheduledNormalize(), TimeNextScheduledOdbcToLogical(), TimeNextScheduledXSDToLogical()
property TimePeriod as %Integer (DISPLAYLIST = ",Daily,Weekly,Monthly,Monthly Special,Run After,On Demand", VALUELIST = ",0,1,2,3,4,5") [ InitialExpression = 0 ];
Time period to run the task.
This property governs how the properties TimePeriodEvery and TimePeriodDay are interpreted

Valid parameters For TimePeriod are

TimePeriodEvery - Run every x Days, where Days are 1-7
TimePeriodDay - Set to "", ignored

TimePeriodEvery - Run every x Weeks, where weeks are 1-5
TimePeriodDay - Run on days xxxx, where Sunday=Day 1,Saturday=Day 7

(where 23456 would be Monday thru Friday) 2 - MONTHLY
TimePeriodEvery - Run every x Months, where months are 1-12
TimePeriodDay - Run on day x, where day=1-31, where 31=last day of month

TimePeriodEvery - Run every x Months, where months are 1-12
TimePeriodDay - week^day,where weeks is 1-5, 5 being last, day is 1-7, sunday is day 1

4 - RUNAFTER - Run this task after another task completes
TimePeriodEvery - (not used)
TimePeriodDay - 0
RunAfterGUID - JobGUID of Task to follow

5 - ONDEMAND - The task is set up. It can be run On Demand by calling the RunOnce method
TimePeriodEvery - "",ignored
TimePeriodDay - "", ignored
The user calls the RunOnce Class method to schedule the task after it is set up

If the Time period fields are not set when a task is created, The task is set by default to be run every day.


Run every day

Run every other day

Run Every Sunday

Run Every Monday through Friday

Run Every other Saturday

Run The first day of every month

Run the last day of every month

Run the last day of every other month

Run the second Saturday of every month

Run the first Sunday of every month

Run after task BACKUP completes

Task is not scheduled to run. Task is scheduled to run by calling the RunOnce method
Property methods: TimePeriodDisplayToLogical(), TimePeriodGet(), TimePeriodIsValid(), TimePeriodLogicalToDisplay(), TimePeriodNormalize(), TimePeriodSet(), TimePeriodXSDToLogical()
property TimePeriodDay as %String;
See TimePeriod property for legal values
Property methods: TimePeriodDayDisplayToLogical(), TimePeriodDayGet(), TimePeriodDayIsValid(), TimePeriodDayLogicalToDisplay(), TimePeriodDayLogicalToOdbc(), TimePeriodDayNormalize(), TimePeriodDaySet()
property TimePeriodEvery as %String [ InitialExpression = 1 ];
See TimePeriod property for legal values
Property methods: TimePeriodEveryDisplayToLogical(), TimePeriodEveryGet(), TimePeriodEveryIsValid(), TimePeriodEveryLogicalToDisplay(), TimePeriodEveryLogicalToOdbc(), TimePeriodEveryNormalize(), TimePeriodEverySet()


classmethod %OnDelete(OID As %Library.ObjectIdentity) as %Status
Log the Deletion of a Task
method AssignSettings(pTask As %SYS.Task.Definition = "") as %Status
Used to properly move the settings from the Task Definition class into the settings property
classmethod DisplayErrorCalc(ER As %String, Position) as %String
classmethod DisplayGUID(JobGUID As %String, Brief As %Boolean) as %String
Displays Name, NameSpace, ID for a Guid
classmethod DisplayIntervalCalc(TimePeriod, RunAfterGUID, DailyFrequency, DailyFrequencyTime, DailyStartTime, DailyEndTime, DailyIncrement)
classmethod DisplayRunCalc(TimePeriod, TimePeriodEvery, TimePeriodDay, RunAfterGUID) as %String
method Expired(ByRef TaskFinished) as %Boolean
When a task is marked as Expires=1 the task will expire if
  • there are no values for ExpiresDays,ExpiresHours,ExpiresMinutes and the time has passed the next scheduled date/time
  • the scheduled time + ExpiresDays+ExpiresHours+ExpiresMinutes is passed the current times
classmethod ExportTasks(ListOfIDS As %String = "", FileName As %String = "", qspec As %String = "d") as %Status
List of task IDs to export $lb(1,2,3)
classmethod FindId(Name As %Library.String) as %Integer
backward compatible - returns ID for a %SYS.Task object
classmethod GUIDToID(TaskGUID) as %Integer
classmethod GetRunAfterGUID(ID) as %String
get job guid given an ID
classmethod GetRunAfterID(GUID) as %String
method GetSettings(ByRef Settings As %List) as %Status
Return the settings defined for the TaskClass
classmethod ImportTasks(FileName As %String = "", qspec As %String = "d") as %Status
classmethod OpenId(Name As %Library.String) as %SYS.Task
somewhat backward compatibility
classmethod Resume(ID As %Integer = "") as %Status
Resume a Task previously suspended using Suspend or Suspended due to Error.
classmethod RunNow(ID As %Integer) as %Status
Schedule a task to run immediately (or within a short period of time).
ID of the task
classmethod RunOnce(ID As %Integer, Date As %Integer, Time As %Integer) as %Status
Schedule a task to run at a specific time.
ID of the task
Date - Date in $h format
Time - Time in $h format
classmethod SettingsDisplayToLogical(Settings As %Binary) as %Binary
classmethod SettingsLogicalToDisplay(Settings As %Binary) as %Binary
method StartDateSet(Arg As %String) as %Status
on reset of StartDate also reset the LastSchedule and the NextSchedule so that a (proper) new schedule is created
classmethod StatusAsText(Status As %Status) as %String
classmethod Suspend(ID As %Integer = "", Flag As %Integer = 1) as %Status
Suspend a Task.
Flag=1 - Suspend the task, but leave it in task queue (default)
=2 - Suspend the task, remove from task queue, and reschedule for next time
classmethod SuspendGet() as %Boolean
Return the value of the Task suspension flag.
0 - Currently running
1 - Currently suspended
classmethod SuspendSet(Flag As %Boolean) as %Status
Suspend/Resume the Task Manager.
Flag =
0 - Resume Task Manager
1 - Suspend Task Manager
classmethod TASKMGRStatus() as %Integer
Task Status 0 - Not running
1 - Running
2 - Suspended
classmethod VersionGet() as %String
Return the version of the Task Class.
classmethod WakeTASKMGR(Message As %String = "")
Wake up the Task Manager.


query JobGUIDTaskList()
Selects JobGUID As %String, Task Name As %String
SQL Query:
Returns a list of the task names with JobGUIDs.
query OnDemandTasks()
Selects ID As %Integer, Task Name As %String, Description As %String
SQL Query:
SELECT %ID,Name,Description FROM %SYS.Task Where TimePeriod=5
query QuickTaskList()
Selects ID As %Integer, Task Name As %String
SQL Query:
Returns a list of the task names.
query RunAfterQuery(RunAfterGUID As %Integer = 0)
SQL Query:
SELECT %ID FROM %SYS.Task Where RunAfterGUID=:RunAfterGUID and Suspended=0
Find all tasks scheduled to run after completing task
query SuspendedTasks()
Selects Task Name As %String, Last Status As %String, Last Result As %String, Suspended As %String, ID As %Integer
SQL Query:
select Name,displaystatus,Error,Suspended,%ID from %SYS.Task Where Suspended=1 or Suspended=2
Show all Suspended tasks
query TASKMGRInfo()
Selects Version As %String, Status As %String, HistoryPurge As %String
Return information about TASKMGR parameters
query TaskDetail(ID As %Integer = "")
Selects Task Name As %String, Description As %String, Task Type As %String, Namespace As %String, TaskClass, Batch Mode As %String, Priority As %String, Suspended As %String, Reschedule on Start As %String, Run Task As %String, Run Interval As %String, Next Scheduled Date As %Date, Next Scheduled Time, Start Date As %String, End Date As %String, Last Started As %String, Last Finished As %String, Last Status As %String, Last Result As %String, %ER Date As %Date, %ER Error # As %String, ID As %Integer
SQL Query:
SELECT Name,Description,Type,NameSpace,TaskClass,IsBatch,Priority,Suspended,RescheduleOnStart, DisplayRun,DisplayInterval,DisplayDayNextScheduled,TimeNextScheduled,DisplayStartDate,DisplayEndDate,DisplayStarted,DisplayFinished,DisplayStatus,Error,DisplayErrorDate,DisplayErrorNumber,%ID FROM %SYS.Task WHERE ID=:ID
Returns details about a Task.
query TaskList()
Selects Task Name As %String, Task Type As %String, Namespace As %String, Description As %String, ID As %Integer, Suspended As %String, Last Finished As %String, Next Scheduled As %String
SQL Query:
SELECT Name,Type,Namespace,Description,%ID,Suspended,DisplayFinished,DisplayNextScheduledBrief FROM %SYS.Task
Returns a list of the task names.
query TaskListDetail()
Selects Task Name As %String, Description As %String, Task Type As %String, Namespace As %String, TaskClass As %String, Batch Mode As %String, Priority As %String, Suspended As %String, Reschedule on Start As %String, Suspend on Error As %String, Run Task As %String, Run Interval As %String, MirrorStatus As %String, Next Scheduled Date As %Date, Next Scheduled Time, Start Date As %String, End Date As %String, Last Started As %String, Last Finished As %String, Last Status As %String, Last Result As %String, %ER Date As %Date, %ER Error # As %String, ID As %Integer
SQL Query:
SELECT Name,Description,Type,NameSpace,TaskClass,IsBatch,Priority,Suspended,RescheduleOnStart,SuspendOnError, DisplayRun,DisplayInterval,MirrorStatus,DisplayDayNextScheduled,TimeNextScheduled,DisplayStartDate,DisplayEndDate,DisplayStarted,DisplayFinished,DisplayStatus,Error,DisplayErrorDate,DisplayErrorNumber,%ID FROM %SYS.Task
Returns details about all Tasks.
query TaskSchedule()
Selects Next Scheduled As %String, Task Name As %String, Last Start As %String, Last Status As %String, Last Result As %String, Suspended As %String, ID As %Integer
SQL Query:
select displaynextscheduled,name,displaystarted,displaystatus,Error,Suspended,%ID from %SYS.Task order by daynextscheduled,timenextscheduled
Show Task Schedule for all tasks
query TasksInTrouble()
SQL Query:
SELECT %ID,Name,NameSpace,Error,DisplayStatus FROM %SYS.Task WHERE (Status NOT= 1)
query ToRunQuery(DateNow As %String = +$H, TimeNow As %String = {$p($h, ",", 2)}, Running As %Boolean = 0)
SQL Query:
SELECT %ID FROM %SYS.Task Where ((RunningJobNumber is null) or (:Running=1)) and (DayNextScheduled<:DateNow or (DayNextScheduled=:DateNow and TimeNextScheduled<=:TimeNow)) ORDER BY DayNextScheduled, TimeNextScheduled
Pick up jobs which are scheduled now or in the past exclude Suspended and Leave or Jobs marked as Running (optional)
query UpcomingTasks(HoursOffset As %String = "24", ToDate As %Date = "", ToTime As %Time = "", MAXROWS=1000)
Selects ID As %String, Name As %String, Namespace As %String, Date As %Date, Time As %Time, Suspended As %Integer


index (JobGUIDIndex on JobGUID) [Unique];
Index methods: JobGUIDIndexCheck(), JobGUIDIndexDelete(), JobGUIDIndexExists(), JobGUIDIndexOpen(), JobGUIDIndexSQLCheckUnique(), JobGUIDIndexSQLExists(), JobGUIDIndexSQLFindPKeyByConstraint(), JobGUIDIndexSQLFindRowIDByConstraint()
index (RunAfterIndex on RunAfterGUID);
Index methods: RunAfterIndexExists()
index (ScheduleIndex on DayNextScheduled,TimeNextScheduled,Suspended);
Index methods: ScheduleIndexExists()

Inherited Members

Inherited Methods


Storage Model: CacheStorage (%SYS.TaskSuper)


Storage Model: CacheStorage (%SYS.TaskSuper)


Storage Model: CacheStorage (%SYS.TaskSuper)


Storage Model: CacheStorage (%SYS.TaskSuper)



FeedbackOpens in a new tab