| 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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
General requirements to remember:
|
| Table of Contents | ||||
|---|---|---|---|---|
|
Service description identification
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-030 |
| service description identification | title | Donlon TOBT Setting Service Description |
|---|---|---|
edition | 0.93i | |
reference date | 2020-06-02 |
Service identification
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-040 |
| service identification | service name | TargetOffBlockTimeSetting |
|---|---|---|
version | 1.3.0 |
Service abstract
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-050 |
| service abstract | The 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 | ||
|---|---|---|
| ||
| SWIM-SERV-060 |
service provider | name | Donlon Airport Operator |
|---|---|---|
| abbreviated name | DAO | |
| description | Donlon Airport Operator is the organisation responsible for all operations at Donlon airport. |
Provider point of contact
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-070 |
service provider | provider point of contact | name | Customer Relations |
|---|---|---|---|
| contact information | URL: http://www.donlon-airport.com/swim/service-request | ||
| role | To request access to the service. |
Support availability
| Info | ||
|---|---|---|
| ||
| 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 | ||
| role | To report incidents on services in operation. |
Geographical extent of information
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-090 |
| geographical extent of information | aerodrome | EADD |
|---|---|---|
| geometry | 100.0, 0.0 |
Service categories
| Info | ||
|---|---|---|
| ||
| 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 operations | ||
| 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 name | intended service consumer | |
| value | airside ground handler | ||
| scheme | http://reference.swim.aero/information-services/service-categories/CodeStakeholderType | ||
| category | category name | intended service consumer | |
| value | military airspace user | ||
| scheme | http://reference.swim.aero/information-services/service-categories/CodeStakeholderType |
Service lifecycle information
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-110 |
| service lifecycle information | lifecycle stage | Operational |
|---|---|---|
| qualifying date | since 2020-04-07 |
Service standard reference
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-120 |
service standard reference | reference | Initial system-wide information management (SWIM) technology solution (http://www.sesarju.eu/node/2255) |
|---|---|---|
| implemented options | ||
| deviations/additions | The original payload has been adapted in order to better fulfill the role of example. |
Operational environment
| Info | ||
|---|---|---|
| ||
| 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:
| |||
|---|---|---|---|---|---|
information exchange requirements |
|
Service functions
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-140 |
| service functions | function | description | Allow the service consumer to set (i.e. define or update) the TOBT value for a specific flight. |
|---|---|---|---|
| real-world effect | The 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. | ||
| function | description | Allow the service consumer to delete the TOBT value for a specific flight. | |
| real-world effect | The 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 | ||
|---|---|---|
| ||
| 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
| Info | ||
|---|---|---|
| ||
| 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 | ||
integrity |
Additional technical information for the service consumer
| Info | ||
|---|---|---|
| ||
| 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
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-180 |
quality of service | performance efficiency | capacity | 2000 service requests per hour |
|---|---|---|---|
| time behaviour | 2s delay for 95% of messages | ||
| reliability | availability | 99.95 % outside the planned outages | |
| recoverability | best effort | ||
| security | 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. |
Source of information
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-190 |
source of information | source | The service will receive information from the service consumer. |
|---|---|---|
| modifications | - |
Service validation information
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-200 |
service validation information | validation performed | yes |
|---|---|---|
| method used | self-validation | |
| summary of the validation steps performed | The service was validated by a selected group of users. | |
| results achieved | ||
| how the service consumer may obtain the validation evidence |
Application message exchange pattern
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-210 |
application message exchange pattern | Synchronous Request Reply |
|---|
Service behaviour
| Info | ||
|---|---|---|
| ||
| 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
| Info | ||
|---|---|---|
| ||
| 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
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-240 |
service interfaces | interface | name | TOBTSettingReceiver |
|---|---|---|---|
| description | The interface allows setting or deleting the TOBT of the specified flight using SynchronousRequestReply. | ||
| provider/consumer side | Provider side interface | ||
| network address | http://www.swim.donlon-airport.com/swim-ops/gateway |
SWIM TI Profile and interface bindings
| Info | ||
|---|---|---|
| ||
| 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.01 | |
selected service interface binding | WS SOAP | |
| selected network interface binding | IPV4_UNICAST | |
supported optional requirements | - |
Service interface protocols and data format
| Info | ||
|---|---|---|
| ||
| 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:
| |
| data format |
Service operations
| Info | ||
|---|---|---|
| ||
| 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:
| ||
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:
| ||
| messages | TOBTDeleteRequest, TOBTDeleteResponse |
Service messages
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-280 |
service messages | message | name | TOBTSettingRequest |
|---|---|---|---|
| description | Message which provides the Target Off-Block Time value of a specific flight. | ||
| message | name | TOBTSettingResponse | |
| description | Message which responds the validity of a previously sent TOBTSettingRequest message. | ||
| message | name | TOBTDeleteRequest | |
| description | Message which requests deleting the last TOBT value of the specified flight. | ||
| message | name | TOBTDeleteResponse | |
| description | Message which responds the validity of a previously sent TOBTDeleteRequest message. |
Information definition (minimum) and (extended)
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-290, SWIM-SERV-300 |
| information definition | https://ext.eurocontrol.int/swim_confluence/display/SWIM/Example+service+description+-+information+elements |
|---|
Filter encoding
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-310 |
| filter encoding | The service allows filtering based on a start and end time. |
|---|
Machine-readable service interface definition
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-320 |
machine-readable service interface definition | public:/2019-09/TOBT_Interface.wsdl |
|---|
Model view
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-330 |
model view | public:/2019-09/TOBT_Model.xmi |
|---|
Examples of Code
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-340 |
| examples of code | public:/2019-09/MessageExamples.txt |
|---|
Abbreviations and acronyms
| Info | ||
|---|---|---|
| ||
| SWIM-SERV-350 |
| abbreviations and acronyms | abbreviation | code | AACO |
|---|---|---|---|
| term | ACRIS Airport CDM Operational project | ||
| abbreviation | code | A-CDM | |
| term | Airport Collaborative Decision Making | ||
| abbreviation | code | ACI | |
| term | Airport Council International | ||
| abbreviation | code | ACRIS | |
| term | Airport Community Recommended Information Services | ||
| abbreviation | code | AIRM | |
| term | ATM Information Reference Model | ||
| abbreviation | code | ATM | |
| term | Air Traffic Management | ||
| abbreviation | code | CDM | |
| term | Collaborative Decision Making | ||
| abbreviation | code | FT10 | |
| term | SESAR A-CDM Service Activity | ||
| abbreviation | code | IATA | |
| term | International Air Transport Association | ||
| abbreviation | code | ICAO | |
| term | International Civil Aviation Organisation | ||
| abbreviation | code | IER | |
| term | Information Exchange Requirement | ||
| abbreviation | code | IFPL | |
| term | Individual Flight Plan message | ||
| abbreviation | code | IFPS | |
| term | Integrated Initial Flight Plan Processing System | ||
| abbreviation | code | ISRM | |
| term | Information Service Reference Model | ||
| abbreviation | code | SESAR | |
| term | Single European Sky ATM Research Programme | ||
| abbreviation | code | SOA | |
| term | Service Oriented Architecture | ||
| abbreviation | code | SWIM | |
| term | System Wide Information Management | ||
| abbreviation | code | TOBT | |
| term | Target Off-Block Time | ||
| abbreviation | code | TSAT | |
| term | Target Start Up Approval Time | ||
| abbreviation | code | UML | |
| term | Unified Modeling Language | ||
| abbreviation | code | WSDL | |
| term | Web Services Definition Language | ||
| abbreviation | code | XSD | |
| term | XML Schema Definition |