Service Definition Identification

service definition identification	title	Aeronautical Dataset Publication Service DefinitionService definition for the Aeronautical Data Set Management Service
	edition	000.206.200
	reference date	20222024-0609-2123

Table of Contents

maxLevel	1
type	flat

Service Identification

service identification	service name	Aeronautical Dataset Publication	version	1.0.0Data Set Management Service

Service Abstract

service abstract

The Aeronautical

Dataset Publication service

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

datasets

data sets, customised

datasets

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 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
	abbreviated namedescription	EUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States.
	point of contact	ais.aixm@eurocontrol.int
description	author

Geographical Extent of Information

Info

title	Explanatory note

This field is left empty.

tbd

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

Support datasets

operational environment

operational needs

Support 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

data sets for specific purposes.

Service Functions

functionnameAdd dataset seriesdescription

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

Service Access and Use Conditions

TBDTBDTBD

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

Security Constraints

security constraints	authentication	confidentiality	integrity	Consumer side authentication: TBD Provider side authentication: Authentication is required
	authorisation	The service does not provide any form of restriction on access on datasets or dataset series. Id est, a user that has access to one dataset has access to all available datasets.
	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

2000 service requests per hour

response time
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.

2s delay for 95% of messagesrecoverabilitysecurity

confidentiality

integrity

reliability	availability
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.

99.97 % outside the planned outages

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

modifications

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_RESPONSEREPLY

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 dataset data set series A typical sequence where the service consumer is an AIS data provider.to add a data set series is: The service consumer requests dataset 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 checks that the dataset data set series he wants to add be added is not yet present. The service consumer creates the dataset data set series metadata. Optionally, the service consumer uploads a data product specification file. add dataset filedata set A typical sequence where the service consumer is an AIS data provider.to add a data set is: The service consumer requests dataset 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 data set series to which the datasetdata set(s) need to be addadded. The service consumer requests datasets data sets from the selected dataset data set series, possibly supplying additional selection criteria, and receives back a list of containing zero, one or more datasetsdata sets. The service consumer checks that the dataset he wants to add data set to be added is not yet present. The service consumer creates the dataset data set metadata within the selected dataset data set series. The service consumer uploads dataset data set file for the newly created datasetdata set. In case of a dataset data set with multiple files, the upload operation is repeated for each file.
service behaviour	exception handling	The services makes shall make use of the standard HTTP status codes.

Service Monitoring

service monitoring

There is no service monitoring mechanism available to service consumers.

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

specification

profile version

Edition Number

selected service interface binding
1.1

SWIM_TI_YP_1_1_

selected network interface binding
WS_LIGHT

supported optional requirements

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

createDataSetSeries
description	The operation accepts metadata for a

dataset

data set series, stores it as a new

dataset

messages
data set series, and returns the stored object.

CreateDatasetSeriesRequest

CreateDataSetSeriesRequest,

CreateDatasetSeriesReply

CreateDataSetSeriesReply

resources

Resource: /datasetseries

Output: [0..1] dataset series object

operation

operation name

createDataset

createDataSet
description	The operation accepts metadata for a

dataset

data set, stores it as a new

dataset

messages
data set, and returns the stored object.

CreateDatasetRequest

CreateDataSetRequest,

CreateDatasetReply

CreateDataSetReply

resources

Resource: /datasetseries/{ID}

Output: [0..1] dataset object

operation

operation name

uploadDatasetFile

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

UploadDatasetFileRequest

UploadDatSetFileRequest,

UploadDatasetFileReply

	messages
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.

UploadDatasetFileRequest

UploadDPSFileRequest,

UploadDatasetFileReply

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

updateDatasetSeries

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

dataser

operation	operation name
data set series.
messages	UpdateDataSetSeriesRequest, UpdateDataSetSeriesReply
resources	Resource: /datasetseries

deleteDatasetSeries

withdrawDataSetSeries
description	The operation accepts the id of a given

dataset

data set series, validates the request and

deletes

withdraws the

dataset

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

Pre-conditionmessagesDeleteDatasetSeriesRequest, DeleteDatasetSeriesReply

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

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

deleteDataset

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

messages

DeleteDatasetRequest

WithdrawDataSetRequest,

DeleteDatasetReply

WithdrawDataSetReply
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 data set series to be created.Note: the id will be disregarded.

CreateDatasetSeriesReply

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

referenceinformation definition	Aeronautical Data Set Information Definition

Filter Encoding

tbd

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

term

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

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 22	New Version Current
Changes made by	WILSON Scott	WILSON Scott
Saved on	2022 Jun 27	2024 Sept 23

real-world effect
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.

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

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 Monitoring

InfotitleExplanatory noteThis field is left empty.service monitoring

Service Interfaces

SWIM TI Profile and Interface Bindings

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

InfotitleExplanatory noteThis field is left empty.filter encoding

Machine-Readable Service Interface Definition

Model View

Abbreviations and Acronyms

Annex: Supporting Diagrams

Summary

Image RemovedService Behaviour

Message Types

Appendix A: References

Info
title Explanatory note
This field is left empty.

service monitoring

Info
title Explanatory note
This field is left empty.

filter encoding

Image Removed
Service Behaviour