service definitions

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 45 Next »

Task Status

This page is part of the ongoing SWIM communities of interest discussions. The content is working material. It should not be treated as final as it is still subject to review, comment and change.

Guidance

This template allows for the documentation of service definitions based on the requirements found at: /wiki/spaces/SCOI/pages/59605116

General requirements to remember:

SWIM-DEFN-010Service definition coverage

A service definition shall define a single service


Note: This concerns the definition of a service that can be implemented by service providers. It is not used to describe a running service - use a service description in that case.

Note: This requirement uses "define" rather than "describe".

SWIM-DEFN-020Service definition languageThe textual descriptions in a service definition shall be written in English using the spelling listed as the primary British spelling when conflicting spellings exist.-


Status Key

  • TBD - No work has started
  • WORKING - Content is being worked on, comments discussed
  • DRAFT - Draft is ready, comments resolved
  • REVIEWED - Group has reviewed, edited the final draft
  • AGREED - Content is finalised and agreed

Explanation

Some fields in the template are left empty. This means that no requirement is specified for it and it is left to the service provider to decide.

Service Definition Identification

DRAFT

service definition identification

title

Service Definition for the Digital NOTAM Subscription and Request Service

edition

00.00.01

reference date

2023-02-09

Service Identification

DRAFT

service identification

service name

Digital NOTAM Subscription and Request Service

Service Abstract

DRAFT

service abstractThe Digital NOTAM Subscription and Request Service allows the service consumer to get aeronuatical information in accordance with the Digital NOTAM specification. The aeronautical information conforms to the event scenarios that are supported by Digital NOTAM such as runway closures.

The service consumer may subscribe to the service, specifying the event scenarios in which it is interested. It is also possible to send a direct request to the service to get the aeronautical information.

The information returned is in the form of an AIXM 5.1.1 message.

This supports the integration of the latest information into the various ATM systems.

Service Definition Provider

DRAFT

service definition provider

nameEUROCONTROL
descriptionEUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States.
point of contactswim@eurocontrol.int

Geographical Extent of Information

DRAFT

geographical extent of information

Service Categories

DRAFT

service categories





category category name

regulated information exchange

value

AERONAUTICAL_INFORMATION_EXCHANGE

scheme

http://reference.swim.aero/information-services/service-categories/CodeRegulatedInformationExchangeType.html 

categorycategory nameinformation domain
valueAERONAUTICAL_INFORMATION
schemehttps://reference.swim.aero/information-services/service-categories/CodeInformationDomainType.html
category category name

business activity

value

INFORMATION_MANAGEMENT

scheme

http://reference.swim.aero/information-services/service-categories/CodeBusinessActivityType.html 

category category name

intended service consumer

value
scheme

http://reference.swim.aero/information-services/service-categories/CodeStakeholderType.html 

category category nameintended service provider
valueAERONAUTICAL_INFORMATION_SERVICE_PROVIDER
schemehttp://reference.swim.aero/information-services/service-categories/CodeStakeholderType.html 
categorycategory nameservice type
valueAERONAUTICAL_INFORMATION_SUBSCRIPTION_SERVICE
scheme

http://reference.swim.aero/information-services/service-categories/CodeServiceType

(for the moment use https://ext.eurocontrol.int/swim_confluence/display/SCOI/Service+Categories+-+Service+Type).

categorycategory nameservice type
valueAERONAUTICAL_FEATURE_ACCESS_SERVICE
scheme

http://reference.swim.aero/information-services/service-categories/CodeServiceType

(for the moment use https://ext.eurocontrol.int/swim_confluence/display/SCOI/Service+Categories+-+Service+Type).

Service Standard Reference

DRAFT

service standard reference



referenceDigital NOTAM Specification (https://ext.eurocontrol.int/aixm_confluence/display/DNOTAM/Overview)
implemented optionsThe information scope offered by the service supports the requirements of the Digital NOTAM Specification.
deviations/additions

Operational Environment

DRAFT

operational environmentoperational needs

Air traffic management is defined as the "dynamic, integrated management of air traffic and airspace including air traffic services, airspace management and air traffic flow management - safely, economically and efficiently - through the provision of facilities and seamless services in collaboration with all parties and involving airborne and ground-based functions". It is provided by the air traffic management system that, amongst other things, relies on the collaborative integration of information and services.

Stakeholders involved in air traffic management need aeronautical data concerning the establishment, condition or change in any aeronautical facility, service, procedure or hazard, the timely knowledge of which is essential for flight operations.

This service satisfies this need by allowing clients to subscribe to be notified when such aeronautical events occur.

The aeronautical data can be used e.g. in pre-flight information bulletins. It can also be used to improve decision making thus positively impacting the efficiency of their planning and flight executions, enabling through automatic data verification and graphical visualisation.

The aeronautical data is also used in other systems such as those used for airspace reservations (ARES). A complete list of these is available as a High level description of the service offer.

This service satisfies this need by offering aeronautical data (in the form of event features) as regulated by ICAO Annex 15 - Aeronautical Information Services. The scope covers the event encodings outlined in the EUROCONTROL Digital NOTAM Specification including aerodrome data for the 18 airports listed in EU Implementing Regulation 2021/116 - Common Project One.

capabilities

The service offers notification in the changes to aeronautical data about features. 

information exchange requirements

Service Functions

DRAFT

service functions


functionnameSubscribe to event scenario

descriptionThe service consumer shall be able to subscribe/unsubscribe to topics in order to receive information based on an event scenario(s).
real-world effectService consumer subscribes to topics offered by the service.
functionnameRequest a Digital NOTAM
descriptionThe service consumer shall be able to request aeronautical information in the form of a Digital NOTAM based on criteria sent to the server.
real-world effectService consumer receives the Digital NOTAM.
functionnameDistribution
descriptionWhen new data is available, it shall be distributed to the subscribers.
real-world effectService consumer is notified when a change happens to a topic of interest.
functionnameCheck distribution list
descriptionThere shall be a mechanism by which a given subscriber can check if he has received all the distributions expected to be received.
real-world effectService consumer has an understanding of the distributions.
functionnameRequest Digital NOTAM reissue
descriptionThere shall be a mechanism by which a subscriber requests a Digital NOTAM reissue (due to not reception, lose, etc.)
real-world effectService consumer receives a Digital NOTAM.

Service Access and Use Conditions

DRAFT

service access and use conditions



legal constraints



service policies

business policy


operational policy


technical policy


service consumption constraints



Security Constraints

DRAFT

security constraints



authentication

The service may offer unauthenticated/public use.

It shall ensure provider authentication in accordance with SWIM TIYP through X.509 certificate.

It shall ensure consumer authentication in accordance with SWIM TIYP through X.509 certificate or the use of a username/password (SASL).

authorisation

The service shall ensure that satisfactory authorisation is put in place according to SWIM-TIYP-0070.

confidentiality

The service ensures point-to-point confidentiality in accordance with SWIM TIYP through Transport Layer Security (TLS) 1.2 or above.

integrity

The service ensures point-to-point integrity in accordance with SWIM TIYP through Transport Layer Security (TLS) 1.2 or above.

Quality of Service

DRAFT

quality of service

performance

capacity


response time
reliability

availability


recoverabilityreliable enough to meet the user needs to be informed of hazards...
security

confidentiality

Confidentiality shall be shall be ensured using SWIM TIYP  bindings.

integrityIntegrity shall be shall be ensured using SWIM TIYP  bindings.

Quality of Data

DRAFT

quality of data

Source of Information

DRAFT

Service Validation Information

DRAFT

service validation information

prototyping

Application Message Exchange Pattern

DRAFT

application message exchange pattern

Service Behaviour

DRAFT

service behaviour

typical behaviour
The service behaviour is in accordance with the patterns detailed in Message Exchange Patterns: Identification Guidelines. The two interfaces have different behaviours.

PUBLISH_SUBSCRIBE

  • A request-reply handles the subscription.
  • An implementation of AMQP 1.0 handles the publication.

SYNCHRONOUS_REQUEST_REPLY

The OGC Web Feature Service 2.0 Interface Standard defines the basic behaviour.

Synchronous Request/Reply
  • The request message is sent from the service consumer to the service
  • The service consumer remains blocked while awaiting the reply
  • The service remains blocked while processing the reply
  • The AIXM Basic Message, the reply message, is sent from the service to the service consumer.

Service Monitoring

DRAFT

service monitoring

A service monitoring mechanism shall be made available to service consumers.

Service Interfaces

DRAFT

service interfaces

interfacename

Digital NOTAM Subscription and Request Service Subscription Interface


descriptionAllows the service consumer to select event scenarios of interest.
provider/consumer sideProvider side
interfacenameDigital NOTAM Subscription and Request Service Distribution Interface
descriptionDistribute AIXM Basic Messages based on the event scenario causing the need for the service consumer to be updated.
provider/consumer sideProvider side
interfacename

Digital NOTAM Subscription and Request Service Request Interface

descriptionRequest an AIXM Basic Message based on filters which are linked to the event feature.
provider/consumer sideProvider side

SWIM TI Profile and Interface Bindings

DRAFT

Working notes

SAT 2023-01-30:


This needs to be split up. Dedicated entry per interface is needed.

SWIM TI profile and interface bindings





profile name

EUROCONTROL Specification for SWIM Technical Infrastructure Yellow Profile

profile version

1.1

selected service interface binding
selected network interface bindingShall use the network bindings of the SWIM TIYP. See 3.1.2 for the options: IPV4, etc.
supported optional requirements

PUBLISH_SUBSCRIBE

AMQP 1.0 is used to publish messages in the service's publish-subscribe implementation. This is explained in: https://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.html

SYNCHRONOUS_REQUEST_REPLY

The OGC Web Feature Service 2.0 Interface Standard is used in the service's request-reply implementation. The standardised operations for a Basic WFS are implemented.

The temporal extension (WFS-TE) is used to support advanced temporal filtering.

The ISO 19143 - Geographic Information - Filter encoding specification is applied for spatial and logical operators.

Service Interface Protocols and Data Format

DRAFT

service interface protocols and data format





transport / messaging protocols

Shall be in accordance with SWIM TIYP: TLS1.2 or later
data format

This is captured at Service Message level (see below).

Service Operations

DRAFT

Service operations







operation


operation name

subscribe operation - see if there is a standard that gives us a list of operation names.

description


messages


operation


operation name

request

description

Event features can be queried.

messages


Service Messages

DRAFT

service messages





message

name

AIXM Basic Message

description

The basic messages is a collection of features.

The structure is explained in the EUROCONTROL Event Encoding Specification. The message serves the purpose of Digital NOTAM.

typeOut
data formatAIXM 5.1.1 including the event extension
message

name


description
type
data format

Information Definition (Minimum) and (Extended)

DRAFT

information definition

The service exposes a topic tree. The topics are based on the event scenarios found in the Digital NOTAM Specification (https://ext.eurocontrol.int/aixm_confluence/display/DNOTAM/Digital+NOTAM+Specification)

The scenarios use features that are in the Aeronautical Information Exchange Model (AIXM) 5.1.1 and the  AIXM Event Extension.

The AIXMBasicMessage that is returned by the service shall contain an event feature and the related AIXM features.

See

Filter Encoding

DRAFT

filter encoding

The request-reply service interface supports filtering based on (subset of the) the operators defined in the OGC Filter Encoding 2.0 Encoding Standard (equivalent to ISO 19143 - Geographic Information - Filter encoding). The temporal extension (WFS-TE) is used to support advanced temporal filtering.

The publish-subscribe service interface allows for the selection of topics. These can be organised around e.g. a specific aerodrome or airspace. The considerations on https://ext.eurocontrol.int/aixm_confluence/display/DNOTAM/General+Principles will help AISP decide which topic an event concerns.

Machine-Readable Service Interface Definition

DRAFT

machine-readable service interface definition

reference

Model View

WORKING

model view

reference

Abbreviations and Acronyms

DRAFT

abbreviations and acronyms


abbreviationcodeSWIM

termSystem Wide Information Management
abbreviationcode

term

Appendix A: References

DRAFT

Trace

This is not traced to a requirement.
references



reference



titleCP1
version
description
url
document type
referencetitleDigital NOTAM Specification (https://ext.eurocontrol.int/aixm_confluence/display/DNOTAM/Overview)
version
description
url
document type
referencetitleEvent Encoding Specification ensures the messages are encoded correctly
version
description
url
document type
referencetitleCommission Implementing Regulation (EU) 2017/373 of 1 March 2017
version
description
url
document type
referencetitle AIXM 5.1.1 coding guidance is applied to the data. See:
version
description
url
document type
referencetitlehttps://aixm.aero/page/data-coding-guidelines
version
description
url
document type
referencetitleUse of Geography Markup Language (GML) for Aviation Data
version
description
url
document type
referencetitlehttps://www.aixm.aero/schema/5.1.1/AIXM_Features.xsd.
version
description
url
document type
referencetitlehttps://www.aixm.aero/schema/5.1.1/event/version_5.1.1-i/Event_Features.xsd
version
description
url
document type
referencetitle
version
description
url
document type
referencetitleOGC Filter Encoding 2.0 Encoding Standard (equivalent to ISO 19143 - Geographic Information - Filter encoding
version
description
url
document type
referencetitletemporal extension (WFS-TE)
version
description
url
document type
referencetitlehttps://ext.eurocontrol.int/aixm_confluence/display/DNOTAM/General+Principles will help AISP decide which topic an event concerns.
version
description
url
document type

Appendix B: Information Definition for Digital NOTAM Subscription and Request Service

DRAFT


AIXM 5.1.1. feature allocated to supported event scenario

Digital NOTAM Subscription and Request Service

The service will allow a service consumer to subscribe to event scenarios based on https://ext.eurocontrol.int/aixm_confluence/display/DNOTAM/Coding+scenarios.

The aeronautical information made available is driven by the scenarios.

There is an OTHER Event Scenario that allows for anything even if not tied to an AIXM feature.



AD.CLSAD.LGTAD.LIMAGS.UNSAPE.CLSAPE.LIMAPN.CLSAPN.LIMATSA.ACTATSA.NEWDEI.IOPFFS.CHG

GNSS.UNS

(star)AIXM 5.2 only

LVP.IOPNAV.UNSOBL.UNSOBS.NEWRTE.CLSRTE.OPNRWY.CLSRWY.LIMSAA.ACTSAA.NEWSFC.CONSTAND.CLSSTAND.LIMTWY.CLSTWY.LIMWLF.HZD
AerialRefuelling




























AeronauticalGroundLight




























AircraftGroundService


y
























AircraftStand









y












yy


AirportClearanceService




























AirportHeliportCollocation




























AirportHeliportyyyyyyyy

yy
y




yy

yyyyyy
AirportHotSpot




























AirportProtectionAreaMarking




























AirportSuppliesService


y
























AirspaceBorderCrossing




























Airspace







yy










yy





AirTrafficControlService




























AirTrafficManagementService




























AltimeterSource




























AngleIndication




























ApproachLightingSystem
y


























ApronElement



yy






















ApronLightSystem




























ApronMarking




























Apron



yyyy

y











y




ArrestingGear




























ArrivalFeederLeg




























ArrivalLeg




























AuthorityForAirspace




























Azimuth




























ChangeOverPoint




























CheckpointINS




























CheckpointVOR




























CirclingArea




























DeicingAreaMarking




























DeicingArea









y

















DepartureLeg




























DesignatedPoint




























DirectionFinder




























DistanceIndication




























DME




























Elevation




























FinalLeg




























FireFightingService










y
















FlightRestriction




























FloatingDockSite




























GeoBorder




























Glidepath




























GroundTrafficControlService




























GuidanceLineLightSystem




























GuidanceLineMarking




























GuidanceLine




























HoldingAssessment




























HoldingPattern




























InformationService




























InitialLeg




























InstrumentApproachProcedure




























IntermediateLeg




























Localizer




























MarkerBeacon




























MarkingBuoy




























MissedApproachLeg




























Navaid













y













NavigationAreaRestriction




























NavigationArea




























NDB




























NonMovementArea




























ObstacleArea




























OrganisationAuthority




























PassengerLoadingBridge




























PassengerService


y
























PilotControlledLighting




























PrecisionApproachRadar




























PrimarySurveillanceRadar




























ProcedureDME




























RadarSystem




























RadioCommunicationChannel




























RadioFrequencyArea




























Road




























RouteDME




























RouteSegment
















yy









Route




























RulesProcedures




























RunwayBlastPad




























RunwayCentrelinePoint




























RunwayDirectionLightSystem
y


























RunwayDirection
y
















yy







RunwayElement




























RunwayMarking




























RunwayProtectAreaLightSystem




























RunwayProtectArea












y














Runway


















yy

y




RunwayVisualRange




























SafeAltitudeArea




























SDF




























SeaplaneLandingArea




























SeaplaneRampSite




























SearchRescueService




























SecondarySurveillanceRadar




























SignificantPointInAirspace




























SpecialDate




























SpecialNavigationStation




























SpecialNavigationSystem




























StandardInstrumentArrival




























StandardInstrumentDeparture




























StandardLevelColumn




























StandardLevelSector




























StandardLevelTable




























StandMarking




























SurveyControlPoint




























TACAN




























TaxiHoldingPositionLightSystem




























TaxiHoldingPositionMarking




























TaxiHoldingPosition




























TaxiwayElement

























yy
TaxiwayLightSystem
y


























TaxiwayMarking




























Taxiway









y











y

yy
TerminalArrivalArea




























TouchDownLiftOffLightSystem




























TouchDownLiftOffMarking




























TouchDownLiftOffSafeArea




























TouchDownLiftOff




























Unit




























UnplannedHolding




























VerticalStructure














yy











VisualGlideSlopeIndicator
y


























VOR




























WorkArea





























Appendix C: Operational Needs

DRAFT


Transversal

  • Collaborative information sharing is essential for decision making involving multiple actors. Automatic taxi with time and path information on the ground, collaborative decision making during emergencies, de-icing operations and infrastructure availability information are examples that involve multiple actors including the aircraft crew.

By service consumer role

Stakeholder/RoleDescription of stakeholder/roleNeeds for DNOTAMNotes
CIVIL_AIRSPACE_USERA generic term designating an organization operating aircraft and its pilots, the flight operations centres (FOC) responsible for the strategic planning of a flight and the entity responsible for the execution of a flight which is traditionally a flight deck.
  • Retrieve dynamic data to support digital integrated briefing concepts.
  • Ensure safe operations by responding to changes in the situation.
  • Provide in-flight information updates.

Aircraft covers UAV.


MILITARY_AIRSPACE_USERAirspace User under the authority of a military organisation.
  • Retrieve dynamic data to support digital integrated briefing concepts.
  • Ensure safe operations by responding to changes in the situation.
  • Provide in-flight information updates.

There is an assumption that these will be working in DMZ under yellow profile. The AISP needs to meet the security needs.

In general, they have the same needs as civil airspace users.

CIVIL_AIR_NAVIGATION_SERVICE_PROVIDERAny public or private entity providing air navigation services for general air traffic.
  • Ensure safe operations by responding to changes in the status of the infrastructure

MILITARY_AIR_NAVIGATION_SERVICE_PROVIDERAny public or private entity providing air navigation services for military air traffic.Ensure safe operations by responding to changes in the status of the infrastructure
AIR_TRAFFIC_SERVICE_PROVIDERA generic term meaning variously, flight information service, alerting service, air traffic advisory service, air traffic control service (area control service, approach control service or aerodrome control service).
No needs have been identified.
REGULATED_METEOROLOGICAL_SERVICE_PROVIDERAn office designated to provide meteorological service for international air navigation.
No needs have been identified.
AERONAUTICAL_INFORMATION_SERVICE_PROVIDERA service established within the defined area of coverage responsible for the provision of aeronautical information/data necessary for the safety, regularity and efficiency of air navigation.
No needs have been identified.

COMMUNICATION_NAVIGATION_AND_

SURVEILLANCE_SERVICE_PROVIDER

A provider of CNS services.
No needs have been identified.
PROVIDER_OF_DATA_SERVICESA public or private entity responsible for the management of a Data Service Provision (e.g. to one or several Virtual Centre).
  • Update EFB - electronic flight bags

NETWORK_MANAGERThe organization responsible for enabling the optimum use of airspace and ensure that Airspace Users can operate preferred trajectories while allowing maximum access to airspaces and air navigation services.
  • Create measures - in tactical phase
  • Execute ATFM, ATFCM in tactical phases

AIRPORT_OPERATORThe civilian or military agency, group or individual which exercises control over the operations of the civil airport or military airfield.
  • Surface contamination management and inspection - SNOWTAM, ASHTAM
  • Submit NOTAM proposals
  • Receive NOTAM after AIS processing
  • Local flight briefing/preparation tools (eg in ARO context)
  • Airport capacity management

AIRSIDE_GROUND_HANDLERA stakeholder involved in the services necessary for an aircraft's arrival at, and departure from, an airport, other than air traffic services.
No needs have been identified.
MILITARY_DEFENCE_CENTRE

A military defence centre.

Note: these centres, e.g., check for diplomatic clearance.


No needs have been identified.





  • No labels