/
SWIM-SERV-330 Model view

SWIM Supporting Material

SWIM-SERV-330 Model view

Owned by WILSON Scott
Last updated: 2024 Jun 10
Page Table of Content

Requirement

Title

Model view

Identifier

SWIM-SERV-330

Requirement

A service description should:

  • include or refer to a model view, expressed using a formal and standardised notation, that formalises the representation of the business logic of its service interfaces, service operations, service behaviour and exchanged information; and
  • declare the notation used to express the model view.

Rationale

Exposing the business logic of the service in a formalised notation and standardised notation allows operational and technical experts to understand how the service works and make comparisons.

Verification

Completeness: If the model view is provided, verify that the notation is declared; and verify that the model view fully covers service interfaces, service operations and exchanged information.

Consistency: If the model view is provided, verify that the model view is consistent with the service description (e.g. same service operation name).

Correctness: If the model view is provided, verify that the model view is aligned with the declared notation.

Examples/Notes

Note: It is recommended to use the UML and/or BPMN as notation.

Note: The model view covers structural and activity diagrams when using UML as notation.

Note: The model view may be included as part of the service standard required in SWIM-SERV-120.

Level of Implementation

Recommended

Guidance

Good to know

The recommendation is to provide a model view as it is useful in understanding a service. However,  a model view is not mandatory in order not to exclude services for which no such model exists.


Verification Support

Completeness

Check that:

[  ] The service description includes or refers to a model view.

[  ] The  notation is declared.

[  ] The model view fully covers the service interfaces.

[  ] The model view fully covers the service operations.

[  ] The model view fully covers the service behaviour.

[  ] The model view fully covers the exchanged information.

Consistency

Check that:

[  ] The model view is consistent with the service description (e.g. same service operation name)

Correctness

Check that:

[  ] The model view is aligned with the declared notation.

Examples

The following example shows the content as a table.

model view

public:/2019-09/TOBT_Model.xmi

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

Example of SWIM-SERV-330 using Service Metadata Schema
"references": {
 "serviceDocument": [{
  "documentType": "SERVICE_MODEL",
  "title": "TOBT Model",
  "version": "1.0",
  "description": "XMI 2.1",
  "reference": {
   "url": "public:/2019-09/TOBT_Model.xmi"
  }
 }]
}

Complete examples are available at Example service description.

Related content

Status: Living Material