Versions Compared

Key

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

...

Title

Service behaviour

Identifier

SWIM-DEFN-220

Requirement

A service definition shall include or refer to information about the expected typical behaviour of the service.

Rationale

This requirement facilitates the understanding of the service behaviour to support operational processes.

Verification

Completeness: Verify that the behaviour information is included.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Note: The requirement covers the typical behaviour under normal conditions. Details on the handling of unexpected behaviour can be included, e.g., error handling.

Note: A diagram showing how the operations support the typical behaviour can be provided. This can be made available in the model view (SWIM-DEFN-330).

Note: The service behaviour patterns that are detailed in the Message Exchange Patterns: Identification Guidelines [RD 16] can be used to meet this requirement.

Level of
Implementation

Mandatory

Guidance

Note

Service behaviour

The behaviour is for the service as a whole. The behaviour of the operations is not covered by this requirement. Instead, it is captured in the description of the operations (SWIM-DEFN-270 Service operations).

This requirement covers the typical behaviour of the service under normal conditions. This means that the service is working as hoped.

Info

The service behaviour can be captured

  • using a formal modelling notation such as the Unified Modeling Language (UML) (which allows e.g. sequence diagrams), and/or

  • expressed as textual description in plain language.

The SWIM-DEFN-330 Model view can be used to make reference to the model.

Verification Support

Completeness

Check that: [  ] The service definition includes or refers to information about the expected typical behaviour of the service.

Examples

Example:

  • A typical sequence is:

    • (1) The service consumer requests dataset series based on a number of selection criteria, and receives back a list with zero, one or more dataset series objects.

    • (2) The service consumer analyses that list to identify the dataset series he is interested in.

    • (3) The service consumer requests datasets from the selected dataset series, possibly supplying additional selection criteria, and receives back a list of zero, one or more datasets.

    • (4) The service consumer analyses that list to identify the dataset(s) he is interested in.

    • (5) For each dataset of interest

      • (5a) The service consumer requests the file information of the selected dataset, and receives back a list of one or more file objects.

      • (5b) For each file object, the service consumer retrieves the file, and receives back the file content.