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

title	Guidance

General requirements to remember:

SWIM-SERV-010

Service description coverage

A service description shall describe a single service.

SWIM-SERV-020

Service description language

The 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

maxLevel	2
type	flat

Service description identification

Info

title	Trace

SWIM-SERV-030

service description identification	title	Donlon TOBT Setting Service Description
	edition	0.93i
	reference date	2020-06-02

Service identification

Info

title	Trace

SWIM-SERV-040

service identification	service name	TargetOffBlockTimeSetting
service identification	version	1.3.0

Service abstract

Info

title	Trace

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

title	Trace

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

title	Trace

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

title	Trace

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

title	Trace

SWIM-SERV-090

geographical extent of information	aerodrome	EADD
	geometry	100.0, 0.0

Service categories

Info

title	Trace

SWIM-SERV-100

service categories	category	category name	Regulated Information Exchange
		value	flight information exchangeFLIGHT_INFORMATION_EXCHANGE
		scheme	http://reference.swim.aero/information-services/service-categories/CodeRegulatedInformationExchangeType
	category	category name	Business Activity
		value	aerodrome operationsAERODROME_OPERATION
		scheme	http://reference.swim.aero/information-services/service-categories/CodeBusinessActivityType
	category	category name	intended service consumer
		value	civil airspace userCIVIL_AIRSPACE_USER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	airside ground handler AIRSIDE_GROUND_HANDLER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	military airspace userMILITARY_AIRSPACE_USER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType

Service lifecycle information

Info

title	Trace

SWIM-SERV-110

service lifecycle information	lifecycle stage	Operational
service lifecycle information	qualifying date	since 2020-04-07

Service standard reference

Info

title	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/additions	The original payload has been adapted in order to better fulfill the role of example.

Operational environment

Info

title	Trace

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

title	Trace

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.
	function	real-world effect	The Target Off-Block Time (TOBT) value is defined. The A-CDM Implementation Manual defines Please 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.
	function	description	Allow the service consumer to delete the TOBT value for a specific flight.
	function	real-world effect	The Target Off-Block Time (TOBT) value is undefined. The Please refer to the A-CDM Implementation Manual defines for more information on the impact of the TOBT value at various stages of the A-CDM process.

Service access and use conditions

Info

title	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

Info

title	Trace

SWIM-SERV-160

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

Additional technical

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

Additional technical information for the service consumer

Info

title	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

Info

title	Trace

SWIM-SERV-180

quality of service	performance efficiency	capacity	2000 service requests per hour
	performance efficiency	time behaviour	2s 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
	reliability	recoverability	best effort
	security	confidentiality	The service relies on TLS 1.2 to provide integrity and confidentialityConfidentiality mechanisms have been implemented.
	security	integrity	The service relies on TLS 1.2 to provide integrity and confidentialityIntegrity mechanisms have been implemented.

Source of information

Info

title	Trace

SWIM-SERV-190

source of information	source	The service will receive information from the service consumer.
source of information	modifications	-

Service validation information

Info

title	Trace

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 achievedhow the service	The service adheres to pre-defined validation rules.
	how the service consumer may obtain the validation evidence	For a report of the achieved results, please get in contact with http://www.donlon-airport.com/swim/service-request.

Application message exchange pattern

Info

title	Trace

SWIM-SERV-210

application message exchange pattern	Synchronous Request Reply

Service behaviour

Info

title	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

Info

title	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

Info

title	Trace

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

title	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.01
	selected service interface binding	WS SOAP
	selected network interface binding	IPV4_UNICAST
	supported optional requirements	-

Service interface protocols and data format

Info

title	Trace

SWIM-SERV-260

Service operations

data format
service interface protocols and data format	transport / messaging protocols	HTTP XML 1.1 SOAP1.1, SOAP1.2 Protocol implementation compliant with WSI Basic Profile 2.0
service interface protocols and data format	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: 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_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

Service operations

Info

title	Trace

SWIM-SERV-270

SHA384.

data format

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

Service operations

Info

title	Trace

SWIM-SERV-270

setTOBT setTOBT the provided Target Off-Block Time these rules 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

operation

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
		messages	TOBTSettingRequest, TOBTSettingResponse
operation name	deleteTOBT	description	The deleteTOBT Service Operation receives a request for deleting request affecting a flight with no Target Off-Block Time set yet.
messages	TOBTDeleteRequest, TOBTDeleteResponse

Service messages

Info

title	Trace

SWIM-SERV-280

service messages	message	name	TOBTSettingRequest
		description	Message which provides the Target Off-Block Time

for

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

Info

title	Trace

SWIM-SERV-280

service messages

TOBTSettingResponse

message	name	TOBTSettingRequest
message	description	Message which provides the Target Off-Block Time value of a specific flight.
message	name	.
message	data format	https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
message	name	TOBTSettingResponse
	description	Message which responds the validity of a previously sent TOBTSettingRequest message.
	data format	https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
message	name	TOBTDeleteRequest
	description	Message which requests deleting the last TOBT value of the specified flight.
	data format	https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
message	name	TOBTDeleteResponse
	description	Message which responds the validity of a previously sent TOBTSettingRequest message.TOBTDeleteRequest message.
	data format	https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
message	name	TOBTDeleteRequestTOBTErrorReponse
	description	Message which requests deleting the last TOBT value of the specified flight.
	message	name	TOBTDeleteResponse
	message	description	Message which responds the validity of a previously sent TOBTDeleteRequest message.Error message in response to a user query.
data format	https://donlon.eu/schema/1.0.0/tobt/donlon-schema.xsd
isError	true

Information definition (minimum) and (extended)

Info

title	Trace

SWIM-SERV-290, SWIM-SERV-300

information definition	https://ext.eurocontrol.int/swim_confluence/display/SWIM/Example+service+description+-+information+elements

Filter encoding

Info

title	Trace

SWIM-SERV-310

filter encoding	The 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

Info

title	Trace

SWIM-SERV-320

machine-readable service interface definition	public:/2019-09/TOBT_Interface.wsdl

Model view

Info

title	Trace

SWIM-SERV-330

model view	public:/2019-09/TOBT_Model.xmi

Examples of Code

Info

title	Trace

SWIM-SERV-340

examples of code	public:/2019-09/MessageExamples.txt

Abbreviations and acronyms

Info

title	Trace

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

Version	Old Version 39	New Version Current
Changes made by	WILSON Scott	WILSON Scott
Saved on	2022 Jun 13	2022 Sept 13

Page Comparison

Versions Compared

Key

Service description identification

Service identification

Service abstract

Service provider

Provider point of contact

Support availability

Geographical extent of information

Service categories

Service lifecycle information

Service standard reference

Operational environment

Service functions

Service access and use conditions

Security constraints

Additional technical information for the service consumer

Quality of service

Source of information

Service validation information

Application message exchange pattern

Service behaviour

Service monitoring

Service interfaces

SWIM TI Profile and interface bindings

Service interface protocols and data format

Service operations

Service operations

Service messages

Service messages

Information definition (minimum) and (extended)

Filter encoding

Machine-readable service interface definition

Model view

Examples of Code

Abbreviations and acronyms