SWIM Supporting Material

SWIM-DEFN-140 Service functions

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

Requirement

Title

Service functions

Identifier

SWIM-DEFN-140

Requirement

A service definition shall include or refer to information about:

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

  • their expected real-world effects.

Rationale

The functions provide business and operational experts with a business view of the interactions with the service without having to look at the interface details.

Verification

Completeness: Verify that the elements are included.

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

Correctness: Not Applicable.

Examples/Notes

Example:

  • name: Request data set

  • description: The service consumer shall be able to request a data set.

  • real-world effect: The service consumer receives the data set.

Level of
Implementation

Mandatory

Guidance

Business View

  • The functions provide business and operational experts with a business view of the interactions with the service, without having to look at the technical interface details.

  • The service operations provide a technical view of the interactions.

  • Every function is usually (but not always) mapped to service operations.

The idea of a "real-world effect" can sometimes be seen as abstract when dealing with information services. The following examples may help:

  • It is possible to use a phrase such as "information is shared" when that is the purpose of the function e.g. retrieving a list of flights.

  • Phrases such as "pilots are informed" are possible when the end-use of the information is not possible to discern but the end user is known.

Verification Support

Completeness

 

 

Check that:

[  ] The service definition includes or refers to information about the functions offered by the service in support of its capabilities.

[  ] The service definition includes or refers to information about the functions' associated real-world effects.

Consistency

Check that:

[  ] The functions and real-world effects are consistent with the operational needs.

Examples

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

Status: Living Material