Versions Compared

Version Old Version 13 New Version 14
Changes made by

WILSON Scott

WILSON Scott

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titlePage Table of Content

Table of Contents

Info
titleVersion

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-007 Service abstract

Requirement

Panel
borderColorlightgrey
bgColorwhitesmoke
borderStyledashed

Title

Service abstract

Identifier

SWIM-SERV-050

Requirement

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

Rationale

A good abstract is valuable, in particular during service discovery.

The abstract, by ensuring an understanding of the service, supports the decisions on whether the service is suitable for use in a particular situation.

Verification

Completeness: Verify that the element is included.

Consistency: Not Applicable.

Correctness: Not Applicable. 

Examples/Notes

Note: 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.

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 consumers read. Therefore, it should contain the information necessary to support the decisions on whether the service is suitable for use in a particular situation.

Tip
titleBest 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 also good to coverconsider including:

  • the geographical extent of the information provided
  • the service's first date of operation e.g. "The service has been in operation since yyyy-mm-dd".

The information to create contained in the abstract can be taken from is usually based on the other fields in the service description.

Verification Support


Completeness

Check that:

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

Example

The following example shows the content as a table.

service abstract

The TargetOffBlockTimeSetting service supports the Airport CDM concept and its implementation by allowing A-CDM Partners, typically aircraft operators and ground handlers. It provides 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.

The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Code Block
languagejs
titleExample of SWIM-SERV-050 using Service Metadata Schema
"serviceAbstract": "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."

Complete examples are available at Example service description.