Service Definition Identification

service definition identification	title	Service definition for the Aeronautical Data Set Management Service
	edition	000.06.400
	reference date	20232024-0509-1723

Table of Contents

maxLevel	1
type	flat

Service Identification

version

service identification	service name	Aeronautical Data Set Management Service		1.0.0

Service Abstract

service abstract

The Aeronautical Data Set Management Service allows an aeronautical information service (AIS) to upload and manage ICAO Annex 15 digital data sets, customised datasets data sets and accompanying metadata within a data set store.

The service provides support for the management of data set series, data sets and data product specifications.

The service is part of a series of services that supports the provision of digital data 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

service categories	category	category name	Information Domain
		value	AERONAUTICAL_INFORMATION
		scheme	https://reference.swim.aero/information-services/service-categories/CodeInformationDomainType
	category	category name	intended service provider
		value	AERONAUTICAL_INFORMATION_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
		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;
Aerodrome mapping data set;
Instrument flight procedure data set

The service supports the publication of customised digital datasets data sets for specific purposes.

Service Functions

operational policy

technical policy

service consumption constraints

Security Constraints

security constraints

authentication

Consumer and provider authentication shall be ensured.

The service shall ensure consumer authentication in accordance with the

service functions	function	name	Add dataset Publish and manage data set series
		description	The service consumer shall be to add a dataset series with its corresponding metadata.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 dataset The data set series is addedpublished and managed.
	function	name	Add datasetPublish and manage data set
		description	The service consumer shall be to add a dataset within a dataset series, with 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 dataset is addedThe data set is published and managed.
	function	name	Add data Publish and managedata product specification
		description	The service consumer shall be to add a able topublish and manage (e.g., update/withdraw)data product specification.
		real-world effect	the The data product specification is added
function	name	Delete dataset series
	description	The service consumer shall be to delete a dataset series with its corresponding metadata.
	real-world effect	the dataset series is removed
function	name	Delete dataset
	description	The service consumer shall be to delete a dataset within a dataset series, with its corresponding metadata and files
	real-world effect	the dataset is removed
function	name	Delete data product specification
	description	The service consumer shall be to delete a data product specification
	real-world effect	the data product specification is removed

Service Access and Use Conditions

service access and use conditions

legal constraints

service policies

business policy

The service does not support the possibility to indicate a price for a data set or a data set series.

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	Consumer 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 dataset data set shall meet the data quality requirements outlined in ICAO Annex 15. The data contained in the digital dataset 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 datasets 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

add dataset series

A typical sequence 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

A typical sequence where the service consumer is an AIS data provider.

The service consumer requests dataset

application message exchange pattern	service behaviour	typical behaviour	SYNCHRONOUS_REQUEST_RESPONSE

Service Behaviour

REPLY

Service Behaviour

service behaviour	typical behaviour

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 bindingThe service shall use the network bindings of the SWIM TIYP.

supported optional requirements

Service Interface Protocols and Data Format

The service shall use TLS1.2 or later in accordance with

service interface protocols and data format	transport / messaging protocols	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 with containing zero, one or more dataset data set series objects . The service consumer analyses that list to identify the dataset series to which the dataset(s) need be add.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 datasets from the selected dataset series, possibly supplying additional data set series based on a number of selection criteria, and receives back a list of containing zero, one or more datasetsdata set series. The service consumer checks that the dataset he wants to add is not yet presentanalyses that list to identify the data set series to which the data set(s) need to be added. The service consumer creates the dataset metadata within requests data sets from 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.
service interface protocols and data format	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 interfacesinterface

name

Publish

description

The interface allows the publication and management of dataset (series) and dataset files.

provider/consumer side

PROVIDER_SIDE_INTERFACE

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.

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 data set (series) and data set files.

provider/consumer side

PROVIDER_SIDE_INTERFACE

SWIM TI Profile and Interface Bindings

SWIM TI profile and interface bindings	profile name	EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile

.data formatXML

Service Operations

service operationsoperation

operation name

createDatasetSeries

description

The operation accepts metadata for a dataset series, stores it as a new dataset series, and returns the stored object.

messages

CreateDatasetSeriesRequest, CreateDatasetSeriesReply

resources

Resource: /datasetseries

Output: [0..1] dataset series object


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

createDataset dataset datasetCreateDatasetRequest CreateDatasetReplyuploadDatasetFile a file and returns a file objectUploadDatasetFileRequest UploadDatasetFileReply

service operations	operation	operation name	createDataSetSeries
		description	The operation accepts metadata for a	data set series, stores it as a new	data set series, and returns the stored object.
		messages	CreateDataSetSeriesRequest,	CreateDataSetSeriesReply
		resources	Resource: /datasetseries/{ID} Output: [0..1] dataset series object
	operation	operation name	createDataSet
		description	The operation accepts	metadata for a data set, stores it as a new data set, and returns the stored object.
		messages	CreateDataSetRequest,	CreateDataSetReply
		resources	Resource: /datasetsdatasetseries/{ID}/files Output: [0..1] file dataset object
	operation	operation name	uploadDPSFileuploadDataSetFile
		description	The operation accepts a file and returns a file object.
		messages	UploadDatasetFileRequestUploadDatSetFileRequest, UploadDatasetFileReplyUploadDataSetFileReply
		resources	resources	Resource: /datasetseriesResource: /datasetseriesdatasets/{ID}/dpsfiles Output: [0..1] file object
	operation	operation name	updateDatasetSeries
		description	The operation allows a user to update the metadata for an existing dataset series.
		messages	UpdateDataSetSeriesRequest, UpdateDataSetSeriesReply
		object
	operation	operation name	deleteDatasetSeriesuploadDPSFile
		description	The operation accepts the id of a given dataset series, validates the request and deletes the dataset 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	DeleteDatasetSeriesRequest, DeleteDatasetSeriesReply a file and returns a file object.
		messages	UploadDPSFileRequest, UploadDPSFileReply
		resources	Resource: /datasetseries/{ID}/dps Output: [0..1] file object
	operation	operation name	updateDataSetSeries
		description	The operation allows a user to update the metadata for an existing data set series.
		messages	UpdateDataSetSeriesRequest, UpdateDataSetSeriesReply
		resources	Resource: /datasetseries
	operation	operation name	withdrawDataSetSeries
		description	The operation accepts the id of a given data set series, validates the request and withdraws the data set series together with its data product specification if any.
		messages	WithdrawDataSetSeriesRequest, WithdrawDataSetSeriesReply
		resources	Resource: /datasetseries/{ID}
operation	operation name	deleteDatasetwithdrawDataSet
	description	The operation accepts the id of a given datasetdata 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
	messages	DeleteDatasetRequestWithdrawDataSetRequest, DeleteDatasetReplyWithdrawDataSetReply
	resources	Resource: /datasets/{ID}

Service Messages

CreateDatasetSeriesRequest

CreateDataSetSeriesRequest

Message that contains the necessary information to create a Dataset Seriesdata set series

Property name	Type, Multiplicity	Definition
datasetSeriesdataSetSeries	DatasetSeries DataSetSeries [1]	Information about the dataset series to be created. Note: the id will be disregarded.

CreateDatasetSeriesReply

data set series to be created.

CreateDataSetSeriesReply

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

Inherits from Reply message

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

CreateDatasetRequest

CreateDataSetRequest

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

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the dataset data set series in which the dataset data set is to be created.
datasetdataSet	Dataset DataSet [1]	Metadata about the created datasetdata set.Note: the id will be disregarded.

CreateDatasetReply

CreateDataSetReply

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

Inherits from Reply message

Property name	Type, Multiplicity	Definition
datasetdataSet	Dataset DataSet [0..1]	Metadata about the created datasetdata set.

UploadDatasetFileRequest

UploadDataSetFileRequest

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

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

UploadDatasetFileReply

UploadDataSetFileReply

Message that responds to a previously sent UploadDatasetFileRequest 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 dataset series for 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

DeleteDatasetSeriesRequest

WithdrawDataSetSeriesRequest

Message that provides the identifier of a DatasetSeries DataSetSeries to deletewithdraw.

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

DeleteDatasetSeriesReply

WithdrawDataSetSeriesReply

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

Inherits from Reply message

Property name	Type, Multiplicity	Definition

DeleteDatasetRequest

WithdrawDataSetRequest

Message that provides the identifier of a Dataset data set to deletewithdraw.

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

DeleteDatasetReply

WithdrawDataSetReply

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

Inherits from Reply message

Property name	Type, Multiplicity	Definition

UpdateDatasetSeriesRequest

UpdateDataSetSeriesRequest

Message to update a dataset data set series.

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

UpdateDatasetSeriesReply

UpdateDataSetSeriesReply

Message that responds to a previously sent UpdateDatasetSeriesRequest 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.

See Annex: Supporting Diagrams

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

Annex: Supporting Diagrams

Summary

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

Image Removed
Service Behaviour

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

Message Types

The diagram below gives an overview of message types.

Image Removed

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 30	New Version Current
Changes made by	WILSON Scott	WILSON Scott
Saved on	2023 May 17	2024 Sept 23

Page Comparison

Versions Compared

Key

Service Definition Identification

Service Identification

Service Abstract

Service Definition Provider

Geographical Extent of Information

Service Categories

Service Standard Reference

Operational Environment

Service Functions

Security Constraints

Service Access and Use Conditions

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

Service Behaviour

SWIM TI Profile and Interface Bindings

Service Interface Protocols and Data Format

Service Monitoring

Service Interfaces

Service Monitoring

Service Interfaces

SWIM TI Profile and Interface Bindings

Service Operations

Service Interface Protocols and Data Format

Service Operations

Service Messages

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

Annex: Supporting Diagrams

Summary

Image RemovedService Behaviour

Message Types

Appendix A: References

Image Removed
Service Behaviour