Service Definition Identification

service definition identification	title	Service definition for the Aeronautical Dataset Management Service
	edition	0.3
	reference date	2023-03-22

Service Identification

service identification	service name	Aeronautical Dataset Management Service
service identification	version	1.0.0

Service Abstract

service abstract

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

The service provides support for the management of dataset series, datasets and data product specifications.

The service is part of a series of services that support the concept of aeronautical information product digital data set 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

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 (for the moment use https://ext.eurocontrol.int/swim_confluence/display/SCOI/Service+Categories+-+Service+Type).

Service Standard Reference

Explanatory note

This field is left empty.

service standard reference	reference
	implemented options
	deviations/additions

Operational Environment

operational environment

operational needs

Support 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

Support the publication of customised digital datasets for specific purposes.

Service Functions

service functions	function	name	Add dataset series
		description	The service consumer shall be to add a dataset series with its corresponding metadata.
		real-world effect	the dataset series is added
	function	name	Add dataset
		description	The service consumer shall be to add a dataset within a dataset series, with its corresponding metadata and files
		real-world effect	the dataset is added
	function	name	Add data product specification
		description	The service consumer shall be to add a data product specification
		real-world effect	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.
		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. 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 shall meet the data quality requirements outlined in ICAO Annex 15. The data contained in the digital dataset 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 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_RESPONSE

Service Behaviour

service behaviour	typical behaviour	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 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.
service behaviour	exception handling	The services shall make use of the standard HTTP status codes.

Service Monitoring

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 (series) and dataset 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
	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.
	supported optional requirements

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 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
	operation	operation name	createDataset
		description	The operation accepts metadata for a dataset, stores it as a new dataset, and returns the stored object.
		messages	CreateDatasetRequest, CreateDatasetReply
		resources	Resource: /datasetseries/{ID} Output: [0..1] dataset object
	operation	operation name	uploadDatasetFile
		description	The operation accepts a file and returns a file object
		messages	UploadDatasetFileRequest, 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
		messages	UploadDatasetFileRequest, UploadDatasetFileReply
		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 dataser series.
		messages	UpdateDataSetSeriesRequest, UpdateDataSetSeriesReply
		resources	Resource: /datasetseries
	operation	operation name	deleteDatasetSeries
		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
		resources	Resource: /datasetseries/{ID}
	operation	operation name	deleteDataset
		description	The operation accepts the id of a given dataset, validates the request and deletes the dataset together with its dataset file(s). Post-condition The dataset and the related dataset files are deleted
		messages	DeleteDatasetRequest, DeleteDatasetReply
		resources	Resource: /datasets/{ID}

Service Messages

CreateDatasetSeriesRequest

Message that contains the necessary information to create a Dataset Series

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

CreateDatasetSeriesReply

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

Inherits from Reply message

Property name	Type, Multiplicity	Definition
datasetSeries	DatasetSeries [0..1]	Metadata about the created dataset series.

CreateDatasetRequest

Message that contains the necessary information to create a Dataset

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

CreateDatasetReply

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

Inherits from Reply message

Property name	Type, Multiplicity	Definition
dataset	Dataset [0..1]	Metadata about the created dataset.

UploadDatasetFileRequest

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

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the dataset 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 dataset 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

Message that provides the identifier of a DatasetSeries to delete.

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

DeleteDatasetSeriesReply

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

Inherits from Reply message

Property name	Type, Multiplicity	Definition

DeleteDatasetRequest

Message that provides the identifier of a Dataset to delete.

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

DeleteDatasetReply

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

Inherits from Reply message

Property name	Type, Multiplicity	Definition

UpdateDatasetSeriesRequest

Message to update a dataset series.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Identifier of the dataset series to be updated.
datasetSeries	DatasetSeries [1]	Updated metadata about the dataset 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	Information Definition

Filter Encoding

Explanatory note

This field is left empty.

filter encoding

Machine-Readable Service Interface Definition

Explanatory note

This field is left empty.

machine-readable service interface definition

Model View

model view	See Annex: Supporting Diagrams

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.

Service Behaviour

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

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

Message Types

The diagram below gives an overview of message types.

Aeronautical Dataset Management 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

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

DeleteDatasetSeriesRequest

DeleteDatasetSeriesReply

DeleteDatasetRequest

DeleteDatasetReply

UpdateDatasetSeriesRequest

UpdateDatasetSeriesReply

Reply

Information Definition

Filter Encoding

Machine-Readable Service Interface Definition

Model View

Abbreviations and Acronyms

Annex: Supporting Diagrams

Summary

Service Behaviour

Message Types