GDS Date Event Object
Middle East & Asia Globe
Blue Marble
World Map

Goto: Documentation Home

This object defines a date event, such as an anniversary or important event in time.

This object isn't directly supplied by GDS, but used by packages that may wish to implement a standardised view of a "time-event".

Goto: General | Scheduling

General Fields

f500string/dateThe date of repeating event where exact. This field should not include year. Example. "25/Dec" for Christmas.
f501stringBrief description of this date event. While the length of this field is not defined, it is expected to be less than 30 characters so that it can be used for mouseovers.
f502stringDescription of this date event. If not present the field f501 will be returned.
f503date/timeStart Date/time of the event
f504date/timeEnd Date/time of the event

Scheduling Fields

These fields are defined for systems that might be creating events that are repeating in a regular form. There are several methods for defining this scheduling and repitition reflecting the multiple of needs for different environments.

f800numberDOW Mask. Bitfield Day of Week mask field. 1=Monday, bit-2=Tuesday 4=Wednesday 8=Thursday 16=Friday 32=Saturday 64=Sunday. Therefore a value of 65 means Monday and Sunday
f810?Run Window Start. Defines the beginning window when a task can commence.
f811?Run Window End. Defines the end window when a task can commence.
f812?Run Window Start Exclusion. Defines the start of a period inside the time window where a task cannot run
f813?Run Window End Exclusion. Defines the start of a period inside the time window where a task cannot run

Fields 810-813 can be used to define "run windows", as illustrated with the following examples

9:0017:00Task can run between 9am and 5pm
9:0017:0012:0014:00Task can run between 9am and 5pm, but not between noon and 2pm.
2:0023:00Task can run between 11pm and 2am. That is, it can run at all times except the window 2am through to 11pm