Service Definition Identification

title	Aeronautical Dataset Publication Service Definition
edition	0.2.2
reference date	2022-06-21

Service Identification

service name	Aeronautical Dataset Publication
version	1.0.0

Service Abstract

service abstract

The Aeronautical Dataset Publication 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

name	EUROCONTROL
abbreviated name	ais.aixm@eurocontrol.int
description	author

Geographical Extent of Information

geographical extent of information	tbd

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

Service Standard Reference

reference
implemented options
deviations/additions

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;
Airport mapping data set;
Instrument flight procedure data set

Support the publication of customised digital datasets for specific purposes.

Service Functions

function	name	Add dataset series
	description	Allow a service consumer to add a dataset series with its corresponding metadata.
		the dataset series is added
function	name	Add dataset
	description	Allow a service consumer 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	Allow a service consumer to add a data product specification
	real-world effect	the data product specification is added
function	name	Delete dataset series
	description	Allow a service consumer to delete a dataset series with its corresponding metadata.
	real-world effect	the dataset series is removed
function	name	Delete dataset
	description	Allow a service consumer 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	Allow a service consumer to delete a data product specification
	real-world effect	the data product specification is removed

Service Access and Use Conditions

legal constraints		TBD
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	TBD
	technical policy	TBD
service consumption constraints		TBD

Security Constraints

authentication	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.
confidentiality
integrity

Quality of Service

performance	capacity	2000 service requests per hour
performance	response time	2s delay for 95% of messages
reliability	availability	99.97 % outside the planned outages
reliability	recoverability
security	confidentiality
security	integrity

Quality of Data

quality of data	tbd

Source of Information

source
modifications

Service Validation Information

validation performed
method used
summary of the validation steps performed
results achieved
how the service consumer may obtain the validation evidence

Application Message Exchange Pattern

application message exchange pattern	SYNCHRONOUS_REQUEST_RESPONSE

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.

exception handling

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

Service Monitoring

service monitoring	There is no service monitoring mechanism available to service consumers.

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

profile name	TI Yellow Profile specification
profile version	Edition Number 1.1
selected service interface binding	SWIM_TI_YP_1_1_WS_LIGHT
selected network interface binding
supported optional requirements

Service Interface Protocols and Data Format

transport / messaging protocols	HTTP
data format

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

reference	Information Definition

Filter Encoding

tbd

Machine-Readable Service Interface Definition

machine-readable service interface definition

Model View

model view	See Annex: Supporting Diagrams

Abbreviations and Acronyms

abbreviation	term
AIP	Aeronautical Information Publication
AIS	Aeronautical Information Services
DPS	Data Product Specification
HTTP	Hypertext Transfer Protocol
ICAO	International Civil Aviation Organisation
SWIM	System Wide Information Management
TI	Technical Infrastructure
WS	Web Service
YP	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 Publication 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