Versions Compared

Key

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

...

Requirement

Verification type

Check that:

Level of implementation

Notes

SWIM-DEFN-010 Service definition coverage

Correctness

Verify that one and only one service is described.

Mandatory

SWIM-DEFN-020 Service definition language

Correctness

Verify that the textual descriptions are correct British English.

Mandatory

SWIM-DEFN-030 Service definition identification

Completeness

Verify that the elements are included.

  • a title by which the service definition is known;

  • an edition; and

  • a reference date for use in citing the service definition.

Mandatory

SWIM-DEFN-040 Service identification

Completeness

Verify that the element is included.

the name of the service

Mandatory

SWIM-DEFN-050 Service abstract

Completeness

Verify that the element is included.

a short textual description summarising the service

Mandatory

SWIM-DEFN-085 Service definition provider

Completeness

Verify that the applicable elements are included.

  • the name;

  • abbreviated name (if applicable); and

  • description of the organisation responsible for the service definition.

Mandatory

SWIM-DEFN-090 Geographical extent of information

Correctness

If provided, verify that the information is correct.

expected geographical coverage of the exchanged information service payload.

Optional

SWIM-DEFN-095 Intended service providers and consumers

Correctness

If provided, verify that the information is correct.

the typical service provider type and typical service consumer(s) type

Recommended

SWIM-DEFN-100 Service categories

Completeness

Verify that a service category is included.

service categories to which the service belongs and, if applicable, reference the service categorisation schemes used.

Mandatory

SWIM-DEFN-120 Service standard reference

Consistency

If the service adheres to a service standard, verify that the reference to the service standard is included.

Mandatory Conditional

SWIM-DEFN-130 Operational environment

Completeness

Verify that operational environment information is included or referenced.

  • the operational needs used in the development of the service; and/or

  • the capabilities offered by the service.

Mandatory

SWIM-DEFN-140 Service functions

Completeness

Completeness: Verify that the elements are included.

  • the functions expected to be offered by the service in support of its capabilities; and

  • their expected real-world effects.

Mandatory

Consistency

Verify that the functions and real-world effects are consistent with the operational needs.

SWIM-DEFN-150 Service access and use conditions

Correctness

: If provided, verify that the information is correct.

constraints which are expected to be applied to accessing and using the service

Recommended

SWIM-DEFN-160 Security constraints

Correctness

If provided, verify that the information is correct.

information about the security constraints which are expected to apply to accessing and using the service

Recommended

SWIM-DEFN-180 Quality of service

Completeness

Verify that quality statements are included.

information about the expected minimum quality of service offered with regards to:

  • performance;

  • reliability; and

  • security.

Mandatory

SWIM-DEFN-185 Quality of data

Completeness

Verify that quality statements are included.

information about the expected minimum quality of the data to be provided by the service

Mandatory

SWIM-DEFN-190 Source of information

Correctness

If provided, verify that the information is correct.

the expected types of sources of the information provided

Recommended

SWIM-DEFN-200 Service validation information

Correctness

If provided, verify that the information is correct.

information about any service prototyping activities that have taken place

Optional

SWIM-DEFN-210 Application message exchange pattern

Completeness

Verify that the information is included.

information about the application message exchange pattern(s) expected to be used by the service

Mandatory

Consistency

Verify that the information is consistent with the selected service interface binding.

SWIM-DEFN-220 Service behaviour

Completeness

Verify that the behaviour information is included.

the expected typical behaviour of the service.

Mandatory

SWIM-DEFN-230 Service monitoring

Not Applicable

Optional

SWIM-DEFN-240 Service interfaces

Completeness

Verify that the list of interfaces is included; verify that the name, description and indication are included for each interface.

  • the name of the service interface;

  • a textual description of the service interface including its purpose;

  • an indication that the interface is a provider side interface or a consumer side interface.

Mandatory

SWIM-DEFN-250 SWIM Technical Infrastructure Profile

Completeness

Verify that the reference information is provided.

information about the selected SWIM TI Profile and its version for each service interface

Mandatory

SWIM-DEFN-255 SWIM service and network interface binding

Not Applicable

Optional

SWIM-DEFN-260 Service interface protocols and data format

Consistency

If provided, verify that the protocols and data format are consistent with the service interface binding.

  • the service interface protocols (including name and version); and

  • data format to be used.

Optional

SWIM-DEFN-270 Service operations

Completeness

Verify that all service operations are described.

the expected exposed service operations including:

  • the name of the service operation; and

  • a description of the intent and the results of the service operation.

Mandatory

Consistency

Verify the service operations against the messaging technology needs.

SWIM-DEFN-280 Service messages

Completeness

Verify that all service messages are described.

the expected messages that are exchanged by the service including input, output and error messages.

Mandatory

SWIM-DEFN-290 Information definition (minimum)

Completeness

Verify that the service description describes all elements of the exchanged information and that the required details are provided.

  • the name of the element;

  • the definition of the element;

  • the data type used by the element if applicable; and

  • the semantic correspondence of the element with the AIRM

Mandatory

Consistency

Verify that the elements are consistent with each other and with the AIRM concepts used in the semantic correspondence.

SWIM-DEFN-300 Information definition (extended)

Not Applicable

Recommended

SWIM-DEFN-310 Filter encoding

Completeness

If filter expressions are expected, verify that the filter encoding is included.

Mandatory Conditional

SWIM-DEFN-320 Machine-readable service interface definition

Completeness

If the service interface binding supports it, verify that the required elements are included.

Recommended Conditional

Consistency

Verify that provided elements are consistent with the selected binding.

SWIM-DEFN-330 Model view

Correctness

If provided, check that the model view is correct.

Optional

SWIM-DEFN-350 Abbreviations and acronyms

Completeness

Verify that all used acronyms and abbreviations are defined.

Mandatory

Consistency

Verify that the abbreviations/acronyms and their definitions are used consistently in the service definition.