SWIM Supporting Material

SWIM-DEFN-050 Service abstract

Owned by WILSON Scott
Last updated: 2024 Jul 11
1 min read

Requirement

Title

Service abstract

Identifier

SWIM-DEFN-050

Requirement

A service definition shall include a short textual description summarising the service.

Rationale

The abstract provides an understanding of the service.

Verification

Completeness: Verify that the element is included.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Example:

  • The Aeronautical Data Set Request Service allows the service consumer to request a data set, based on a set of filters, from a data set store. The service is part of a series of services that supports the provision of digital data sets as defined by ICAO Annex 15.

Level of
Implementation

Mandatory

Guidance

The service abstract can be seen as the executive summary of the service. It is often the first thing that prospective service implementers read. Therefore, it should contain the information necessary to support the decisions on whether the service is suitable for implementation in a particular situation.

Best Practice

It is best practice for the abstract to include:

  • the information domain(s) covered by the information service,

  • the operational need being addressed by the information service,

  • the intended use of the information service, and

  • the intended consumer audience for the information service

It is good to consider including:

  • the geographical extent of the information provided.

The information contained in the abstract is usually based on the other fields in the service definition.

Verification Support

Completeness

Check that:

[  ] The service definition includes a short textual description summarising the service.

Examples

Links to example service definitions can be found in the example service definitions page. 

Status: Living Material