Document metadata

Service Definition Identification

title	Aeronautical Dataset Publication Service Definition
edition	0.20
reference date	2020-09-17

children

Table of Contents

depth

maxLevel	2
type	flat

Service Identification

service name	Aeronautical Dataset Publication
version	1.0.0

Service Abstract

The Aeronautical Dataset Publication service allows an aeronautical information service (AIS) to upload and manage ICAO Annex 15 digital 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	tbd
abbreviated name	tbd
description	tbd

Geographical Extent of Information

tbd

Service Categories

information exchange area

category

value(s)

category name

Regulated Information Exchange

value

AERONAUTICAL_INFORMATION_EXCHANGE

business activity

INFORMATION_MANAGEMENT


scheme	http://reference.swim.aero/information-services/service-categories/CodeRegulatedInformationExchangeType
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

Operational Environment

NameDescriptionICAO Operational Need


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

Extended Operational NeedSupport

Support the publication of digital datasets 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.

Service Functions

Functionality

function	name

description

real world effect

	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

Service Policies

Pricing

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

Constraints

Authentication

authentication

Consumer side authentication: TBD

Provider side authentication: Authentication is required

TBD

Authorisation

authorisation	The service

is subject to authorisation.

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

Availability

Publish
performance
capacity
2000 service requests per hour
response time 2s delay for 95% of messages
reliability
availability
99.95 % outside the planned outages Schedule of planned outages: {}http://www.donlon-airport.com/swim/planned-outages
recoverability
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

security	confidentiality
security	integrity

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

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)

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.

interface provision

provider/consumer side	PROVIDER_SIDE_INTERFACE

network address

N/A (provider-independent)

message exchange pattern

SYNCHRONOUS_REQUEST_RESPONSE

SWIM TI Profile and Interface Bindings

namedescriptiontiProtocolmessage - INmessage - OUTREST - resourcecreateDatasetSeries0 description

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


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.

HTTP POST

messages	CreateDatasetSeriesRequest, CreateDatasetSeriesReply

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.

HTTP POST

messages	CreateDatasetRequest, CreateDatasetReply

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

HTTP POST

messages	UploadDatasetFileRequest, 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, UploadDatasetFileReply

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.

HTTP POST

messages	UpdateDataSetSeriesRequest, UpdateDataSetSeriesReply

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

HTTP DELETE

messages	DeleteDatasetSeriesRequest, DeleteDatasetSeriesReply

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

HTTP DELETE

messages	DeleteDatasetRequest, DeleteDatasetReply

DeleteDatasetReply

resources	Resource: /datasets/{ID}

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

Service Messages

message	name
	description
	type
message	name
	description
	type

Information Definition

name
Information Definition

Filter Encoding

tbd

Machine-Readable Service Interface Definition

machine-readable service interface definition

Model View

model view

Abbreviations and Acronyms

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

Annex: Supporting Diagrams

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

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

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

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

Version	Old Version 7	New Version 8
Changes made by	WILSON Scott	WILSON Scott
Saved on	2022 Jun 01	2022 Jun 01

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

reliability	recoverability
performance	capacity	2000 service requests per hour
performance	response time	2s delay for 95% of messages
reliability	availability	99.95 % outside the planned outages Schedule of planned outages: {}http://www.donlon-airport.com/swim/planned-outages

Page Comparison

Versions Compared

Key

Service Definition Identification

Service Identification

Service Abstract

Service Definition Provider

Geographical Extent of Information

Service Categories

Operational Environment

Service Standard Reference

Operational Environment

Service Functions

Service Access and Use Conditions

Service Policies

legal constraintsTBDservice policiesbusiness policyThe service does not support the possibility to indicate a price for a data set or a data set series.operational policyTBDtechnical policyTBDservice consumption constraintsTBD

Security

Constraints

Quality of Service

Abbreviations

Interfaces

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

Operations

Service Interface Protocols and Data Format

Service Operations

Behaviour

Service Messages

Information Definition

Filter Encoding

Machine-Readable Service Interface Definition

Model View

Abbreviations and Acronyms

Annex: Supporting Diagrams

Information definition

Exchange schema

Technical Constraint

References

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