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 | ||||
---|---|---|---|---|
|
Service Identification
service identification | service name | Aeronautical Dataset Publication |
---|---|---|
version | 1.0.0 | |
Data Set Management Service |
Service Abstract
service abstract |
---|
The Aeronautical Data Set Management Service allows an aeronautical information service (AIS) to upload and manage ICAO Annex 15 digital |
data sets, customised data sets and accompanying metadata within a |
data set store. The service provides support for the management of |
data set series, |
data sets and data product specifications. |
The service is part of a series of services that |
supports the |
provision of |
digital data |
sets as defined by ICAO Annex 15. |
Service Definition Provider
service definition provider | name | EUROCONTROL | ||
---|---|---|---|---|
description | EUROCONTROL | abbreviated nameis 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 | ||
---|---|---|
| ||
This field is left empty. |
geographical extent of information |
---|
Service Categories
service categories | category | category name | Regulated Information ExchangeDomain |
---|---|---|---|
value | AERONAUTICAL_INFORMATION_EXCHANGE | ||
scheme | httphttps://reference.swim.aero/information-services/service-categories/CodeRegulatedInformationExchangeTypeCodeInformationDomainType | ||
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 | ||
---|---|---|
| ||
This field is left empty. |
service standard reference | reference | |
---|---|---|
implemented options | ||
deviations/additions |
Operational Environment
operational environment | operational needs | SupportThe 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:
| Airport upport
| SThe 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
service functions | function | name |
---|
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 data set series is |
published and managed. | |
function | name |
---|
Publish and manage data set |
description |
---|
The service consumer |
shall be able topublish and manage (e.g., update/withdraw) data sets within a data set series including its corresponding metadata and |
files. |
real-world effect |
---|
The data set is published and managed. | |
function | name |
---|
Publish and managedata product specification |
description |
---|
The service consumer |
shall be able topublish and manage (e.g., update/withdraw)data product specification. |
real-world effect |
---|
The data product specification is |
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 | confidentiality | integrityConsumer 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 |
---|
The service shall achieve a quality that is sufficient to ensure the service is fit for purpose. |
response time |
---|
confidentiality
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*
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. |
integrity | The service shall ensure integrity by using SWIM Technical Infrastructure (TI) Yellow Profile bindings. |
Quality of Data
quality of data |
---|
Source of Information
source of information | source | modificationsThe service shall accept digital data sets from the appropriate authorised originating sources, e.g., |
---|
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:
add dataset filedata set A typical sequence where the service consumer is an AIS data provider.to add a data set is:
|
---|---|---|
exception handling | The services shall make use of the standard HTTP status code (details to come later)codes. |
Service Monitoring
service monitoring
Info | ||
---|---|---|
| ||
This field is left empty. |
service monitoring |
---|
Service Interfaces
service interfaces | interface | name | Publish |
---|---|---|---|
description | The interface allows the publication and management of |
data set (series) and |
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 |
---|
profile version |
---|
1.1 |
selected service interface binding |
---|
selected network interface binding |
---|
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 format | XML |
Service Operations
service operations | operation | operation name |
---|
createDataSetSeries | |
description | The operation accepts metadata for a |
---|
data set series, stores it as a new |
data set 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 |
---|
data set, stores it as a new |
data set, 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 |
UploadDatSetFileRequest, |
UploadDataSetFileReply | ||
resources | Resource: /datasets/{ID}/files | |
---|---|---|
operation | operation name | uploadDPSFile |
description | The operation accepts a file and returns a file object. | |
messages |
UploadDPSFileRequest, |
UploadDPSFileReply | |
resources | Resource: /datasetseries/{ID}/dps |
---|---|
operation | operation name |
updateDataSetSeries | |
description | The operation allows a user to update the metadata for an existing |
---|
data set series. | |
messages | UpdateDataSetSeriesRequest, UpdateDataSetSeriesReply |
---|---|
resources | Resource: /datasetseries |
operation | operation name |
withdrawDataSetSeries | |
description | The operation accepts the id of a given |
---|
data set series, validates the request and |
withdraws the |
data set series together with its data product specification if any |
There are no datasets related to the dataset series
. |
Post-condition
The dataset series and the related data product specification are deleted
messages | WithdrawDataSetSeriesRequest, WithdrawDataSetSeriesReply |
---|---|
resources | Resource: /datasetseries/{ID} |
operation | operation name |
withdrawDataSet | |
description | The operation accepts the id of a given |
---|
data set, validates the request and |
withdraws the |
data set together with its |
data set file(s). |
The dataset and the related dataset files are deleted
messages |
---|
WithdrawDataSetRequest, |
WithdrawDataSetReply | |
resources | Resource: /datasets/{ID} |
---|
Service Messages
CreateDatasetSeriesRequestCreateDataSetSeriesRequest
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
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
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
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
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
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 |
---|
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. |
WithdrawDataSetSeriesReply
Message that responds to a previously sent DeleteDatasetSeriesRequest WithdrawDataSetSeriesRequest message, with a status code.
Inherits from Reply message
Property name | Type, Multiplicity | Definition |
---|
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. |
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
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
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
tbdInfo | ||
---|---|---|
| ||
This field is left empty. |
filter encoding |
---|
Machine-Readable Service Interface Definition
Info | ||
---|---|---|
| ||
This field is left empty. |
machine-readable service interface definition |
---|
Model View
Info | ||
---|---|---|
| ||
This field is left empty. |
model view |
---|
Abbreviations and Acronyms
abbreviations and acronyms | abbreviation | termcode | AIP |
---|---|---|---|
term | Aeronautical Information Publication | ||
AIRAC | Aeronautical Information Regulation and Control | ||
AIRM | ATM Information Reference Model | ||
abbreviation | code | AIS | |
term | Aeronautical Information Services | ||
ANSP | Air Navigation Service Provider | ||
ATM | Air Traffic Management | ||
abbreviation | code | DPS | |
term | Data Product Specification | ||
abbreviation | code | HTTP | |
term | Hypertext Transfer Protocol | ||
abbreviation | code | ICAO | |
term | International Civil Aviation OrganisationIER | ||
abbreviation | Information Exchange Requirement | ||
PJ03a-04 | SESAR 2020 project on "enhanced visual operations" | ||
SESAR | Single European Sky ATM Research Programme | ||
SWIM | code | SWIM | |
term | System Wide Information Management | ||
UTC | Coordinated Universal Time | ||
WS | Web Service | ||
XSD | XML Schema Definition |
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.
abbreviation | code | TI |
---|---|---|
term | Technical Infrastructure | |
abbreviation | code | WS |
term | Web Service | |
abbreviation | code | YP |
term | Yellow Profile |
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 |