Versions Compared

Key

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



Info
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.
Info
titleGuidance

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.


Table of Contents
maxLevel2
typeflat

Service description identification


Info
titleTrace
SWIM-SERV-030

title

Donlon TOBT Setting Service Description

edition

0.93i

reference date

2020-06-02

Service identification

Info
titleTrace
SWIM-SERV-040

service name

TargetOffBlockTimeSetting Service

version

1.3.0

Service abstract

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

Info
titleTrace
SWIM-SERV-060

service provider

nameDonlon Airport Operator
abbreviated nameDAO
descriptionThe operator in charge of Donlon Airprort.

Provider point of contact

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

Info
titleTrace
SWIM-SERV-080

service provider

support availability

name

Service Desk [24/7]

contact information

phone number: +693 555 01

email: service-desk@donlon-airport.com

roleto report incidents on services in operation

Geographical extent of information

Info
titleTrace
SWIM-SERV-090


<tbd>

Service categories

Info
titleTrace
SWIM-SERV-100

service categories





1category
value
scheme

information exchange area

value

flight information exchange

schemehttps://reference.swim.aero/information-services/service-categories.html
2category

availability status

value

operational

scheme
3category

business activity

value

airport operations management

scheme
4category

intended service consumer

value

airspace user
airside ground handler

scheme
5category

geographical extent

value

EADD (Donlon/Intl.)

scheme


Service lifecycle information

Info
titleTrace
SWIM-SERV-110
service lifecycle information

lifecycle stage

Operational

qualifying datesince 2020-04-07

Service standard reference

Info
titleTrace
SWIM-SERV-120

service standard reference

reference

implemented options

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

Operational environment

Info
titleTrace
SWIM-SERV-130

operational environment

operational 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

Info
titleTrace
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 effectThe Target Off-Block Time (TOBT) value is defined. The A-CDM Implementation Manual defines 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 effectThe Target Off-Block Time (TOBT) value is undefined. The A-CDM Implementation Manual defines the impact of the TOBT value at various stages of the A-CDM process.

Service access and use conditions

Info
titleTrace
SWIM-SERV-150

Service access and use conditions



legal constraints


TBD

service policies

business policy

TBD

operational policy

TBD

technical policy

TBD

service consumption constraints


TBD


Security constraints

Info
titleTrace
SWIM-SERV-160
Security AuthenticationAuthorisationConfidentialityIntegrity

security constraints



authentication

Consumer side authentication: TBD

Provider side authentication: Authentication is required

authorisation


confidentiality


integrity


Additional technical information for the service consumer

Info
titleTrace
SWIM-SERV-170

Technical Constraint

No known technical constraint.

Quality of service

Info
titleTrace
SWIM-SERV-180

Quality of Service

performance

capacity

2000 service requests per hour

response time2s 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
security

confidentiality


integrity


Source of information

Info
titleTrace
SWIM-SERV-190

Source of information

sourceAirport Survey Ltd
modificationsdata processed to satisfy the requirements for an aerodrome mapping database

Service validation information

Info
titleTrace
SWIM-SERV-200

Service validation information

validation performedyes
method usedself-validation
summary of the validation steps performed
results achieved
how the service consumer may obtain the validation evidence

Application message exchange pattern

Info
titleTrace
SWIM-SERV-210

Application message exchange pattern

The service follows the Synchronous Request/Response Message Exchange Pattern.

Service behaviour

Info
titleTrace
SWIM-SERV-220

Service behaviour

typical behaviour

Each operation of the interface can be called independently.

The following diagram illustrates the interaction between the service consumer and the service:

Service monitoring

Info
titleTrace
SWIM-SERV-230

Service monitoring

There is no service monitoring mechanism available to service consumers.

Service interfaces

Info
titleTrace
SWIM-SERV-240
Service interfaces1nameTOBTSettingReceiver
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

Info
titleTrace
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.0


selected service interface binding

WS SOAP


selected network interface binding

supported optional requirements

-

Service interface protocols and data format

Info
titleTrace
SWIM-SERV-260

Service interface protocols and data format

transport / messaging protocols

HTTP 1.1

SOAP1.1, SOAP1.2

Protocol implementation compliant with WSI Basic Profile 2.0


protocol configuration

HTTP Messages will indicate the payload content type using the content-type header

HTTP Messages that transport compressed payloads will use deflate/gzip/exi as expressed in the content-encoding header  (compression ratio is around 20%)

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 post method is supported


security

Server authentication based on  X.509 certificates

Client authenticates based on HTTP Basic

TLS1.2

Cypher Suites: AES_128_GCM_SHA256, AES_256_CCM


exception handling

The services make use of the standard HTTP 400 error [Bad Request] in any of the following cases:

  • The request is for an unsupported release
  • The request is not a well-formed XML
  • The request is a well-formed XML but it is not valid with respect to the XSD (i.e. it does not conform to the type and attribute names defined in the XSD and documented in the reference manuals). Examples of causes for invalid XML documents are:
    • Unexpected element or attribute
    • Element order violation
    • Incorrect primitive value
    • Unexpected enum value

data formatx

Service operations

Info
titleTrace
SWIM-SERV-270
Service operations1

operation

setTOBT

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


input

TOBTSettingRequest

Message which provides the Target Off-Block Time value of a specific flight.



output

TOBTSettingResponse

Message which responds the validity of a previously sent TOBTSettingRequest message.



error




2

operation

deleteTOBT

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.


inputTOBTDeleteRequestMessage which requests deleting the last TOBT value of the specified flight.


outputTOBTDeleteResponseMessage which responds the validity of a previously sent TOBTDeleteRequest message.


error

Service messages

Info
titleTrace
SWIM-SERV-280

Service messages


input

TOBTSettingRequest

Message which provides the Target Off-Block Time value of a specific flight.



output

TOBTSettingResponse

Message which responds the validity of a previously sent TOBTSettingRequest message.



error





inputTOBTDeleteRequestMessage which requests deleting the last TOBT value of the specified flight.


outputTOBTDeleteResponseMessage which responds the validity of a previously sent TOBTDeleteRequest message.


error






Information definition (minimum) and (extended)

Info
titleTrace
SWIM-SERV-290, SWIM-SERV-300

Filter encoding

Info
titleTrace
SWIM-SERV-310
Filter encoding

Machine-readable service interface definition

Info
titleTrace
SWIM-SERV-320
Machine-readable service interface definitionService description in WSDL 1.1 <<add reference>>

Message description by XML Schema  <<add reference>>

Model view

Info
titleTrace
SWIM-SERV-330
Model view

The model is published as an XMI file that can be imported in Sparx Enterprise Architect.

<<add reference>>

Examples of Code

Info
titleTrace
SWIM-SERV-340
Examples of codeNo code example available.


Abbreviations and acronyms

Info
titleTrace
SWIM-SERV-350

Abbreviations and acronyms

abbreviation

term


AACO

ACRIS Airport CDM Operational project


A-CDM

Airport Collaborative Decision Making


ACI

Airport Council International


ACRIS

Airport Community Recommended Information Services


AIRM

ATM Information Reference Model


ATM

Air Traffic Management


CDM

Collaborative Decision Making


FT10

SESAR A-CDM Service Activity


IATA

International Air Transport Association


ICAO

International Civil Aviation Organisation


IER

Information Exchange Requirement


IFPL

Individual Flight Plan message


IFPS

Integrated Initial Flight Plan Processing System


ISRM

Information Service Reference Model


SESAR

Single European Sky ATM Research Programme


SOA

Service Oriented Architecture


SWIM

System Wide Information Management


TOBT

Target Off-Block Time


TSAT

Target Start Up Approval Time


UML

Unified Modeling Language


WSDL

Web Services Definition Language


XSD

XML Schema Definition