Versions Compared

Key

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





Info
titleGuidance

This template allows for the documentation of service definitions based on the requirements found at: Service definitions minimum content

General requirements to remember:

SWIM-DEFN-010Service 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-020Service definition languageThe textual descriptions in a service definition shall be written in English using the spelling listed as the primary British spelling when conflicting spellings exist.-





Table of Contents
maxLevel2
typeflat


Service Definition Identification

Info
titleTrace
SWIM-DEFN-030



service definition identification

title

Service Definition Title

edition

Service Definition Edition

reference date

Service Definition Reference Date

Service Identification

Info
titleTrace

SWIM-DEFN-040


service identification

service name

Service Name

version

Service Version

Service Abstract

Info
titleTrace

SWIM-DEFN-050


service abstractThe  service allows ....

Service Definition Provider

Info
titleTrace

SWIM-DEFN-085



service definition provider

nameService Definition Provider Name
abbreviated nameService Definition Provider Abbreviated Name
descriptionService Definition Provider Description

Geographical Extent of Information

Info
titleTrace

SWIM-DEFN-090


geographical extent of information...

Service Categories

Info
titleTrace
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 nameintended service consumer
valueairside ground handler
schemehttp://reference.swim.aero/information-services/service-categories/CodeStakeholderType


Service Standard Reference

Info
titleTrace
SWIM-DEFN-120


service standard reference



reference
implemented options
deviations/additions

Operational Environment

Info
titleTrace
SWIM-DEFN-130


operational environmentoperational needs

information exchange requirements


IER 1


IER 2



Service Functions

Info
titleTrace
SWIM-DEFN-140


service functions


functionname
description
real-world effect
functionname
description
real-world effect

Service Access and Use Conditions

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

Info
titleTrace
SWIM-DEFN-160


security constraints



authentication

Consumer side authentication: TBD

Provider side authentication: Authentication is required

authorisation


confidentiality


integrity


Quality of Service

Info
titleTrace
SWIM-DEFN-180


quality of service

performance

capacity


response time
reliability

availability


recoverability
security

confidentiality


integrity

Quality of Data


Info
titleTrace
SWIM-DEFN-185


quality of data

Source of Information

Info
titleTrace
SWIM-DEFN-190


source of information

source
modifications

Service Validation Information


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

Info
titleTrace
SWIM-DEFN-210


application message exchange pattern

Synchronous Request Reply

Service Behaviour

Info
titleTrace
SWIM-DEFN-220


service behaviour

typical behaviour

Service Monitoring

Info
titleTrace
SWIM-DEFN-230


service monitoring

There is no service monitoring mechanism available to service consumers.

Service Interfaces

Info
titleTrace
SWIM-DEFN-240


service interfaces

interfacename
description



provider/consumer side

SWIM TI Profile and Interface Bindings

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

Info
titleTrace
SWIM-DEFN-260


service interface protocols and data format





transport / messaging protocols


data format


Info

This is captured at Service Message level (see below).


Service Operations

Info
titleTrace
SWIM-DEFN-270


service operations







operation


operation name


description


messages


operation


operation name


description
messages

Service Messages

Info
titleTrace
SWIM-DEFN-280


service messages





message

name


description
type
data format
message

name


description
type
data format

Information Definition (Minimum) and (Extended)

Info
titleTrace

SWIM-DEFN-290, SWIM-DEFN-300


information definition

Filter Encoding

Info
titleTrace

SWIM-DEFN-310


filter encoding

Machine-Readable Service Interface Definition

Info
titleTrace

SWIM-DEFN-320


machine-readable service interface definition


Model View

Info
titleTrace

SWIM-DEFN-330


model view


Abbreviations and Acronyms

Info
titleTrace
SWIM-DEFN-350


abbreviations and acronyms


abbreviationcode

term
abbreviationcode

term