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-010

Service 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-020

Service definition language

The 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

Service Definition Identification

DRAFT

Trace

SWIM-DEFN-030

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

Trace

SWIM-DEFN-040

service identification	service name	Digital NOTAM Subscription and Request Service

Service Abstract

DRAFT

Trace

SWIM-DEFN-050

service abstract

The 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

Trace

SWIM-DEFN-085

service definition provider	name	EUROCONTROL
	abbreviated name
	description	EUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States.

Geographical Extent of Information

DRAFT

Trace

SWIM-DEFN-090

geographical extent of information

Service Categories

DRAFT

Trace

SWIM-DEFN-095, SWIM-DEFN-100

service categories	category	category name	regulated information exchange
		value	AERONAUTICAL_INFORMATION_EXCHANGE
		scheme	http://reference.swim.aero/information-services/service-categories/CodeRegulatedInformationExchangeType.html
	category	category name	information domain
		value	AERONAUTICAL_INFORMATION
		scheme	https://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	CIVIL_AIRSPACE_USER MILITARY_AIRSPACE_USER CIVIL_AIR_NAVIGATION_SERVICE_PROVIDER MILITARY_AIR_NAVIGATION_SERVICE_PROVIDER PROVIDER_OF_DATA_SERVICES NETWORK_MANAGER AIRPORT_OPERATOR
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType.html
	category	category name	intended service provider
		value	AERONAUTICAL_INFORMATION_SERVICE_PROVIDER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType.html
	category	category name	service type
		value	AERONAUTICAL_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).
	category	category name	service type
		value	AERONAUTICAL_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

Trace

SWIM-DEFN-120

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

Operational Environment

DRAFT

Trace

SWIM-DEFN-130

operational environment

operational 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

IER 1

Digital NOTAM Exchange (A3SG-IER-05)

Service Functions

DRAFT

Trace

SWIM-DEFN-140

Working notes

SAT 2022-11-11:

Options

All data is pushed - PUB/SUB containing the payload.
can also just be a notification containing a link to the data.

scenarios come from the digital NOTAM spec including aerodrome data for the 18 airports. Service providers declare which ones their service supports.

service functions	function	name	subscription
		description	There shall be a mechanism to subscribe/unsubscribe
		real-world effect	Service consumer subscribes to topics offered by the service.
	function	name	topic selection
		description	There shall be filtering mechanisms to only subscribe to specific contents.
		real-world effect
	function	name	notification
		description	When new data is available, it shall be distributed to the subscribers.
		real-world effect	Service consumer is notified when a change happens to a topic of interest.
	function	name	check notification list
		description	There shall be a mechanism by which a given subscriber can check if he has received all sent notifications.
		real-world effect	Service consumer has an understanding of the notifications.
	function	name	request notification reissue
		description	There shall be a mechanism by which a subscriber requests a notification reissue (due to not reception, lose, etc.)
		real-world effect	Service consumer receives a notification.

Service Access and Use Conditions

DRAFT

Trace

SWIM-DEFN-150

service access and use conditions	legal constraints
	service policies	business policy
		operational policy
		technical policy
	service consumption constraints

Security Constraints

DRAFT

Trace

SWIM-DEFN-160

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

Trace

SWIM-DEFN-180

quality of service	performance	capacity
	performance	response time
	reliability	availability
	reliability	recoverability	reliable enough to meet the user needs to be informed of hazards...
	security	confidentiality	Confidentiality shall be shall be ensured using SWIM TIYP bindings.
	security	integrity	Integrity shall be shall be ensured using SWIM TIYP bindings.

Quality of Data

DRAFT

Trace

SWIM-DEFN-185

quality of data

Event Encoding Specification ensures the messages are encoded correctly
The data must satisfy the applicable sections of Commission Implementing Regulation (EU) 2017/373 of 1 March 2017
The AIXM 5.1.1 coding guidance is applied to the data. See:

Source of Information

DRAFT

Trace

SWIM-DEFN-190

source of information

source

Data is received from the appropriate authorised originating sources, e.g.

Service Validation Information

DRAFT

Trace

SWIM-DEFN-200

service validation information	prototyping

Application Message Exchange Pattern

DRAFT

Trace

SWIM-DEFN-210

application message exchange pattern	PUBLISH_SUBSCRIBE SYNCHRONOUS_REQUEST_REPLY

Service Behaviour

DRAFT

Trace

SWIM-DEFN-220

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

Trace

SWIM-DEFN-230

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

Service Interfaces

DRAFT

Trace

SWIM-DEFN-240

service interfaces	interface	name	Subscription
		description
		provider/consumer side
	interface	name	Distribution
		description	Pushes messagees
		provider/consumer side
	interface	name	Request Digital NOTAM qualified Event feature
		description	- builds AIXM Basic Message based on filters which are linked to the event feature.
		provider/consumer side

SWIM TI Profile and Interface Bindings

DRAFT

Trace

SWIM-DEFN-250, SWIM-DEFN-255

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	WS_LIGHT SWIM_TI_YP_1_1_AMQP_MESSAGING
	selected network interface binding	Shall 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

Trace

SWIM-DEFN-260

service interface protocols and data format	transport / messaging protocols	Shall be in accordance with SWIM TIYP: TLS1.2 or later
service interface protocols and data format	data format	This is captured at Service Message level (see below).

Service Operations

DRAFT

Trace

SWIM-DEFN-270

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

Trace

SWIM-DEFN-280

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.
		type	Out
		data format	AIXM 5.1.1 including the event extension
	message	name
		description
		type
		data format

Information Definition (Minimum) and (Extended)

DRAFT

Trace

SWIM-DEFN-290, SWIM-DEFN-300

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

https://www.aixm.aero/schema/5.1.1/AIXM_Features.xsd.
https://www.aixm.aero/schema/5.1.1/event/version_5.1.1-i/Event_Features.xsd
https://airm.aero/developers/aixm-5.1.1-to-airm-1.0.0-index for the semantic correspondences with the AIRM.

Filter Encoding

DRAFT

Trace

SWIM-DEFN-310

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

Trace

SWIM-DEFN-320

machine-readable service interface definition	reference

Model View

WORKING

Trace

SWIM-DEFN-330

model view	reference

Abbreviations and Acronyms

DRAFT

Trace

SWIM-DEFN-350

abbreviations and acronyms	abbreviation	code	SWIM
		term	System Wide Information Management
	abbreviation	code
		term

Digital NOTAM Subscription and Request Service - Service Definition

Service Definition Identification

Service Identification

Service Abstract

Service Definition Provider

Geographical Extent of Information

Service Categories

Service Standard Reference

Operational Environment

Service Functions

Service Access and Use Conditions

Security Constraints

Quality of Service

Quality of Data

Source of Information

Service Validation Information

Application Message Exchange Pattern

Service Behaviour

Synchronous Request/Reply

Service Monitoring

Service Interfaces

SWIM TI Profile and Interface Bindings

Service Interface Protocols and Data Format

Service Operations

Service Messages

Information Definition (Minimum) and (Extended)

Filter Encoding

Machine-Readable Service Interface Definition

Model View

Abbreviations and Acronyms