Guidance
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-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
| 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 |
|---|---|---|
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
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
service standard reference | reference | |
|---|---|---|
| implemented options | ||
| deviations/additions |
Operational Environment
Trace
| operational environment | operational needs | ||||
|---|---|---|---|---|---|
information exchange requirements |
|
Service Functions
Trace
| service functions | function | name | |
|---|---|---|---|
| description | |||
| real-world effect | |||
| function | name | ||
| description | |||
| real-world effect |
Service Access and Use Conditions
Trace
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
security constraints | authentication | Consumer side authentication: TBD Provider side authentication: Authentication is required |
|---|---|---|
authorisation | ||
confidentiality | ||
integrity |
Quality of Service
Trace
quality of service | performance | capacity | |
|---|---|---|---|
| response time | |||
| reliability | availability | ||
| recoverability | |||
| security | confidentiality | ||
| integrity |
Quality of Data
Trace
| quality of data |
|---|
Source of Information
Trace
source of information | source | |
|---|---|---|
| modifications |
Service Validation Information
Trace
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
application message exchange pattern | Synchronous Request Reply |
|---|
Service Behaviour
Trace
service behaviour | typical behaviour |
|---|
Service Monitoring
Trace
service monitoring | There is no service monitoring mechanism available to service consumers. |
|---|
Service Interfaces
Trace
service interfaces | interface | name | |
|---|---|---|---|
| description | |||
| provider/consumer side |
SWIM TI Profile and Interface Bindings
Trace
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
service interface protocols and data format | transport / messaging protocols | |
|---|---|---|
| data format | This is captured at Service Message level (see below). |
Service Operations
Trace
service operations | operation | operation name | |
|---|---|---|---|
description | |||
messages | |||
| operation | operation name | ||
| description | |||
| messages |
Service Messages
Trace
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
| abbreviations and acronyms | abbreviation | code |
|---|---|---|
| term | ||
| abbreviation | code | |
| term |