Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata



This is an example of service description for a fictitious TOBT setting service, with the intention to illustrate the EUROCONTROL Specification for SWIM Service Description.

Guidance

General requirements to remember:

SWIM-SERV-010Service description coverage

A service description shall describe a single service.


SWIM-SERV-020Service description languageThe textual descriptions in a service description shall be written in English using the spelling listed as the primary British spelling when conflicting spellings exist.



Service description identification


Trace

SWIM-SERV-030
service description identification

title

Donlon TOBT Setting Service Description

edition

0.93i

reference date

2020-06-02

Service identification

Trace

SWIM-SERV-040
service identification

service name

TargetOffBlockTimeSetting

version

1.3.0

Service abstract

Trace

SWIM-SERV-050
service abstractThe TargetOffBlockTimeSetting service supports the Airport CDM concept and its implementation by allowing A-CDM Partners, typically aircraft operators and ground handlers, with the capability to set the Target Off-Block Time (TOBT) that indicates the target time for the aircraft to be ready for Off-Block. It is part of a set of services supporting the Airport CDM concept and its implementation by providing the A-CDM partners with Common Situation Awareness about flights at a CDM airport.

Service provider

Trace

SWIM-SERV-060

service provider

nameDonlon Airport Operator
abbreviated nameDAO
description

Donlon Airport Operator is the organisation responsible for all operations at Donlon airport.

Provider point of contact

Trace

SWIM-SERV-070

service provider

provider point of contact

name

Customer Relations

contact informationURL: http://www.donlon-airport.com/swim/service-request
roleTo request access to the service.

Support availability

Trace

SWIM-SERV-080

support availability

name

Service Desk [24/7]

contact information

phone number: +693 555 01

email: [email protected]

roleTo report incidents on services in operation.

Geographical extent of information

Trace

SWIM-SERV-090
geographical extent of informationaerodromeEADD

geometry100.0, 0.0

Service categories

Trace

SWIM-SERV-100

service categories





category category name

Regulated Information Exchange

value

FLIGHT_INFORMATION_EXCHANGE

scheme

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

category category name

Business Activity

value

AERODROME_OPERATION

scheme

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

category category name

intended service consumer

value

CIVIL_AIRSPACE_USER

scheme

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

category

category nameintended service consumer
value

AIRSIDE_GROUND_HANDLER

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

category nameintended service consumer
valueMILITARY_AIRSPACE_USER
schemehttp://reference.swim.aero/information-services/service-categories/CodeStakeholderType


Service lifecycle information

Trace

SWIM-SERV-110
service lifecycle information

lifecycle stage

Operational
qualifying datesince 2020-04-07

Service standard reference

Trace

SWIM-SERV-120

service standard reference



reference

 Initial system-wide information management (SWIM) technology solution (http://www.sesarju.eu/node/2255)

implemented options
deviations/additionsThe original payload has been adapted in order to better fulfill the role of example.

Operational environment

Trace

SWIM-SERV-130
operational environmentoperational needs

The context is the Airport Collaborative Decision Making (A-CDM) concept as defined in Airport CDM Implementation Manual v4.

In A-CDM it is important to allow A-CDM Partners to set the value of some milestones when necessary.

The classical example is to allow the Aircraft Operator or the Ground Handler to set the Target Off-Block Time (TOBT) that indicates what is the target time for the aircraft to be ready for off-block.

Not any value can be accepted. There may be many business rules for validating the value. As for example: value cannot be in the past, value can no longer be changed, too many changes, etc.

Setting the TOBT value is possible at many stages during the A-CDM process, as early as Milestone 2 (EOBT-2hr) up to and including Milestone 11 (Boarding starts).

The Business Logic may involve validations such as:

  • not accepting values in the past,
  • not accepting a new value too close the existing one (there is a minimum change involved),
  • limiting the number of changes after TSAT has been issued.

information exchange requirements

IER 1

To allow the Aircraft Operator or Ground Handler to set, update or delete the value of the Target Off-Block Time of a departing flight. This is done in accordance with the operations involving Target Off-Block Time that take place between A-CDM Milestones 2 and 11 (derived from: Airport CDM Implementation Manual v4)

IER 2

To allow the competent authority to set the value of the Target Off-Block Time for a given aircraft in specific circumstances. In other words, under adverse conditions or special circumstances this service allows the competent authorities to set the Target Off-Block Time value of the flight. (derived from: Airport CDM Implementation Manual v4)

Service functions

Trace

SWIM-SERV-140
service functions


functiondescriptionAllow the service consumer to set (i.e. define or update) the TOBT value for a specific flight.
real-world effectPlease refer to the A-CDM Implementation Manual for more information on the impact of the TOBT value at various stages of the A-CDM process.
functiondescriptionAllow the service consumer to delete the TOBT value for a specific flight.
real-world effectPlease refer to the A-CDM Implementation Manual for more information on the impact of the TOBT value at various stages of the A-CDM process.

Service access and use conditions

Trace

SWIM-SERV-150

service access and use conditions



legal constraints


TBD

service policies

business policy

The access to the service is subject to the signature of a Service Level Agreement with the Donlon Airport Operator.

operational policy

TBD

technical policy

TBD

service consumption constraints


TBD


Security constraints

Trace

SWIM-SERV-160

security constraints



authentication

Authentication is required - the access to the service is based on user id and password. The service utilizes X.509v3 public certificates.

authorisation


confidentiality

The service relies on TLS 1.2 to provide integrity and confidentiality.

integrity

The service relies on TLS 1.2 to provide integrity and confidentiality.

Additional technical information for the service consumer

Trace

SWIM-SERV-170

additional technical information for the service consumer


There is a limit on the number of changes after TSAT has been issued.

Quality of service

Trace

SWIM-SERV-180

quality of service

performance efficiency

capacity

2000 service requests per hour

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

recoverabilitybest effort
security

confidentiality

Confidentiality mechanisms have been implemented.

integrityIntegrity mechanisms have been implemented.


Source of information

Trace

SWIM-SERV-190

source of information

sourceThe service will receive information from the service consumer.
modifications-

Service validation information

Trace

SWIM-SERV-200

service validation information

validation performedyes
method usedself-validation
summary of the validation steps performedThe service was validated by a selected group of users.
results achievedThe service adheres to pre-defined validation rules.
how the service consumer may obtain the validation evidenceFor a report of the achieved results, please get in contact with http://www.donlon-airport.com/swim/service-request.

Application message exchange pattern

Trace

SWIM-SERV-210

application message exchange pattern

Synchronous Request Reply

Service behaviour

Trace

SWIM-SERV-220

service behaviour

typical behaviour

The service consumer uses the setTOBT operation to upload a Target Off-Block Time for a specific flight and receives a response on the validity of the request.

The service consumer uses the deleteTOBT operation to delete the Target Off-Block Time for a specific flight and receives a response on the validity of the request.

Each operation of the interface can be called independently.

The operations are detailed in a model view.

Service monitoring

Trace

SWIM-SERV-230

service monitoring

A heartbeat service is used to periodically check the status of the service and determine whether it is available.

Service interfaces

Trace

SWIM-SERV-240

service interfaces

interfacenameTOBTSettingReceiver
description

The interface allows setting or deleting the TOBT of the specified flight using SynchronousRequestReply.

provider/consumer sideProvider side interface
network addresshttp://www.swim.donlon-airport.com/swim-ops/gateway

SWIM TI Profile and interface bindings

Trace

SWIM-SERV-250

XML requests and replies embedded into SOAP messages, themselves embedded into HTTP requests and responses. Operation names are associated to SOAP requests.

SWIM TI profile and interface bindings





profile name

TI Yellow Profile specification

profile version

Edition Number 1.1

selected service interface binding

WS SOAP

selected network interface binding
IPV4_UNICAST

supported optional requirements

-

Service interface protocols and data format

Trace

SWIM-SERV-260

service interface protocols and data format





protocols

XML 1.0 requests and replies embedded into SOAP 1.2 messages, themselves embedded into HTTP/1.1 requests and responses. Operation names are associated to SOAP requests. The interface does not use compression or message transmission optimization mechanism (MTOM). The following cipher suites are allowed in accordance with ECRYPT-CSA recommendations https://www.ecrypt.eu.org/csa/documents/D5.4-FinalAlgKeySizeProt.pdf: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384.
data format

This is captured in the service messages section. See SWIM-SERV-280 Service messages.

Service operations

Trace

SWIM-SERV-270

Service operations







operation


operation name

setTOBT

description

The setTOBT Service Operation receives the Target Off-Block Time for a specific flight. The operation returns a confirmation of the validity of the provided Target Off-Block Time taking into account these business rules:

  • Not accepting values in the past
  • Not accepting a new value too close to the existing one (there is a minimum change involved)
  • Limiting the number of changes after TSAT has been issued

messages

TOBTSettingRequest, TOBTSettingResponse

operation


operation name

deleteTOBT
description

The deleteTOBT Service Operation receives a request for deleting the Target Off-Block Time for a specific flight. The operation returns a confirmation of the validity of such request taking into account this business rule:

  • Not accepting request affecting a flight with no Target Off-Block Time set yet.
messagesTOBTDeleteRequest, TOBTDeleteResponse

Service messages

Trace

SWIM-SERV-280

service messages





message

name

TOBTSettingRequest

descriptionMessage which provides the Target Off-Block Time value of a specific flight.
data formathttps://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
message

name

TOBTSettingResponse

descriptionMessage which responds the validity of a previously sent TOBTSettingRequest message.
data formathttps://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
messagenameTOBTDeleteRequest
descriptionMessage which requests deleting the last TOBT value of the specified flight.
data formathttps://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
messagenameTOBTDeleteResponse
descriptionMessage which responds the validity of a previously sent TOBTDeleteRequest message.
data formathttps://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
messagenameTOBTErrorReponse
descriptionError message in response to a user query.
data formathttps://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
isErrortrue

Information definition (minimum) and (extended)

Trace

SWIM-SERV-290, SWIM-SERV-300
information definitionhttps://ext.eurocontrol.int/swim_confluence/display/SWIM/Example+service+description+-+information+elements

Filter encoding

Trace

SWIM-SERV-310
filter encodingThe service allows filtering based on a start and end time given as HTTP Query parameters start_date and end_date. The values are formatted in ISO8601. Example: &start_date=2022-06-22&end_date=2022-06-25.

Machine-readable service interface definition

Trace

SWIM-SERV-320

machine-readable service interface definition

public:/2019-09/TOBT_Interface.wsdl

Model view

Trace

SWIM-SERV-330

model view

public:/2019-09/TOBT_Model.xmi

Examples of Code

Trace

SWIM-SERV-340
examples of codepublic:/2019-09/MessageExamples.txt

Abbreviations and acronyms

Trace

SWIM-SERV-350
abbreviations and acronyms

abbreviationcodeAACO

termACRIS Airport CDM Operational project
abbreviationcodeA-CDM

termAirport Collaborative Decision Making
abbreviationcodeACI

termAirport Council International
abbreviationcodeACRIS

termAirport Community Recommended Information Services
abbreviationcodeAIRM

termATM Information Reference Model
abbreviationcodeATM

termAir Traffic Management
abbreviationcodeCDM

termCollaborative Decision Making
abbreviationcodeFT10

termSESAR A-CDM Service Activity
abbreviationcodeIATA

termInternational Air Transport Association
abbreviationcodeICAO

termInternational Civil Aviation Organisation
abbreviationcodeIER

termInformation Exchange Requirement
abbreviationcodeIFPL

termIndividual Flight Plan message
abbreviationcodeIFPS

termIntegrated Initial Flight Plan Processing System
abbreviationcodeISRM

termInformation Service Reference Model
abbreviationcodeSESAR

termSingle European Sky ATM Research Programme
abbreviationcodeSOA

termService Oriented Architecture
abbreviationcodeSWIM

termSystem Wide Information Management
abbreviationcodeTOBT

termTarget Off-Block Time
abbreviationcodeTSAT

termTarget Start Up Approval Time
abbreviationcodeUML

termUnified Modeling Language
abbreviationcodeWSDL

termWeb Services Definition Language
abbreviationcodeXSD

termXML Schema Definition







  • No labels