Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Service Definition Identification

service definition identification

title

Aeronautical Dataset Publication Service DefinitionService definition for the Aeronautical Data Set Management Service

edition

000.06.2000

reference date

20202024-09-1723


Table of Contents
maxLevel21
typeflat

Service Identification

service identification

service name

Aeronautical Dataset Publication

version

1.0.0Data Set Management Service

Service Abstract

The Aeronautical Dataset Publication service
service abstract

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

datasets

data sets, customised 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

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 providername
tbdtbd
EUROCONTROL
abbreviated nametbddescription

descriptionEUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States.

point of contactais.aixm@eurocontrol.int

Geographical Extent of Information

tbd
Info
titleExplanatory note

This field is left empty.


geographical extent of information

Service Categories

service categoriescategorycategory name
Regulated

Information

Exchange

Domain

value

AERONAUTICAL_INFORMATION

_EXCHANGE

scheme
http

https://reference.swim.aero/information-services/service-categories/

CodeRegulatedInformationExchangeType

CodeInformationDomainType

categorycategory name

intended service provider

value

AERONAUTICAL_INFORMATION_SERVICE_PROVIDER

scheme

http://reference.swim.aero/information-services/service-categories/CodeStakeholderType

categorycategory name

Business Activity

value

INFORMATION_MANAGEMENT

scheme

http://reference.swim.aero/information-services/service-categories/CodeBusinessActivityType

categorycategory name

intended service consumer

value

AERONAUTICAL_INFORMATION_SERVICE_PROVIDER

scheme

http://reference.swim.aero/information-services/service-categories/CodeStakeholderType

categorycategory nameservice type
valueAERONAUTICAL_DATA_PRODUCT_ACCESS_SERVICE
scheme

http://reference.swim.aero/information-services/service-categories/CodeServiceType


Service Standard Reference

Info
titleExplanatory note

This field is left empty.


service standard referencereference
implemented options
deviations/additions

Operational Environment

operational
needsSupport
environmentoperational needsThe 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;
Airport upport
  • Aerodrome mapping data set;
  • Instrument flight procedure data set
S

The service supports the publication of customised digital

datasets

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

functionnameAdd dataset series

descriptionAllow a service consumer to add a dataset series with its corresponding metadata.the dataset series is added
descriptionAllow a service consumer to add a dataset within a dataset series, with its corresponding metadata and filesreal-world effectthe dataset is addedfunctionnameAdd 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 functionsfunctionname
Add dataset
Publish and manage data set series
descriptionThe 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.
functionname
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.
functionname
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

service access and use conditions



legal constraints

TBD



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

TBD

technical policy

TBD

service consumption constraints

TBD


Security Constraints

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

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

tbd
performance

capacity

2000 service requests per hour

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

response time
2s delay for 95% of messages
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
reliability

availability

99.95 % outside the planned outages Schedule of planned outages: {*}http://www.donlon-airport.com/swim/planned-outages*

recoverabilitysecurity

confidentiality

integrity

Quality of Data

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

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

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

source
modifications
of informationsource

The service shall accept digital data sets from the appropriate authorised originating sources, e.g.,

Service Validation Information

service validation informationvalidation performedThe service was prototyped in 2021.
method usedUSER_VALIDATION
summary of the validation steps performed
results achievedThe service operations and information definition were tested. However, the quality of service was not tested.
how the service consumer may obtain the validation evidencehttps://ext.eurocontrol.int/aixm_confluence/display/ADS/EUROCONTROL+prototype

Application Message Exchange Pattern


application message exchange pattern

SYNCHRONOUS_REQUEST_
RESPONSE
REPLY

Service Behaviour

service behaviourtypical behaviour
add dataset

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

is illustrated below (in text and graphically), 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 file

data set

A typical sequence

is illustrated below (in text and graphically), 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
dataset
    • data set(s) need to be
add
    • added.
  • 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
datasets
  • data 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
dataset
  • data set.
    • In case of a
dataset
    • data set with multiple files, the upload operation is repeated for each file.
exception handlingThe services shall make use of the standard HTTP status
code (details to come later)
codes.

Service Monitoring

service monitoring

There is no service monitoring mechanism available to service consumers.

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

1.1

selected service interface binding

SWIM_TI_YP_1_1_

WS_LIGHT

selected network interface binding
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.
data formatXML

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
data set series, and returns the stored object.

messages

CreateDatasetSeriesRequest

CreateDataSetSeriesRequest,

CreateDatasetSeriesReply

CreateDataSetSeriesReply

resources

Resource: /datasetseries

Output: [0..1] dataset series object

operation


operation name

createDataset
createDataSet
descriptionThe operation accepts metadata for a
dataset
data set, stores it as a new
dataset
data set, and returns the stored object.
messages
CreateDatasetRequest
CreateDataSetRequest,
CreateDatasetReply
CreateDataSetReply
resources

Resource: /datasetseries/{ID} 

Output: [0..1] dataset object

operationoperation name
uploadDatasetFile
uploadDataSetFile
descriptionThe operation accepts a file and returns a file object.
messages
UploadDatasetFileRequest
UploadDatSetFileRequest,
UploadDatasetFileReply
UploadDataSetFileReply
resources

Resource: /datasets/{ID}/files
Output: [0..1] file object

operationoperation nameuploadDPSFile
descriptionThe operation accepts a file and returns a file object.
messages
UploadDatasetFileRequest
UploadDPSFileRequest,
UploadDatasetFileReply
UploadDPSFileReply
resources

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

operationoperation name
updateDatasetSeries
updateDataSetSeries
descriptionThe operation allows a user to update the metadata for an existing
dataser
data set series.
messagesUpdateDataSetSeriesRequest, UpdateDataSetSeriesReply
resources

Resource: /datasetseries

operationoperation name
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-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
WithdrawDataSetSeriesRequest,
DeleteDatasetSeriesReply
WithdrawDataSetSeriesReply
resources

Resource: /datasetseries/{ID}

operationoperation name
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
resourcesResource: /datasets/{ID}

Service Messages

CreateDataSetSeriesRequest

Message that contains the necessary information to create a data set series

Property nameType, MultiplicityDefinition
dataSetSeriesDataSetSeries [1]

Information about the data set series to be created.

CreateDataSetSeriesReply

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

Inherits from Reply message

Property nameType, MultiplicityDefinition
dataSetSeriesDataSetSeries [0..1]

Metadata about the created data set series.

CreateDataSetRequest

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

Property nameType, MultiplicityDefinition
identifierIdentifierType [1]

Identifier of the data set series in which the data set is to be created.

dataSetDataSet [1]

Metadata about the created data set.

CreateDataSetReply

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

Inherits from Reply message

Property nameType, MultiplicityDefinition
dataSetDataSet [0..1]

Metadata about the created data set.

UploadDataSetFileRequest

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

Property nameType, MultiplicityDefinition
identifierIdentifierType [1]

Identifier of the data set for which the file is uploaded.

fileContentFileContent [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 nameType, MultiplicityDefinition



UploadDPSFileRequest

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

Property nameType, MultiplicityDefinition
identifierIdentifierType [1]

Identifier of the data set series for which the file is uploaded.

fileContentFileContent [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 nameType, MultiplicityDefinition



WithdrawDataSetSeriesRequest

Message that provides the identifier of a DataSetSeries to withdraw.

Property nameType, MultiplicityDefinition
identifierIdentifierType [1]

Identifier of the data set series to be withdrawn.

WithdrawDataSetSeriesReply

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

Inherits from Reply message

Property nameType, MultiplicityDefinition



WithdrawDataSetRequest

Message that provides the identifier of a data set to withdraw.

Property nameType, MultiplicityDefinition
identifierIdentifierType [1]

Identifier of the data set to be withdrawn.

WithdrawDataSetReply

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

Inherits from Reply message

name

descriptiontypemessage

name

descriptiontype

Information Definition

nameInformation Definition

Filter Encoding

tbd
Property nameType, MultiplicityDefinition



UpdateDataSetSeriesRequest

Message to update a data set series.

Property nameType, MultiplicityDefinition
identifierIdentifierType [1]

Identifier of the data set series to be updated.

dataSetSeriesDataSetSeries [1]Updated metadata about the data set series.

UpdateDataSetSeriesReply

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

Inherits from Reply message

Property nameType, MultiplicityDefinition



Reply

Generic reply to a request.

Property nameDefinitionType, Multiplicity

status

Status of the reply to the service request (HTTP status code).

ReplyStatus [1]

Information Definition

Filter Encoding

Info
titleExplanatory note

This field is left empty.


filter encoding

Machine-Readable Service Interface Definition

Info
titleExplanatory note

This field is left empty.


machine-readable service interface definition


Model View

Info
titleExplanatory note

This field is left empty.


model view


Abbreviations and Acronyms

abbreviations and acronymsabbreviation
term

AIS

codeAIP
term

Aeronautical Information Publication

AIRAC

Aeronautical Information Regulation and Control

AIRM

ATM Information Reference Model

abbreviationcodeAIS
term

Aeronautical Information Services

ANSP

Air Navigation Service Provider

ATM

Air Traffic Management

DPS
abbreviationcodeDPS

term

Data Product Specification

abbreviationcodeHTTP
termHypertext Transfer Protocol
abbreviationcodeICAO
term

International Civil Aviation Organisation

IER

PJ03a-04

SESAR 2020 project on "enhanced visual operations"

SESAR

Single European Sky ATM Research Programme

SWIM
abbreviation

Information Exchange Requirement

codeSWIM

term

System Wide Information Management

UTC

Coordinated Universal Time
abbreviationcodeTI
termTechnical Infrastructure
abbreviationcodeWS
term

Web Service

XSD

XML Schema Definition

Annex: Supporting Diagrams

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

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

abbreviationcodeYP
termYellow Profile

Appendix A: References

references

reference

titlePublish/Subscribe Push MEP: Implementation Guidance
versionJULY 2nd, 2019
descriptionGuidelines on implementing the publish subscribe message exchange patterns
urlhttp://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.htm
document type