SWIM Supporting Material

SWIM-INFO-005 Information definition scope

Owned by WILSON Scott
Last updated: 2022 Jan 18
Page Table of Content

Requirement

 Requirement [+]

Title

Information definition scope

Identifier

SWIM-INFO-005

Requirement

An information definition shall be accompanied by a textual description of the scope of the information it covers.

Rationale

This requirement supports decisions on whether an information definition is suitable for use in a particular situation.

Verification

Completeness

Examples/Notes

Example: The description provided by the Aeronautical Information Exchange Model is: “The objective of the Aeronautical Information Exchange Model (AIXM) is to enable the provision in digital format of the aeronautical information that is in the scope of Aeronautical Information Services (AIS).”

Example: The service abstract contained in a service description.

Level of Implementation

Mandatory

Guidance

This requirement imposes the need to provide a brief narrative summary of the scope of the information covered by the information definition. This may include an explicit statement about what is not in the scope of the information definition.

The specification caters for the fact that information definitions are often contained in service descriptions. The scope information can, in effect, be considered as being the same as for the service being described. This will avoid unnecessary duplication (copy and paste) of information.

Verification Support

Completeness

Check that:

[  ] The information definition contains a textual description of the scope of the information covered by the information definition.

[  ] The scope clearly delineates what is covered by the information definition.

Examples

The example below shows how the scope information can be embedded into an XML schema. It makes use the annotation element within the XML schema definition language.

A complete example is available at: complete example.

Example of SWIM-INFO-005
<xs:annotation> 
 <xs:documentation>   
  <abstract>The information definition includes AircraftIdentification, OffBlockTimes and Aerodrome elements in support of the Donlon TOBT Setting Service.</abstract>   
 </xs:documentation>
</xs:annotation>

Status: Living Material