Purpose and Scope
These coding guidelines concern the schedules/timetables topic. These are repetitive/cyclic time periods, which are associated in AIXM with the values of one or more properties of an aeronautical feature. For example, the working hours of a service, the activation times of an airspace, etc.
A schedule/timetable is a description of a series of discrete time periods, which occur cyclically within the overall validity time of a feature TimeSlice. Some examples of schedules are:
- "daily from 09:00 to 17:00"
- "every Monday and Friday from 13:00 to sunset"
- "every week from MON 07:00 till FRI 17:00, except HOL"
- etc.
AIXM supports the encoding of schedules that contain both:
- repetitive time periods, such as "daily...", "every MON...", "SAT 09:00 - SUN 19:00", etc.
- occasional occurrences, such as "on 1, 2, 15 and 25 of October", "on 1/10 09:00-15:00 and on 3/10 10:00-12:00", etc.
These coding guidelines are intended to be applied for both static data sets and dynamic data updates. However, only a subset of schedules is allowed to be used for temporary events published by NOTAM, as detailed in the OPADD document and in the Digital NOTAM Specification
AIXM Model Overview
General coding rules
This section provides the rules that are common to all schedules. For categories of schedules that are frequently encountered in aeronautical information, more specific coding rules are provided later in this document.
Identifier | Data encoding rule | Justification | Data verification rules (UID) |
|---|---|---|---|
TSH-01 | The timeReference attribute is mandatory | To avoid any doubts with regard to the applicability of the schedule, such as local time versus UTC | RULE-1A3399 |
TSH-02 | The dailightSavingAdjust is mandatory for Timesheet associated with features located in States/Territories that apply daylight saving concept. | To avoid doubts with regard to the eventual adjustment of the time values in summer. | To be developed |
TSH-03 | The dailightSavingAdjust shall be left empty and shall have nilReason="inapplicable" for Timesheet associated with features located in States/Territories that do not apply daylight saving concept. | To confirm that the times are not affected by the daylight saving concept, because it is not applicable in that area. | To be developed |
It is not allowed to combine adjustable" with SDLST/EDLST. tpo be added as rule. | Example:
| ||
TSH-04 | The day attribute is mandatory | To avoid doubts about the applicability of the schedule | RULE-1A3397 |
TSH-05 | If day has one of the values ('HOL', 'BEF_HOL', 'AFT_HOL'), then dayTill shall be either empty or have one of the values ('HOL', 'BEF_HOL', 'AFT_HOL') | Other combinations do not make sense or could lead to misinterpretations | |
TSH-06 | If day has one of the values ('WORK_DAY', 'BEF_WORK_DAY', 'AFT_WORK_DAY'), then dayTill shall be either empty or have one of the values ('WORK_DAY', 'BEF_WORK_DAY', 'AFT_WORK_DAY') | Other combinations do not make sense or could lead to misinterpretations | |
TSH-07 | If day has one of the values ('MON', 'TUE', 'WED', 'THU', 'FRI', 'BUSY_FRI', 'SAT', 'SUN'), then dayTill shall be either empty or have one of the values ('MON', 'TUE', 'WED', 'THU', 'FRI', 'BUSY_FRI', 'SAT', 'SUN') | Other combinations do not make sense or could lead to misinterpretations | |
TSH-08 | If the day attribute has one of the values 'HOL', 'BEF_HOL', 'AFT_HOL', 'WORK_DAY', 'BEF_WORK_DAY', 'AFT_WORK_DAY', 'BUSY_FRI', then the PropertiesWithSchedule shall be associated with an OrganisationAuthority and that one shall have an association with SpecialDates | To be sure which are the legal holidays to be considered for the timesheet | |
TSH-09 | If day='ANY', then dayTil shall be left empty | This will make it clear that endTime or endEvent occurs on the same day, Any other interpretation of the end time could lead to confusions | |
TSH-10 | If endTime is not specified, then endEvent must be specified | Data completeness, a timesheet without end time or end event is unclear (open ended) | |
TSH-11 | If startTime is not specified, then endEvent must be specified | Data completeness, a timesheet without start time or start event is unclear | |
TSH-12 | If both startTime and startEvent have an assigned value, then startEventInterpretation is mandatory | Otherwise it is unclear which one takes precedence | To be developed |
TSH-13 | If startEvent is not specified, then startTimeRelativeEvent should also be empty | ||
TSH-14 | If both endTime and endEvent have an assigned value, then endEventInterpretation is mandatory | Otherwise it is unclear which one takes precedence | To be developed |
TSH-15 | If endEvent is not specified, then endTimeRelativeEvent should also be empty | ||
TSH-16 | There must exist at least one Timesheet with excluded set to "NO" or unspecified (which is assumed to mean "not excluded") | It does not make sense if all Timesheets are "excluded" | |
TSH- | If dayTill is not specified, then startTime shall be before endTime. | It does not make sense to have a Timeslice such as FRI from 17:00 to 09:00 |
Common coding patterns
This section describes the most frequently encountered types of schedules used in the aeronautical information domain. Application developers might consider offering HMI templates for such situations, in order to facilitate a correct and harmonised encoding of such common schedules.
Coded value schedules
The following codes are sometimes used in aeronautical information publications and messages in order to indicate the opening hours of a facility or the operating times of a service: H24, HJ, HN, HX, HO, NOTAM
H24: shall be encoded explicitly if the service or facility is explicitly provided H24. How it is exactly encoded might remain a local decision. Recommendation: a single Timesheet with 00:00-24:00 local time (UTC +/-xx hours)
HJ: Meaning: sunrise to sunset. Recommendation: a single Timesheet with only startEvent = 'SR', endEvent = 'SS' and excluded = 'NO'. Any exceptions should be encoded with excluded = 'YES'.
HN: Meaning: sunset to sunrise. Recommendation: a single timesheet with only startEvent = SS, endEvent = SR and excluded = NO. Any exceptions should be encoded with excluded = YES.
HX: Meaning: no specific working hours. Recommendation: A note, propertyName = timeInterval, purpose = WARNING and note = HX (no specific working hours). If limited to a specific time period add timesheets with excluded = NO.
HO: Meaning: service available to meet operational requests. Recommendation: A note, propertyName = timeInterval, purpose = WARNING and note = HO (service available to meet operational requests). If limited to a specific time period add timesheets with excluded = NO.
NOTAM: Meaning: activity periods to be published by NOTAM. Recommendation: A note, propertyName = timeInterval, purpose = WARNING and note = activity periods to be published by NOTAM. If limited to a specific time period add timesheets with excluded = NO.
"Daily" schedules
This applies to schedules that occur every day during the validity period of the data, without distinction between weekdays. However, it is possible to exclude specific dates from the applicable times of the schedule. For example:
- "daily from 09:00 to 17:00"
- "daily from SR+30 min until SS or 18:00, whichever is earliest"
- "daily from 07:00 to 23:00 except for 25 Dec and 1st Jan"
The data elements that are specified for such schedules are indicated in the diagram below:
where Start_Event and End_Event are detailed in the following diagrams:
The graphical elements included in this diagram have the meaning explained in the following table:
Item | Coding | Comments |
|---|---|---|
[TS] and [/TS] | All the elements that appear between [TS] and [/TS] are encoded as a single timesheet | |
start date | Timesheet.startDate | |
end date | Timesheet.endDate | |
start time | Encoded as Timesheet.startTime | |
start event | Encoded as Timesheet.startEvent | |
rel. start | Encoded as Timesheet.startTimeRelativeEvent | Positive values indicate that the actual start time is after the event. |
switch | Encoded as startTimeRelativeEvent | Indicates which one takes precedence between the start/end time and the start/end event (including the eventual time relative to the event) |
end time | Encoded as Timesheet.endTime | |
end event | Encoded as Timesheet.endEvent | |
rel. end | Encoded as Timesheet.sendTimeRelativeEvent | Positive values indicate that the actual end time is after the event. |
note | Encoded as Timesheet.annotation | Examples of such notes: |
excluded date | Encoded as a separate Timesheet with excluded="YES", startDate equal to endDate equal to the "excluded date" value, day='ANY', startTime='00:00' endTime='24:00', timeReference='UTC+/-X' (local time as UTC zone). | |
schedule note | Encoded as Note associated with the class that owns the schedule, with propertyName='timeInterval' and purpose='REMARK'. |
"Weekday" schedules
This applies to schedules that occur with a weekly pattern, during the validity period of the data. It is possible to specify both individual weekdays (MON, TUE, etc.) and weekday ranges (from FRI 17:00 to MON 07:00). It is possible to exclude specific dates or special days (such as holidays) from the applicable times of the schedule. For example:
- "MON, TUE, WED, THU, FRI from 13:00 to sunset; SAT, SUN. from 13:00 to 15:00"
- "SUN, 2300 (2200) to MON, 0500 (0400)"
- "MON to FRI, 09:00 to 17:00, excluding HOL"
The data elements that are specified for such schedules are indicated in the following diagram:
where Start_Event and End_Event are detailed in the following diagrams:
The graphical elements included in this diagram have the meaning explained in the following table:
Item | Coding | Comments |
|---|---|---|
[TS] and [/TS] | All the elements that appear between [TS] and [/TS] are encoded as a single timesheet | |
start date | Timesheet.startDate | |
end date | Timesheet.endDate | |
on weekday | Encoded as Timesheet.day | Any weekday values is allowed, including HOL |
from weekday | Encoded as Timesheet.day | Any weekday values is allowed, including HOL |
to weekday | Encoded as Timesheet.dayTill | Any weekday values is allowed, including HOL |
start time | Encoded as Timesheet.startTime | |
start event | Encoded as Timesheet.startEvent | |
rel. start | Encoded as Timesheet.startTimeRelativeEvent | Positive values indicate that the actual start time is after the event. |
switch | Encoded as startTimeRelativeEvent | Indicates which one takes precedence between the start/end time and the start/end event (including the eventual time relative to the event) |
end time | Encoded as Timesheet.endTime | |
end event | Encoded as Timesheet.endEvent | |
rel. end | Encoded as Timesheet.sendTimeRelativeEvent | Positive values indicate that the actual end time is after the event. |
note | Encoded as Timesheet.annotation | Examples of such notes: |
excluded date | Encoded as a separate Timesheet with excluded="YES", startDate equal to endDate equal to the "excluded date" value, day='ANY', startTime='00:00' endTime='24:00', timeReference='UTC+/-X' (local time as UTC zone). | |
excluded day | Encoded as a separate Timesheet with excluded="YES", day equal to the "excluded day" value, startTime='00:00' endTime='24:00', timeReference='UTC+/-X' (local time as UTC zone). | It does not make sense to use the normal days of the week in this case, only 'HOL', 'BEF_HOL', 'AFT_HOL', 'WORK_DAY', 'BEF_WORK_DAY', 'AFT_WORK_DAY', 'BUSY_FRI' make sense here |
schedule note | Encoded as Note associated with the class that owns the schedule, with propertyName='timeInterval' and purpose='REMARK'. |
Examples
Use the following document for examples: AIXM Coding - Schedules - Examples.xlsx