Timer Task Properties

Task Properties: Timer Task

Property

UI Field Name

Description

Specifications

Required

sleepAmount

Timer Duration in Seconds

If sleepType is Seconds; Number of seconds the Timer task will run.


N

sleepDayConstraint

Timer Day Constraint

If sleepType is Time or Relative Time; Specification for whether or not to advance the timer to another day.

Valid values:

  • As String = None, As Value = 0
  • As String = Same Day, As Value = 1
  • As String = Next Day, As Value = 2
  • As String = Next Business Day, As Value = 3
  • As String = Sunday, As Value = 4
  • As String = Monday, As Value = 5
  • As String = Tuesday, As Value = 6
  • As String = Wednesday, As Value = 7
  • As String = Thursday, As Value = 8
  • As String = Friday, As Value = 9
  • As String = Saturday, As Value = 10

Default is None (0).

N

sleepDuration

Timer Duration

If sleepType is Duration; Number of days, hours, minutes, and/or seconds the Timer task will run.

Format: dd:hh:mm:ss

N

sleepTime

Timer Time

If sleepType is Time or Relative Time; Time of day that the Timer task should go to a completed status.

24-hour time format.
Default is 00:00.

N

sleepType

Timer Type

Type of Timer command to execute.

Valid values:

  • As String = Time, As Value = 1
  • As String = Duration, As Value = 2
  • As String = Seconds, As Value = 3
  • As String = Relative Time, As Value = 4

Default is Seconds (3).

N