schedule

Container Information

Contained by instances of the following classes

• bibus » baseAgentDefinition

• bibus » baseDataIntegrationTask

• bibus » baseDataMovementTask

• bibus » basePowerPlay8Report

• bibus » baseReport

• bibus » contentTask

• bibus » exportDeployment

• bibus » importDeployment

• bibus » indexUpdateTask

• bibus » jobDefinition

• bibus » migrationTask

• bibus » planningMacroTask

• bibus » planningTask

• bibus » queryServiceTask

Properties

This class has the following properties.

active

Specifies whether the schedule is active. Inactive schedules do not trigger events.

This property

• is of type boolean

  is encoded as type tns:booleanProp

• is searchable

credential

Refers to the credential for the schedule. Allows for automated logon so that the job can run at the scheduled time.

This property

• is an array of type bibus » baseClass

  has items that must be of class bibus » credential

  is encoded as type tns:baseClassArrayProp

• refers to other objects in the content store using an id-based search path

• must have at most 1 item

dailyPeriod

Specifies the unit of time used by the bibus » schedule » everyNPeriods property.

This property

• is of type bibus » scheduleDailyPeriodEnum

  is encoded as type tns:nmtokenProp

endDate

Specifies the date and time after which no occurrences of the task will take place, in Coordinated Universal Time (UTC).

This property

• is of type dateTime

  is encoded as type tns:dateTimeProp

endType

Specifies how the date for the last occurrence of the task is determined.

This property

• is of type bibus » scheduleEndTypeEnum

  is encoded as type tns:nmtokenProp

everyNPeriods

Specifies the number of periods between task occurrences. Use with the bibus » schedule » dailyPeriod property to schedule repeating tasks.

For example, to run a task every five days, set the bibus » schedule » everyNPeriods property to the value 5, and the bibus » schedule » dailyPeriod property to the value day.

This property

• is of type positiveInteger

  is encoded as type tns:positiveIntegerProp

intradayRecurrenceEnd

Specifies the end time of the intraday recurrence window.

The task associated with the schedule will continue running in the recurrence window according to the value specified by the bibus » schedule » intradayRecurrenceInterval property until the time specified by this value is reached. If the last recurrence occurs before the value specified by the bibus » schedule » intradayRecurrenceEnd property is reached, the schedule will not fire again at that time.

This property is only used if the bibus » schedule » type property is set to one of the following values:

1. bibus » scheduleTypeEnum » dailyWithIntradayRecurrence

2. bibus » scheduleTypeEnum » monthlyAbsoluteWithIntradayRecurrence

3. bibus » scheduleTypeEnum » monthlyRelativeWithIntradayRecurrence

4. bibus » scheduleTypeEnum » weeklyWithIntradayRecurrence

5. bibus » scheduleTypeEnum » yearlyAbsoluteWithIntradayRecurrence

6. bibus » scheduleTypeEnum » yearlyRelativeWithIntradayRecurrence

This property

• is of type time

  is encoded as type tns:timeProp

New in Version 10.1.0 — Flexible Scheduling

This property was added.

Related information:

Using Intraday Scheduling

intradayRecurrenceInterval

Specifies the time interval between occurences of the intraday recurrence window.

This property is only used if the bibus » schedule » type property is set to one of the following values:

1. bibus » scheduleTypeEnum » dailyWithIntradayRecurrence

2. bibus » scheduleTypeEnum » monthlyAbsoluteWithIntradayRecurrence

3. bibus » scheduleTypeEnum » monthlyRelativeWithIntradayRecurrence

4. bibus » scheduleTypeEnum » weeklyWithIntradayRecurrence

5. bibus » scheduleTypeEnum » yearlyAbsoluteWithIntradayRecurrence

6. bibus » scheduleTypeEnum » yearlyRelativeWithIntradayRecurrence

This property

• is of type duration

  is encoded as type tns:durationProp

New in Version 10.1.0 — Flexible Scheduling

This property was added.

Related information:

Using Intraday Scheduling

intradayRecurrenceStart

Specifies the start time of the intraday recurrence window.

The task associated with the schedule will run at the specified time on the appropriate day, and run as often as specified by the bibus » schedule » intradayRecurrenceInterval property until the value specified by the bibus » schedule » intradayRecurrenceEnd property is reached.

This property is only used if the bibus » schedule » type property is set to one of the following values:

1. bibus » scheduleTypeEnum » dailyWithIntradayRecurrence

2. bibus » scheduleTypeEnum » monthlyAbsoluteWithIntradayRecurrence

3. bibus » scheduleTypeEnum » monthlyRelativeWithIntradayRecurrence

4. bibus » scheduleTypeEnum » weeklyWithIntradayRecurrence

5. bibus » scheduleTypeEnum » yearlyAbsoluteWithIntradayRecurrence

6. bibus » scheduleTypeEnum » yearlyRelativeWithIntradayRecurrence

This property

• is of type time

  is encoded as type tns:timeProp

New in Version 10.1.0 — Flexible Scheduling

This property was added.

Related information:

Using Intraday Scheduling

monthlyAbsoluteDay

Specifies the day in the month that the task occurs, such as 1 for the first day of the month.

This property

• is of type positiveInteger

  is encoded as type tns:positiveIntegerProp

• must contain a value less than or equal to 31

monthlyRelativeDay

Specifies the weekday that the task occurs each month, such as monday.

Use with monthlyRelativeWeek to specify the week and the day for a monthly schedule.

This property

• is of type bibus » daysEnum

  is encoded as type tns:nmtokenProp

monthlyRelativeWeek

Specifies the week of the month that the task occurs.

Use with monthlyRelativeDay to specify the day and the week for a monthly schedule.

This property

• is of type bibus » weeksEnum

  is encoded as type tns:nmtokenProp

options

Contains the set of options for this object.

Options can also be specified in other locations. For more information, see Specifying Options and Parameters.

This property

• is an array of type bibus » option

  is encoded as type tns:optionArrayProp

parameters

Contains the set of execution parameter values for this object.

Parameter values can also be specified in other locations. For more information, see Specifying Options and Parameters.

This property

• is an array of type bibus » parameterValue

  is encoded as type tns:parameterValueArrayProp

periodicalProducer

Specifies the producer of the output used to process subscriptions.

This property

• is an array of type bibus » baseClass

  has items that must be of class bibus » baseReport

  is encoded as type tns:baseClassArrayProp

• refers to other objects in the content store using an id-based search path

• must have at most 1 item

priority

Specifies the schedule priority. Higher priority tasks run before lower priority tasks. Priority values range from 1 to 5. 1 is the highest priority; 5 is the lowest.

This property

• is of type int

  is encoded as type tns:intProp

• has a default value of 3

• must contain a value greater than or equal to 1

• must contain a value less than or equal to 5

• is searchable

New in Version 8.3 — Schedule Priority

This property was added.

New in Version 10.1.0 — Documentation Updates

This topic now accurately describes the priority rules.

startDate

Specifies the date when the first occurrence of the task will take place, in Coordinated Universal Time (UTC).

This property

• is of type dateTime

  is encoded as type tns:dateTimeProp

taskID

Contains the ID of the task, as identified in the schedule and delivery service.

This property

• is of type token

  is encoded as type tns:tokenProp

• is read-only

• must contain exactly 45 characters

• must contain exactly 45 ASCII letters or digits; the letters can be uppercase or lowercase

timeZoneID

Specifies the time zone ID used in the schedule, in accordance with the ICU standard. If no ID is provided, the scheduling service uses the time zone of the server.

This property

• is of type string

  is encoded as type tns:stringProp

• can contain at least 255 characters

triggerName

Specifies the name of the external occurence that initiates execution of this schedule.

If the schedule is contained by an bibus » authoredReport object, the value of this property is set to the value of the bibus » authoredReport » triggerName property from that bibus » authoredReport object when it is set.

If the schedule is contained by a bibus » reportView object, the value of this property is set to the value of the bibus » authoredReport » triggerName property from the bibus » authoredReport object referenced by that bibus » reportView object (see the bibus » reportView » base property) when it is set.

In either of these cases, if the bibus » authoredReport » triggerName property for the associated bibus » authoredReport object has not been set, this property can be set independently.

If you require multiple external occurrences or conditions to trigger the execution of an object, you must manage this in the application you use to call the event » trigger(triggerName) method.

This property

• is of type string

  is encoded as type tns:stringProp

• can contain at least 255 characters

• is searchable

type

Specifies the type of schedule.

This property

• is of type bibus » scheduleTypeEnum

  is encoded as type tns:nmtokenProp

weeklyFriday

Specifies whether the task occurs each Friday.

This property

• is of type boolean

  is encoded as type tns:booleanProp

weeklyMonday

Specifies whether the task occurs each Monday.

This property

• is of type boolean

  is encoded as type tns:booleanProp

weeklySaturday

Specifies whether the task occurs each Saturday.

This property

• is of type boolean

  is encoded as type tns:booleanProp

weeklySunday

Specifies whether the task occurs each Sunday.

This property

• is of type boolean

  is encoded as type tns:booleanProp

weeklyThursday

Specifies whether the task occurs each Thursday.

This property

• is of type boolean

  is encoded as type tns:booleanProp

weeklyTuesday

Specifies whether the task occurs each Tuesday.

This property

• is of type boolean

  is encoded as type tns:booleanProp

weeklyWednesday

Specifies whether the task occurs each Wednesday.

This property

• is of type boolean

  is encoded as type tns:booleanProp

yearlyAbsoluteDay

Specifies the day in the month that the task occurs, such as 28 for the twenty-eighth day of the month.

Use with yearlyAbsoluteMonth to specify the day and the month for a yearly schedule.

This property

• is of type positiveInteger

  is encoded as type tns:positiveIntegerProp

• must contain a value less than or equal to 31

yearlyAbsoluteMonth

Specifies the month that the task occurs each year, such as june.

Use with yearlyAbsoluteDay to specify the month and the day for a yearly schedule.

This property

• is of type bibus » monthsEnum

  is encoded as type tns:nmtokenProp

yearlyRelativeDay

Specifies the weekday that the task occurs each year, such as friday.

Use with yearlyRelativeWeek and yearlyRelativeMonth to specify the week, the month, and the day for a yearly schedule.

This property

• is of type bibus » daysEnum

  is encoded as type tns:nmtokenProp

yearlyRelativeMonth

Specifies the month that the task occurs each year, such as july.

Use with yearlyRelativeWeek and yearlyRelativeDay to specify the month, the week, and the day for a yearly schedule.

This property

• is of type bibus » monthsEnum

  is encoded as type tns:nmtokenProp

yearlyRelativeWeek

Specifies the week of the month that the task occurs each year.

Use with yearlyRelativeDay and yearlyRelativeMonth to specify the month, the day, and the week for a yearly schedule.

This property

• is of type bibus » weeksEnum

  is encoded as type tns:nmtokenProp