Guidance

This template allows for the documentation of service definitions based on the requirements found in the specification.

General requirements to remember:

SWIM-DEFN-010

Service definition coverage

A service definition shall define a single service

Note: This concerns the definition of a service that can be implemented by service providers. It is not used to describe a running service - use a service description in that case.

Note: This requirement uses "define" rather than "describe".

SWIM-DEFN-020

Service definition language

The textual descriptions in a service definition shall be written in English using the spelling listed as the primary British spelling when conflicting spellings exist.

-

Service Definition Identification

Trace

SWIM-DEFN-030

service definition identification	title	Service Definition Title
	edition	Service Definition Edition
	reference date	Service Definition Reference Date

Service Identification

Trace

SWIM-DEFN-040

service identification	service name	Service Name
service identification	version	Service Version

Service Abstract

Trace

SWIM-DEFN-050

service abstract	The service allows ....

Service Definition Provider

Trace

SWIM-DEFN-085

service definition provider	name	Service Definition Provider Name
	abbreviated name	Service Definition Provider Abbreviated Name
	description	Service Definition Provider Description

Geographical Extent of Information

Trace

SWIM-DEFN-090

geographical extent of information	...

Service Categories

Trace

SWIM-DEFN-095, SWIM-DEFN-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	Life Cycle Stage
		value	operational
		scheme	http://reference.swim.aero/information-services/service-categories/CodeLifeCycleStageType
	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

Service Standard Reference

Trace

SWIM-DEFN-120

service standard reference	reference
	implemented options
	deviations/additions

Operational Environment

Trace

SWIM-DEFN-130

operational environment

operational needs

information exchange requirements

IER 1
IER 2

Service Functions

Trace

SWIM-DEFN-140

service functions	function	name
		description
		real-world effect
	function	name
		description
		real-world effect

Service Access and Use Conditions

Trace

SWIM-DEFN-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

Trace

SWIM-DEFN-160

security constraints	authentication	Consumer side authentication: TBD Provider side authentication: Authentication is required
	authorisation
	confidentiality
	integrity

Quality of Service

Trace

SWIM-DEFN-180

quality of service	performance	capacity
	performance	response time
	reliability	availability
	reliability	recoverability
	security	confidentiality
	security	integrity

Quality of Data

Trace

SWIM-DEFN-185

quality of data

Source of Information

Trace

SWIM-DEFN-190

source of information	source
source of information	modifications

Service Validation Information

Trace

SWIM-DEFN-200

service validation information	validation performed
	method used
	summary of the validation steps performed
	results achieved
	how the service consumer may obtain the validation evidence

Application Message Exchange Pattern

Trace

SWIM-DEFN-210

application message exchange pattern	Synchronous Request Reply

Service Behaviour

Trace

SWIM-DEFN-220

service behaviour	typical behaviour

Service Monitoring

Trace

SWIM-DEFN-230

service monitoring	There is no service monitoring mechanism available to service consumers.

Service Interfaces

Trace

SWIM-DEFN-240

service interfaces	interface	name
		description
		provider/consumer side

SWIM TI Profile and Interface Bindings

Trace

SWIM-DEFN-250, SWIM-DEFN-255

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

Trace

SWIM-DEFN-260

service interface protocols and data format	transport / messaging protocols
service interface protocols and data format	data format	This is captured at Service Message level (see below).

Service Operations

Trace

SWIM-DEFN-270

service operations	operation	operation name
		description
		messages
	operation	operation name
		description
		messages

Service Messages

Trace

SWIM-DEFN-280

service messages	message	name
		description
		type
		data format
	message	name
		description
		type
		data format

Information Definition (Minimum) and (Extended)

Trace

SWIM-DEFN-290, SWIM-DEFN-300

information definition

Filter Encoding

Trace

SWIM-DEFN-310

filter encoding

Machine-Readable Service Interface Definition

Trace

SWIM-DEFN-320

machine-readable service interface definition

Model View

Trace

SWIM-DEFN-330

model view

Abbreviations and Acronyms

Trace

SWIM-DEFN-350

abbreviations and acronyms	abbreviation	code
		term
	abbreviation	code
		term

SWIM Supporting Material

Service definition template

Service Definition Identification

Service Identification

Service Abstract

Service Definition Provider

Geographical Extent of Information

Service Categories

Service Standard Reference

Operational Environment

Service Functions

Service Access and Use Conditions

Security Constraints

Quality of Service

Quality of Data

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 Messages

Information Definition (Minimum) and (Extended)

Filter Encoding

Machine-Readable Service Interface Definition

Model View

Abbreviations and Acronyms