Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Info | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
This template allows for the documentation of service definitions based on the requirements found at: /wiki/spaces/SCOI/pages/59605116 General requirements to remember:
|
Table of Contents | ||||
---|---|---|---|---|
|
Info | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
|
Service Definition Identification
Status | ||
---|---|---|
|
Info | ||
---|---|---|
| ||
service definition identification | title | Service definition for the Quantitative Volcanic Ash Information Subscription and Request Service |
---|---|---|
edition | 00.00.02 | |
reference date | 2024-04-03 |
Service Identification
Status | ||
---|---|---|
|
Info | ||
---|---|---|
| ||
service identification | service name | Quantitative Volcanic Ash Information Subscription and Request Service |
---|
Service Abstract
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
service abstract | The Quantitative Volcanic Ash Information Subscription and Request Service allows the service consumer to get quantitative volcanic ash information in accordance with ICAO Annex 3 Amdt 82 and PANS-MET. The service consumer can subscribe to the service to receive a warning when a new significant ash cloud occurs. It is also possible to send a direct request, using a request-reply mechanism, to the service to get the relevant quantitative volcanic ash information. The meteorological information is issued by the designated Volcanic Ash Advisory Centre (VAAC). The meteorological information is only intended to be used by service consumers within the aviation domain. |
---|
Service Definition Provider
Status | ||
---|---|---|
|
Info | ||
---|---|---|
| ||
service definition provider | name | EUROCONTROL |
---|---|---|
description | EUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States. | |
point of contact | swim@eurocontrol.int |
Geographical Extent of Information
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
geographical extent of information | The service shall offer quantitative volcanic ash information resulting from volcanic eruptions occurring in the service provider's area of responsibility. The service shall offer the equivalent quantitative volcanic ash information for the areas of responsibility for which the service provider acts as back-up during outages. Note: The back-up arrangements are based on mutual agreements between service providers. TBD: Check air navigation plan for the back-ups. Note: the ash cloud may extend beyond the area of responsibility. |
---|
Service Categories
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-095, SWIM-DEFN-100 |
service categories | category | category name | regulated information exchange |
---|---|---|---|
value | |||
scheme | |||
category | category name | information domain | |
value | METEOROLOGICAL_INFORMATION | ||
scheme | https://reference.swim.aero/information-services/service-categories/CodeInformationDomainType.html | ||
category | category name | business activity | |
value | |||
scheme | http://reference.swim.aero/information-services/service-categories/CodeBusinessActivityType.html | ||
category | category name | intended service consumer | |
value | |||
scheme | https://reference.swim.aero/information-services/service-categories/CodeStakeholderType.html | ||
category | category name | intended service provider | |
value | |||
scheme | http://reference.swim.aero/information-services/service-categories/CodeStakeholderType.html | ||
category | category name | service type | |
value |
| ||
scheme | http://reference.swim.aero/information-services/service-categories/CodeServiceType.html |
Service Standard Reference
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-120 |
Info | ||
---|---|---|
| ||
This field is left empty. It is expected that the service definition developed in Europe by MET3SG will reference any ICAO-level information service definition. |
service standard reference | reference | |
---|---|---|
implemented options | ||
deviations/additions |
Operational Environment
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-130 |
operational environment | operational needs | Quantitative volcanic ash (QVA) concentration information will be provided by designated volcanic ash advisory centres (VAAC) as part of the International Civil Aviation Organization’s (ICAO) International Airways Volcano Watch (IAVW). It provides a high-resolution four-dimensional representation of a volcanic ash cloud based on 3-hourly timesteps. The information is intended for use in operator’s flight planning and decision support systems allowing, e.g., more efficient routes in accordance with their safety management programme during significant volcanic ash cloud events. | |
---|---|---|---|
capabilities | The service provides high quality, up-to-date, trusted, regulated meteorological information in digital form for use by service consumers within the aviation domain. | ||
information exchange requirements | The service takes into account the following information exchange requirements:
|
Service Functions
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-140 |
service functions | function | name | Request quantitative volcanic ash information |
---|---|---|---|
description | The service consumer shall be able to request quantitative volcanic ash information filtered by erupting volcano number,forecast timesteps and logical (e.g. severity threshold) operators. | ||
real-world effect | The meteorological information is received and can be used in ATM and other systems. | ||
function | name | Request the information in a specific format | |
description | The service consumer shall be able to request that the quantitative volcanic ash information be returned as IWXXM polygons, deterministic gridded data and/or probabilistic gridded data. | ||
real-world effect | The meteorological information is received in the specified format and can be used in ATM and other systems. | ||
function | name | Subscribe to quantitative volcanic ash information | |
description | The service consumer shall be able to subscribe/unsubscribe in order to receive information when a significant volcanic ash cloud occurs. | ||
real-world effect | The service consumer subscribes to information offered by the service. | ||
function | name | Distribute warning | |
description | The service shall distribute a warning detailing how to access the quantitative volcanic ash information when a significant volcanic ash cloud occurs. | ||
real-world effect | The service consumer is sent a warning. |
Service Access and Use Conditions
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-150 |
service access and use conditions | legal constraints | ||
---|---|---|---|
service policies | business policy | It shall be made clear to new service consumers that they must also enter an agreement with the back-up VAACs in case they need to revert to the back-up. | |
operational policy | There shall be a service policy to ensure that only service consumers within the aviation domain can use the service. The service policy shall include a requirement that service consumers cannot pass the information obtained from the service to non-aviation users without prior authorisation from the service provider. | ||
technical policy | |||
service consumption constraints | There shall be a service consumption constraint to ensure that a service consumer does not impose undue loads on computer and network resources, for example, by polling it at a higher frequency than the status is normally provided. |
Security Constraints
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-160 |
security constraints | authentication | The service shall ensure consumer authentication in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile requirement SWIM-TIYP-0042. The service shall ensure provider authentication in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile requirement SWIM-TIYP-0042. |
---|---|---|
authorisation | The service shall ensure that satisfactory authorisation is put in place in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile requirement SWIM-TIYP-0070. | |
confidentiality | The service shall ensure point-to-point confidentiality in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of Transport Layer Security (TLS) 1.2 or above. | |
integrity | The service shall ensure point-to-point integrity in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of Transport Layer Security (TLS) 1.2 or above. |
Quality of Service
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-180 |
quality of service | performance | capacity | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. The service should ensure that a single user is unable to monopolise a service or to degrade it below agreed service levels for others users. |
---|---|---|---|
response time | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. | ||
reliability | availability | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. Note: the following factors must be used in deciding the fitness for purpose:
| |
recoverability | The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. | ||
security | confidentiality | The service shall ensure confidentiality by using SWIM Technical Infrastructure (TI) Yellow Profile bindings. | |
integrity | The service shall ensure integrity by using SWIM Technical Infrastructure (TI) Yellow Profile bindings. |
Quality of Data
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-185 |
quality of data | The quality of quantitative volcanic ash information offered by the service shall be verified be the service provider. The quantitative volcanic ash information offered by the service shall be reported to and overseen by the MET Panel IAVW MOG. |
---|
Source of Information
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-190 |
source of information | source | The service provider shall ensure that the quantitative volcanic ash information offered by the services is based on data received from the appropriate authorised originating sources. This includes:
|
---|---|---|
modifications | Note: atmospheric modelling techniques are used to generate the output. |
Service Validation Information
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-200 |
Info | ||
---|---|---|
| ||
This field is left empty. |
service validation information | description |
---|
Application Message Exchange Pattern
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-210 |
application message exchange pattern |
---|
Service Behaviour
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-220 |
service behaviour | typical behaviour | The service behaviour shall be in accordance with the patterns detailed in the Message Exchange Patterns: Identification Guidelines. The interfaces have different behaviour. A combination of an AMQP 1.0 implementation and an OGC implementation shall be used for the basic behaviour. The typical behaviour for PUBLISH_SUBSCRIBE means that:
The typical behaviour for REQUEST_REPLY (as used in Quantitative Volcanic Ash Information Subscription and Request Service Request Interface) is as follows: Synchronous Request/Reply
Asynchronous Request/Reply
|
---|
Service Monitoring
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-230 |
service monitoring | A service monitoring mechanism should be made available to service consumersand alert them when the service is unavailable so that they can switch to the back-up service. |
---|
Service Interfaces
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-240 |
service interfaces | interface | name | Quantitative Volcanic Ash Information Subscription and Request Service Request Interface |
---|---|---|---|
description | Allows the service consumer to request filtered quantitative volcanic ash information. Note: This interface is used to group the operations offered by the chosen OGC standard. | ||
provider/consumer side | Provider side | ||
interface | name | Quantitative Volcanic Ash Information Subscription and Request Service Subscription Interface | |
description | Allows the service consumer to subscribe to warnings. It allows the service consumer to manage the subscriptions e.g. to unsubscribe. Note: This may be handled by a separate dedicated subscription service. Note: This is an optional interface. Many service providers will prefer to receive subscription requests by email. | ||
provider/consumer side | Provider side | ||
interface | name | Quantitative Volcanic Ash Information Subscription and Request Service Distribution Interface | |
description | Allows the service provider to distribute warnings when a new significant ash cloud occurs meeting the need of the service consumer that has subscribed for updates. | ||
provider/consumer side | Consumer side |
SWIM TI Profile and Interface Bindings
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-250, SWIM-DEFN-255 |
Quantitative Volcanic Ash Information Subscription and Request Service Request Interface
SWIM TI profile and interface bindings | profile name | EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile |
---|---|---|
profile version | 1.1 | |
selected service interface binding | WS_LIGHT | |
selected network interface binding | The service shall use the network bindings of the SWIM TIYP. | |
description | The interface shall use at least one of the following OGC standards:
Note: It is expected that the service will implement the OGC API – Environmental Data Retrieval Standard by November 2026. |
Quantitative Volcanic Ash Information Subscription and Request Service Subscription Interface
SWIM TI profile and interface bindings | profile name | EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile |
---|---|---|
profile version | 1.1 | |
selected service interface binding | ||
selected network interface binding | The service shall use the network bindings of the SWIM Technical Infrastructure (TI) Yellow Profile. | |
description |
Quantitative Volcanic Ash Information Subscription and Request Service Distribution Interface
SWIM TI profile and interface bindings | profile name | EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile |
---|---|---|
profile version | 1.1 | |
selected service interface binding | SWIM_TI_YP_1_1_AMQP_MESSAGING | |
selected network interface binding | The service shall use the network bindings of the SWIM TIYP. | |
description | AMQP 1.0 shall be used to distribute messages as explained in the Publish/Subscribe Push MEP: Implementation Guidance. |
Service Interface Protocols and Data Format
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-260 |
service interface protocols and data format | transport / messaging protocols | The service shall use TLS1.2 or later in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile. | |
---|---|---|---|
data format |
|
Service Operations
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-270 |
Quantitative Volcanic Ash Information Subscription and Request Service Request Interface
Info | ||
---|---|---|
| ||
The OGC Web Feature Service 2.0 Interface Standard is used to implement the service operations. It is not the intention to repeat the standardised operations here. However, the table below illustrates how the GetFeature operation would look in the context of this service. |
Service operations | operation | operation name | GetFeature |
---|---|---|---|
description | The GetFeature operation returns a selection of features from a data store. It responds to a GetFeature Request message with a Quantitative Volcanic Ash Information Message that satisfies the query expressions specified in the request. | ||
messages | Request, Quantitative Volcanic Ash Information Message |
Quantitative Volcanic Ash Information Subscription and Request Service Subscription Interface
Service operations | reference | url | Meteorological SWIM Services Subscription Interface Standard |
---|---|---|---|
description | The standard operations for subscription and subscription management. The following operation shall be implement at a minimum:
|
Quantitative Volcanic Ash Information Subscription and Request Service Distribution Interface
Service operations | operation | operation name | publish |
---|---|---|---|
description | This operation allows the service provider to publish Quantitative Volcanic Ash Information Warning to service consumers based on their subscriptions. | ||
messages | Quantitative Volcanic Ash Information Warning |
Service Messages
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
The OGC Web Feature Service 2.0 Interface Standard details the basic messages such as request and response messages. It is not the intention to repeat the standardised messages here. The table below provides extra details for the Quantitative Volcanic Ash Information Message. |
Info | ||
---|---|---|
| ||
SWIM-DEFN-280 |
service messages | message | name | Quantitative Volcanic Ash Information Message |
---|---|---|---|
description | The output message containing thequantitative volcanic ash information. | ||
direction | Out | ||
data format | QVA information will be provided in two file formats:
Note: a common file name conventionjust gives the concentration - there is no assignment to low, medium, etcnaming convention may be considered. | ||
message | name | Request | |
description | Request message submitted to the service containing query expressions for the WFS GetFeature operation or the EDR HTTP GET operation and the required data format for the Quantitative Volcanic Ash Information Message. | ||
direction | In | ||
data format | JSON and/or XML | ||
message | name | Quantitative Volcanic Ash Information Warning | |
description | The alert and way to access the Quantitative Volcanic Ash Information Message. | ||
direction | Out | ||
data format | JSON and/or XML | ||
reference | url | Meteorological SWIM Services Subscription Interface Standard | |
description | The standard messages for subscription and subscription management. |
Information Definition (Minimum) and (Extended)
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
information definition | The service shall offer information in accordance with the IWXXM QVA schema for feature collections and . The service shall offer information in accordance with the NetCDF 4 specification for gridded data. Note: the IWXXM QVA schema is expected to be included in the 2025-2 IWXXM release. It is expected to provide the structure for the volcanic ash cloud, the volcano and concentration according to expected threshold values of 0.2+, 2+, 5+, 10+ mg/m3. |
---|
Filter Encoding
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
filter encoding | The Quantitative Volcanic Ash Information Subscription and Request Service Request Interface shall support filtering by volcano number (IAVCIE number) and forecast timestep. The Quantitative Volcanic Ash Information Subscription and Request Service Request Interface shall support filtering of probabilistic information based on the ash concentration threshold. The Quantitative Volcanic Ash Information Subscription and Request Service Request Interface shall support filtering based on the data set type. The Quantitative Volcanic Ash Information Subscription and Request Service Request Interface may support filtering based on geographic bounding box and flight level. ... support the BBOX spatial operator defined in the OGC Filter Encoding 2.0 Encoding Standard. The Quantitative Volcanic Ash InformationSubscription and Request Service Subscription Interface shall allow for the selection of subscription based on clearly defined criteria. |
---|
Machine-Readable Service Interface Definition
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
Info | ||
---|---|---|
| ||
This field is left empty. No machine-readable service interface definition is provided. |
machine-readable service interface definition | reference |
---|
Model View
Status | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
Info | ||
---|---|---|
| ||
This field is left empty. No model view is provided. |
model view | reference |
---|
Abbreviations and Acronyms
Status | ||
---|---|---|
|
Info | ||
---|---|---|
| ||
SWIM-DEFN-350 |
abbreviations and acronyms | abbreviation | code | AMQP |
---|---|---|---|
term | Advanced Message Queuing Protocol | ||
abbreviation | code | API | |
term | Application Programming Interface | ||
abbreviation | code | CTA | |
term | Control area | ||
abbreviation | code | EU | |
term | European Union | ||
abbreviation | code | FIR | |
term | Flight information region | ||
abbreviation | code | ICAO | |
term | International Civil Aviation Organization | ||
abbreviation | code | MEP | |
term | Message Exchange Pattern | ||
abbreviation | code | OGC | |
term | Open Geospatial Consortium | ||
abbreviation | code | SIGMET | |
term | Information concerning en-route weather phenomena which may affect the safety of aircraft operations. | ||
abbreviation | code | TI | |
term | Technical Infrastructure | ||
abbreviation | code | TIYP | |
term | Technical Infrastructure Yellow Profile | ||
abbreviation | code | TLS | |
term | Transport Layer Security | ||
abbreviation | code | UIR | |
term | Upper flight information region |
Appendix A: References
Status | ||
---|---|---|
|
Info | ||
---|---|---|
| ||
This is not traced to a requirement. |
references | reference | title | EU Implementing Regulation 2021/116 - Common Project One |
---|---|---|---|
version | 1 February 2021 | ||
description | Commission Implementing Regulation (EU) 2021/116 of 1 February 2021 on the establishment of the Common Project One supporting the implementation of the European Air Traffic Management Master Plan provided for in Regulation (EC) No 550/2004 of the European Parliament and of the Council, amending Commission Implementing Regulation (EU) No 409/2013 and repealing Commission Implementing Regulation (EU) No 716/2014. | ||
url | https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32021R0116 | ||
document type | |||
reference | title | Commission Implementing Regulation (EU) 2017/373 | |
version | 1 March 2017 (as amended) | ||
description | Commission Implementing Regulation (EU) 2017/373 of 1 March 2017 laying down common requirements for providers of air traffic management/air navigation services and other air traffic management network functions and their oversight, repealing Regulation (EC) No 482/2008, Implementing Regulations (EU) No 1034/2011, (EU) No 1035/2011 and (EU) 2016/1377 and amending Regulation (EU) No 677/2011. | ||
url | https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A02017R0373-20230126 | ||
document type | |||
reference | title | Acceptable Means of Compliance (AMC) and Guidance Material (GM) to Part-MET | |
version | 14/03/2022 | ||
description | |||
url | https://www.easa.europa.eu/en/document-library/acceptable-means-of-compliance-and-guidance-materials/group/part-met#part-met | ||
document type | |||
reference | title | OGC API – Environmental Data Retrieval Standard | |
version | 1.1 | ||
description | OGC API standards define modular API building blocks to spatially enable Web APIs in a consistent way. The OpenAPI specification is used to define the API building blocks. | ||
url | https://www.ogc.org/standard/ogcapi-edr/ | ||
document type | |||
reference | title | OGC Web Coverage Service (WCS) Interface Standard | |
version | version 2.1 | ||
description | A Web Coverage Service (WCS) offers multi-dimensional coverage data for access over the Internet. WCS Core specifies a core set of requirements that a WCS implementation must fulfill. | ||
url | https://www.ogc.org/standard/wcs/ | ||
document type | |||
reference | title | OGC API - Coverages | |
version | |||
description | The OGC API - Coverages draft specification defines a Web API for accessing coverages that are modeled according to the Coverage Implementation Schema (CIS) 1.1 | ||
url | https://ogcapi.ogc.org/coverages/ | ||
document type | |||
reference | title | OGC Web Feature Service 2.0 Interface Standard | |
version | |||
description | WFS offers direct fine-grained access to geographic information at the feature and feature property level. Note: This is equivalent to ISO 19142 - Geographic Information - Web Feature Service. | ||
url | https://www.ogc.org/standard/wfs/ | ||
document type | |||
reference | title | OGC API – Features | |
version | |||
description | OGC API Features provides API building blocks to create, modify and query features on the Web. | ||
url | https://www.ogc.org/standard/ogcapi-features/ | ||
document type | |||
reference | title | OGC Filter Encoding 2.0 Encoding Standard | |
version | |||
description | This jointly developed OGC and ISO TC/211 International Standard describes an XML and KVP encoding of a system neutral syntax for expressing projections, selection and sorting clauses collectively called a query expression. These components are modular and intended to be used together or individually by other standards which reference this International Standard. Note: This is equivalent to ISO 19143 - Geographic Information - Filter encoding. | ||
url | https://www.ogc.org/docs/is | ||
document type | |||
reference | title | Message Exchange Patterns: Identification Guidelines | |
version | JULY 2nd, 2019 | ||
description | Document intended to facilitate the understanding of message exchange patterns from an application and Technical Infrastructure perspective. | ||
url | https://reference.swim.aero/technical-infrastructure/message-exchange-patterns-identification-guidelines.html | ||
document type | SERVICE_BEHAVIOUR_DESCRIPTION | ||
reference | title | Publish/Subscribe Push MEP: Implementation Guidance | |
version | JULY 2nd, 2019 | ||
description | This document intends to serve as implementation guidance of the Publish/Subscribe Push Message Exchange Pattern using SWIM-TI Yellow Profile Service Bindings. | ||
url | https://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.html | ||
document type |