Task Schedule View

Use to create and modify TaskSchedule objects.

This view contains the following attributes:

Table 3–69 Task Schedule View Attributes

Name	Editable?	Data Type	Required?
scheduler	Read/Write	String
task	Read/Write	Boolean

scheduler

Contains attributes that are related to the scheduler itself, which are common to all scheduled tasks. The attributes are:

Table 3–70 Attributes of scheduler Attribute (Task Schedule View)

Name	Editable?	Data Type	Required?
name	Read/Write	String	No
id	Read	String	No
definition	Read/Write	String	No
template	Read/Write	String	No
taskOrganization	Read/Write	String	No
taskName	Read/Write	String	No
description	Read/Write	String	No
disabled	Read/Write	Boolean	No
skipMissed	Read/Write	Boolean	No
start	Read/Write	Date	No
repeatCount	Read/Write	Int	No
repeatUnit	Read/Write	String	No
resultOption	Read/Write	String	No
allowMultiple	Read/Write	Boolean	No

---

Note –

Typically, you supply a value for either scheduler.definition or scheduler.template. If you do not specify either value, Waveset creates a TaskSchedule object that you can later edit to specify the definition or template.

---

name

Specifies the name of an existing TaskSchedule object or the desired name for a new TaskSchedule object. It is not required, but if not specified, the system will generate a random identifier.

id

Uniquely identifies the existing TaskSchedule object.

definition

Defines the name a TaskDefinition object to be scheduled.

template

Specifies the name of a TaskTemplate object to be scheduled. If both definition and template are specified, template has priority.

taskOrganization

Contains the name of the organization in which the TaskInstance will be placed when the schedule task is launched.

taskName

Specifies the name of the TaskInstance that is created when the schedule task is launched.

description

Contains descriptive text that will be saved in the TaskInstance that will be created when the schedule task is launched. The description will appear in the task tables in the product interface.

disabled

Controls whether the task scheduler will process the TaskSchedule object. The scheduler ignores TaskSchedule’s whose disable attribute is true. You can use this to temporarily stop running a schedule task, without having to delete and recreate the TaskSchedule object.

start

Indicates the date and time at which to launch the task.

repeatCount

Combined with repeatUnit, determines how frequently tasks will be run. If repeatCount is zero or not specified a scheduled task will only run once. If repeatCount is a positive number, the task will be run more than once at the interval specified by repeatUnit.

repeatUnit

Defines the interval of time between running tasks that have a positive repeatCount value. Valid values include: second, minute, hour, day, week, month. For example, to schedule a task to run once a week for a year set repeatUnit to week, repeatCount to 52, and start to the first day that the task is to run.

resultOption

Specifies what the scheduler will do if a TaskInstance with the desired name already exists when the scheduled task is run. The possible values are: wait, delete, rename, and terminate.

wait

Indicates whether the scheduler should run the task again or wait for another repetition. This attribute is only meaningful if you have set repeatCount and repeatUnit.

delete

Tells the scheduler to delete the existing TaskInstance, if it has finished.

rename

Indicates that the scheduler should rename the existing TaskInstance, if it has finished.

skipMissed

Indicates whether Waveset attempts to immediately make up a missed schedule time (false) or simply wait until the next scheduled time (true).

When set to false, Waveset immediately attempts to make up a missed schedule time. When set to true, Waveset instead waits until the next scheduled time. The default is false.

terminate

Similar to delete, but will also terminate the existing task, if it is still running.

allowMultiple

Controls whether more than one instance of the same task definition or task template are allowed to run. If true (the default), the scheduler will always create a new instance of the task. If false, the scheduler will not create a new instance if there is one already running.

task

Contains task-specific attributes. Each task defines its own attributes, and the task’s form should reference them relative to the task namespace.