Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Guidance
Examples
See the Operational Needs section within the Donlon TOBT Setting Service Description.
Guidance for JSON service description
UNDER WORK
JSON Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
JSON Guidance
Within field operationalNeed (itself within field "informationService" field serviceGeneralDescription) fill in one or more occurrences of type OperationalNeed.
Operational Need - Mandatory
attribute name | description | type | rule | guidance |
---|---|---|---|---|
provider | The full official name of the organisation. [SWIM-SERV-008] | string | Mandatory | Rationale: Knowing the service provider is essential to business experts. Guidance: Provide the name of the organisation responsible for the service |
providerDescription | Description of the organisational unit responsible for the service. [SWIM-SERV-008] | string | Mandatory | Guidance: Provide a small description of the organisation and/or the unit responsible for the service Note: Consider including information on provider certification when relevant for the service being described (e.g. for a Meteorological service). |
providerType | The type of service provider. | CodeStakeholderType | Mandatory, minItems=1 | Guidance: Select one or more code values |
dateInOperation | Date at which the service version went into operation (or is planned to become operational.) | string | Mandatory, format is "yyyy-mm-dd" | Guidance: Provide the date at which this service version became operational. Note: The date at which the service became operational for the first time may be mentioned in the service abstract. |
serviceSupport | Provision of material and guidance necessary for the use of the information service. | string | Optional | A description of the support a provider is offering to consumers on all relevant aspects related to the information service. Rationale: Consumer needs will vary and may require different levels of provider support. Guidance: Specify days and hours the information service provider can be contacted by users requiring support for the provided service. |
pointOfContact | A person or group within the service provider organization, suitable for making a human contact for any purpose. [SWIM-SERV-008] | PointOfContact | Mandatory, minItems=1 | Provide one or more points of contact where additional information can be obtained, including name, contact information and role. |
JSON example
"serviceGeneralDescription": { "operationalNeed": [ { "name": "Operational and Business context", "description": "The context is the Airport Collaborative Decision Making (A-CDM) concept as defined in Airport CDM Implementation Manual v4. In A-CDM it is important to allow A-CDM Partners to set the value of some milestones when necessary. The classical example is to allow the Aircraft Operator or the Ground Handler to set the Target Off-Block Time (TOBT) that indicates what is the target time for the aircraft to be ready for off-block. Setting the TOBT value is possible at many stages during the A-CDM process, as early as Milestone 2 (EOBT-2hr) up to and including Milestone 11 (Boarding starts).\n\r The Business Logic may involve validations such as: not accepting values in the past; not accepting a new value too close the existing one (there is a minimum change involved); Limiting the number of changes after TSAT has been issued." }, { "name": "Information Exchange Requirements", "description": "The service is defined to satisfy two IERs, which were derived from the A-CDM Implementation Manual :\r\n[IER1] To allow the Aircraft Operator or Ground Handler to set, update or delete the value of the Target Off-Block Time of a departing flight. This is done in accordance with the operations involving Target Off-Block Time that take place between A-CDM Milestones 2 and 11 (derived from: Airport CDM Implementation Manual v4)\r\n[IER2] To allow the competent authority to set the value of the Target Off-Block Time for a given aircraft in specific circumstances. In other words, under adverse conditions or special circumstances this service allows the competent authorities to set the Target Off-Block Time value of the flight. (derived from: Airport CDM Implementation Manual v4)." } ], ... }
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.