Document metadata

title

Aeronautical Dataset Publication Service Definition

edition

0.20

reference date

2020-09-17

Child pages (Children Display)

depth	2

Service Identification

name

Aeronautical Dataset Publication

version

1.0.0

Service Abstract

The Aeronautical Dataset Publication service

Service Definition Identification

service definition identification	title	Service definition for the Aeronautical Data Set Management Service
	edition	00.06.00
	reference date	2024-09-23

Table of Contents

maxLevel	1
type	flat

Service Identification

service identification	service name	Aeronautical Data Set Management Service

Service Abstract

service abstract	The Aeronautical Data Set Management Service allows an aeronautical information service (AIS) to upload and manage ICAO Annex 15 digital

datasets

data sets, customised data sets and accompanying metadata within a

dataset

data set store.

The service provides support for the management of

dataset

data set series,

datasets

data sets and data product specifications.

The

The service is part of a series of services that

support

supports the

concept

provision of

aeronautical information product

digital data

set

sets as defined by ICAO Annex 15.

Service Definition Provider

service definition provider	name	EUROCONTROL
	description	EUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States.
	point of contact	ais.aixm@eurocontrol.int

Geographical Extent of Information

Info

title	Explanatory note

This field is left empty.

geographical extent of information

Service Categories

		value
service categories	category	category name	Information Domain

(s)information exchange area

	AERONAUTICAL_INFORMATION
scheme	https://reference.swim.aero/information-services/service-categories/CodeInformationDomainType
category	category name	intended service provider
	value	AERONAUTICAL_INFORMATION

_EXCHANGE

business activity

INFORMATION_MANAGEMENT

intended service provider

_SERVICE_PROVIDER
scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
category	category name	Business Activity
	value	INFORMATION_MANAGEMENT
	scheme	http://reference.swim.aero/information-services/service-categories/CodeBusinessActivityType
category	category name	intended service consumer
	value	AERONAUTICAL_INFORMATION_SERVICE_PROVIDER

intended service consumer

AERONAUTICAL_INFORMATION_SERVICE_PROVIDER

Operational Environment

NameDescriptionICAO Operational NeedSupport


scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
category	category name	service type
	value	AERONAUTICAL_DATA_PRODUCT_ACCESS_SERVICE
	scheme	http://reference.swim.aero/information-services/service-categories/CodeServiceType

Service Standard Reference

Info

title	Explanatory note

This field is left empty.

service standard reference	reference
	implemented options
	deviations/additions

Operational Environment

operational environment

operational needs

The service enables Aeronautical Information Services to publish digital data sets to satisfy international requirements for the exchange of aeronautical information.

capabilities

The service supports the publication of the aeronautical digital data sets as defined by ICAO Annex 15:

AIP data set;
Obstacle data set;
Terrain data set;

Airport Support

Aerodrome mapping data set;
Instrument flight procedure data set

Extended Operational Need

The service supports the publication of customised digital

datasets

data sets for specific purposes.

An example is the provision of airport lighting data in the context of SESAR 2020 PJ03, which is a derivation of the airport mapping dataset containing precise lighting information for a very specific purpose.

Functionality

name

description

real world effect

Add dataset series

Allow a service consumer to add a dataset series with its corresponding metadata.

the dataset series is added

Add dataset

Allow a service consumer to add a dataset within a dataset series, with its corresponding metadata and files

the dataset is added

Add data product specification

Allow a service consumer to add a data product specification

the data product specification is added

Delete dataset series

Allow a service consumer to delete a dataset series with its corresponding metadata.

the dataset series is removed

Delete dataset

Allow a service consumer to delete a dataset within a dataset series, with its corresponding metadata and files

the dataset is removed

Delete data product specification

Allow a service consumer to delete a data product specification

the data product specification is removed

Access and Use Conditions

Service Policies

Pricing policy

The service does not

Service Functions

service functions	function	name	Publish and manage data set series
		description	The service consumer shall be able to publish and manage (e.g., update/withdraw) data set series including its corresponding metadata within the data set store.
		real-world effect	The data set series is published and managed.
	function	name	Publish and manage data set
		description	The service consumer shall be able topublish and manage (e.g., update/withdraw) data sets within a data set series including its corresponding metadata and files.
		real-world effect	The data set is published and managed.
	function	name	Publish and managedata product specification
		description	The service consumer shall be able topublish and manage (e.g., update/withdraw)data product specification.
		real-world effect	The data product specification is published and managed.

Service Access and Use Conditions

service access and use conditions	legal constraints
	service policies	business policy	The service may support the possibility to indicate a price for a data set or a data set series.
		operational policy
		technical policy
	service consumption constraints

Security Constraints

security constraints

Authentication

authentication	Consumer

side authentication: TBD
Provider side authentication: Authentication is required TBD

Authorisation

The service is subject to authorisation.

Quality of Service

Availability

99.95 % outside the planned outages Schedule of planned outages: {*}http://www.donlon-airport.com/swim/planned-outages*

Throughput

2000 service requests per hour

Response time

2s delay for 95% of messages

Abbreviations

abbreviation

term

AIP

Aeronautical Information Publication

AIRAC

Aeronautical Information Regulation and Control

AIRM

ATM Information Reference Model

AIS

Aeronautical Information Services

ANSP

Air Navigation Service Provider

ATM

Air Traffic Management

DPS

Data Product Specification

ICAO

International Civil Aviation Organisation

IER

Information Exchange Requirement

PJ03a-04

SESAR 2020 project on "enhanced visual operations"

SESAR

Single European Sky ATM Research Programme

SWIM

System Wide Information Management

UTC

Coordinated Universal Time

WS

Web Service

XSD

XML Schema Definition

Interfaces

Publish

and provider authentication shall be ensured. The service shall ensure consumer authentication in accordance with the EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of a X.509 certificate or the use of a username/password (SASL). The service shall ensure provider authentication in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of a X.509 certificate.
authorisation	The service shall ensure that satisfactory authorisation is put in place according to 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

performance	capacity	The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
performance	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.
reliability	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.
security	integrity	The service shall ensure integrity by using SWIM Technical Infrastructure (TI) Yellow Profile bindings.

Quality of Data

quality of data	The data contained in the digital data set shall meet the data quality requirements outlined in ICAO Annex 15. The data contained in the digital data set shall meet the data quality requirements outlined in the PANS-AIM Data Catalogue. If the data quality requirements are not me, the data product specification shall record which requirements are not met.

Source of Information

source of information

source

The service shall accept digital data sets from the appropriate authorised originating sources, e.g.,

AERONAUTICAL_INFORMATION_SERVICE_PROVIDER

Service Validation Information

service validation information	validation performed	The service was prototyped in 2021.
	method used	USER_VALIDATION
	summary of the validation steps performed
	results achieved	The service operations and information definition were tested. However, the quality of service was not tested.
	how the service consumer may obtain the validation evidence	https://ext.eurocontrol.int/aixm_confluence/display/ADS/EUROCONTROL+prototype

Application Message Exchange Pattern

application message exchange pattern	SYNCHRONOUS_REQUEST_REPLY

Service Behaviour

service behaviour	typical behaviour	The service behaviour shall be in accordance with the patterns detailed in the Message Exchange Patterns: Identification Guidelines. add data set series A typical sequence to add a data set series is: The service consumer requests data set series based on a number of selection criteria, and receives back a list containing zero, one or more data set series. The service consumer checks that the data set series to be added is not yet present. The service consumer creates the data set series metadata. Optionally, the service consumer uploads a data product specification file. add data set A typical sequence to add a data set is: The service consumer requests data set series based on a number of selection criteria, and receives back a list containing zero, one or more data set series. The service consumer analyses that list to identify the data set series to which the data set(s) need to be added. The service consumer requests data sets from the selected data set series, possibly supplying additional selection criteria, and receives back a list containing zero, one or more data sets. The service consumer checks that the data set to be added is not yet present. The service consumer creates the data set metadata within the selected data set series. The service consumer uploads data set file for the newly created data set. In case of a data set with multiple files, the upload operation is repeated for each file.
service behaviour	exception handling	The services shall make use of the standard HTTP status codes.

Service Monitoring

Info

title	Explanatory note

This field is left empty.

service monitoring

Service Interfaces

service interfaces

interface

name

Publish

description

The interface allows the publication and management of

dataset

data set (series) and

dataset

data set files.

interface provision

provider/consumer side	PROVIDER_SIDE_INTERFACE

network address

N/A (provider-independent)

message exchange pattern

SYNCHRONOUS_REQUEST_RESPONSE

service interface bindingSWIM_TI_YP_1_0_WS_LIGHTinterface binding descriptionHTTP 1.1. HTTP Messages will indicate the payload content type using the content-type header. HTTP Messages that transport compressed payloads will use deflate/gzip as expressed in the content-encoding header.
HTTP will use the chunked transfer encoding and indicate this in the transfer-encoding header. HTTP will use the status header to indicate the status of the response using a code and corresponding meaning phrase. (see exception handling). HTTP GET method is supported.

Operations

namedescriptiontiProtocolmessage - INmessage - OUTREST - resourcecreateDatasetSeries

SWIM TI Profile and Interface Bindings

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

Service Interface Protocols and Data Format

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.
service interface protocols and data format	data format	XML

Service Operations

service operations

operation

operation name

createDataSetSeries

description

The operation accepts metadata for a

dataset

data set series, stores it as a new

dataset

data set series, and returns the stored object.

HTTP POST

messages

CreateDatasetSeriesRequest

CreateDataSetSeriesRequest, CreateDataSetSeriesReply

CreateDatasetSeriesReply

resources

Resource: /datasetseries

Output: [0..1] dataset series object

createDataset


operation	operation name	createDataSet
	description	The operation accepts metadata for a

dataset

data set, stores it as a new

dataset

data set, and returns the stored object.

HTTP POST

messages

CreateDatasetRequest

CreateDataSetRequest, CreateDataSetReply

CreateDatasetReply

resources

Resource: /datasetseries/{ID}

Output: [0..1] dataset object

uploadDatasetFile

operation	operation name	uploadDataSetFile
	description	The operation accepts a file and returns a file object.

HTTP POST

messages

UploadDatasetFileRequest

UploadDatSetFileRequest, UploadDataSetFileReply

UploadDatasetFileReply

resources	Resource: /datasets/{ID}/files Output: [0..1] file object
operation	operation name	uploadDPSFile
	description	The operation accepts a file and returns a file object.

HTTP POST

messages

UploadDatasetFileRequest

UploadDPSFileRequest, UploadDPSFileReply

UploadDatasetFileReply

resources	Resource: /datasetseries/{ID}/dps Output: [0..1] file object

updateDatasetSeries


operation	operation name	updateDataSetSeries
	description	The operation allows a user to update the metadata for an existing

dataser

data set series.

HTTP POST

messages	UpdateDataSetSeriesRequest, UpdateDataSetSeriesReply

UpdateDataSetSeriesReply

resources	Resource: /datasetseries

deleteDatasetSeries


operation	operation name	withdrawDataSetSeries
	description	The operation accepts the id of a given

dataset

data set series, validates the request and

deletes

withdraws the

dataset HTTP DELETEDeleteDatasetSeriesRequest DeleteDatasetSeriesReply

data set series together with its data product specification if any.

Pre-condition
There are no datasets related to the dataset series.
The delete operation is aborted if dataset(s) would still be related to the dataset series. The related datasets should be delete first.

Post-condition
The dataset series and the related data product specification are deleted

messages	WithdrawDataSetSeriesRequest, WithdrawDataSetSeriesReply
resources	Resource: /datasetseries/{ID}

deleteDataset


operation	operation name	withdrawDataSet
	description	The operation accepts the id of a given

dataset

data set, validates the request and

deletes

withdraws the

dataset

data set together with its

dataset

data set file(s).

Post-condition
The dataset and the related dataset files are deleted

HTTP DELETEDeleteDatasetRequest DeleteDatasetReply

messages	WithdrawDataSetRequest, WithdrawDataSetReply
resources	Resource: /datasets/{ID}

Service Messages

Behaviour

add dataset series - typical behaviour

A typical sequence is illustrated below (in text and graphically), where the service consumer is an AIS data provider.

The service consumer requests dataset series based on a number of selection criteria, and receives back a list with zero, one or more dataset series objects
- The service consumer checks that the dataset series he wants to add is not yet present.
The service consumer creates the dataset series metadata
Optionally, the service consumer uploads a data product specification file.

add dataset file - typical behaviour

A typical sequence is illustrated below (in text and graphically), where the service consumer is an AIS data provider.

The service consumer requests dataset series based on a number of selection criteria, and receives back a list with zero, one or more dataset series objects
- The service consumer analyses that list to identify the dataset series to which the dataset(s) need be add.
The service consumer requests datasets from the selected dataset series, possibly supplying additional selection criteria, and receives back a list of zero, one or more datasets
- The service consumer checks that the dataset he wants to add is not yet present
The service consumer creates the dataset metadata within the selected dataset series
The service consumer uploads dataset file for the newly created dataset.
- In case of a dataset with multiple files, the upload operation is repeated for each file.

exception handling

The services make use of the standard HTTP status code (details to come later)

Supporting diagrams

The following diagram summarises the service and its provided interfaces and operations.

Image Removed

The following diagram illustrates the typical behaviour for adding a dataset series.

Image Removed

The following diagram illustrates the typical behaviour for adding a dataset file.

Image Removed

Information definition

namedescriptionAIRM confromant?AIRM versionInformation DefinitionDescription of messagestrue1.0.0

Exchange schema

The service is designed using REST so there is no exchange model - the information is exchanged using the REST resource calls.

Technical Constraint

No known technical constraint.

References

none

CreateDataSetSeriesRequest

Message that contains the necessary information to create a data set series

Property name	Type, Multiplicity	Definition
dataSetSeries	DataSetSeries [1]	Information about the data set series to be created.

CreateDataSetSeriesReply

Message that responds to a previously sent CreateDataSetSeriesRequest message, with a status code, and information about the created data set series if creation was successful.

Inherits from Reply message

Property name	Type, Multiplicity	Definition
dataSetSeries	DataSetSeries [0..1]	Metadata about the created data set series.

CreateDataSetRequest

Message that contains the necessary information to create a data set.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the data set series in which the data set is to be created.
dataSet	DataSet [1]	Metadata about the created data set.

CreateDataSetReply

Message that responds to a previously sent CreateDataSetsRequest message, with a status code, and information about the created data set if creation was successful.

Inherits from Reply message

Property name	Type, Multiplicity	Definition
dataSet	DataSet [0..1]	Metadata about the created data set.

UploadDataSetFileRequest

Message that provides the content of the file to be uploaded.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the data set for which the file is uploaded.
fileContent	FileContent [1]	The file to be uploaded.

UploadDataSetFileReply

Message that responds to a previously sent UploadDataSetFileRequest message, with a status code, and the file object in case of success.

Inherits from Reply message

Property name	Type, Multiplicity	Definition

UploadDPSFileRequest

Message that provides the content of the file to be uploaded.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the data set series for which the file is uploaded.
fileContent	FileContent [1]	The file to be uploaded.

UploadDPSFileReply

Message that responds to a previously sent UploadDPSFileRequest message, with a status code, and the file object in case of success.

Inherits from Reply message

Property name	Type, Multiplicity	Definition

WithdrawDataSetSeriesRequest

Message that provides the identifier of a DataSetSeries to withdraw.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the data set series to be withdrawn.

WithdrawDataSetSeriesReply

Message that responds to a previously sent WithdrawDataSetSeriesRequest message, with a status code.

Inherits from Reply message

Property name	Type, Multiplicity	Definition

WithdrawDataSetRequest

Message that provides the identifier of a data set to withdraw.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the data set to be withdrawn.

WithdrawDataSetReply

Message that responds to a previously sent WithdrawDataSetRequest message, with a status code.

Inherits from Reply message

Property name	Type, Multiplicity	Definition

UpdateDataSetSeriesRequest

Message to update a data set series.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the data set series to be updated.
dataSetSeries	DataSetSeries [1]	Updated metadata about the data set series.

UpdateDataSetSeriesReply

Message that responds to a previously sent UpdateDataSetSeriesRequest message, with a status code.

Inherits from Reply message

Property name	Type, Multiplicity	Definition

Reply

Generic reply to a request.

Property name	Definition	Type, Multiplicity
status	Status of the reply to the service request (HTTP status code).	ReplyStatus [1]

Information Definition

information definition	Aeronautical Data Set Information Definition

Filter Encoding

Info

title	Explanatory note

This field is left empty.

filter encoding

Machine-Readable Service Interface Definition

Info

title	Explanatory note

This field is left empty.

machine-readable service interface definition

Model View

Info

title	Explanatory note

This field is left empty.

model view

Abbreviations and Acronyms

abbreviations and acronyms	abbreviation	code	AIP
	abbreviation	term	Aeronautical Information Publication
	abbreviation	code	AIS
	abbreviation	term	Aeronautical Information Services
	abbreviation	code	DPS
	abbreviation	term	Data Product Specification
	abbreviation	code	HTTP
	abbreviation	term	Hypertext Transfer Protocol
	abbreviation	code	ICAO
	abbreviation	term	International Civil Aviation Organisation
	abbreviation	code	SWIM
	abbreviation	term	System Wide Information Management
	abbreviation	code	TI
	abbreviation	term	Technical Infrastructure
	abbreviation	code	WS
	abbreviation	term	Web Service
	abbreviation	code	YP
	abbreviation	term	Yellow Profile

Appendix A: References

references	reference	title	Publish/Subscribe Push MEP: Implementation Guidance
		version	JULY 2nd, 2019
		description	Guidelines on implementing the publish subscribe message exchange patterns
		url	http://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.htm
		document type

Version	Old Version 7	New Version Current
Changes made by	WILSON Scott	WILSON Scott
Saved on	2022 Jun 01	2024 Sept 23

Page Comparison

Versions Compared

Key

Document metadata

Service Identification

Service Abstract

Service Definition Identification

Service Identification

Service Abstract

Service Definition Provider

Geographical Extent of Information

Service Categories

Operational Environment

Service Standard Reference

Operational Environment

Functionality

Access and Use Conditions

Service Policies

Pricing policy

Service Functions

Service Access and Use Conditions

Security Constraints

Authorisation

Quality of Service

Abbreviations

Interfaces

Quality of Service

Quality of Data

Source of Information

Service Validation Information

Application Message Exchange Pattern

Service Behaviour

Service Monitoring

Service Interfaces

Operations

SWIM TI Profile and Interface Bindings

Service Interface Protocols and Data Format

Service Operations

Service Messages

Behaviour

Supporting diagrams

Information definition

Exchange schema

Technical Constraint

References

CreateDataSetSeriesRequest

CreateDataSetSeriesReply

CreateDataSetRequest

CreateDataSetReply

UploadDataSetFileRequest

UploadDataSetFileReply

UploadDPSFileRequest

UploadDPSFileReply

WithdrawDataSetSeriesRequest

WithdrawDataSetSeriesReply

WithdrawDataSetRequest

WithdrawDataSetReply

UpdateDataSetSeriesRequest

UpdateDataSetSeriesReply

Reply

Information Definition

Filter Encoding

Machine-Readable Service Interface Definition

Model View

Abbreviations and Acronyms

Appendix A: References