Working towards the next version of the SWIM Supporting Material
Page History
Table of Contents |
---|
Requirement
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Guidance
Examples
See the Service behaviour section within the Donlon TOBT Setting Service Description.
Guidance for JSON service description
Excerpt | ||||||
---|---|---|---|---|---|---|
|
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Rules expressed for the cases as defined in Registry URD.
|
Guidance
Additional attributes to Interface type as described in SWIM-SERV-016 Service interfaces.
In JSON the service behaviour is expressed per service interface.
This may be complemented by a service SERVICE_BEHAVIOUR_DESCRIPTION document.
Tip | ||
---|---|---|
| ||
The service behaviour can be captured in formal modelling notations such as a Unified Modeling Language (UML) sequence diagram, and/or expressed as textual description in plain language. In the latter case, whether for a model file or for a document with diagrams, use a SERVICE_BEHAVIOUR_DESCRIPTION document. |
Interface - additional attribute
Additional attribute to Interface type as described in SWIM-SERV-016 Service interfaces.
attribute name | description | type | guidance | rule |
---|---|---|---|---|
behaviour | The manner in which a service operates under normal and unexpected conditions. | ServiceBehaviour | Provide one or more behaviours. Rationale: This requirement facilitates the understanding of the service behaviour, including the sequencing of service operations to support operational processes, and the error handling. Note: The behaviour description may refer to a SERVICE_BEHAVIOUR_DESCRIPTION document. Note: Behaviour often concerns closely related operations in the same interface. Would behaviour relate operations from different interface, feel free to describe it in one of the concerned interface. | Mandatory, minItems=1 |
Behaviour - Mandatory
It is mandatory to provide one or more service behaviour(s) for each interface.
Notes:
- Service behaviour often concerns closely related operations in the same interface.
- When service behaviour relate operations from different interfaces, feel free to describe it in one of the concerned interfaces.
- When service behaviour is made available in a document, make this clear in the behaviour.description of each interface
attribute name | description | type | guidance | rule |
---|---|---|---|---|
name | The name of the service behaviour. | string | Provide a short name for the behaviour | Mandatory |
description | The description of the service behaviour. | string | Describe the behaviour as
And / or make reference to a SERVICE_BEHAVIOUR_DESCRIPTION document. | Mandatory |
Behaviour document - Optional
Service behaviour may be provided as a document of type SERVICE_BEHAVIOUR_DESCRIPTION.
See Guidance on serviceDocument on how to fill in documents.
Example
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceInterface": [
{
"behaviour": [
{
"name": "nominal behaviour",
"description": "Each operation of the interface can be called independently.\r\nThe following diagram illustrates the interaction between the service consumer and the service"
}
]
}
] |
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceInterface": [ { "behaviour": [ { "name": "behaviour document", "description": "The service behaviour is fully described in the SERVICE_BEHAVIOUR_DESCRIPTION document" } ], } ] "serviceDocument": [ { "documentType": "SERVICE_BEHAVIOUR_DESCRIPTION " "title": "Service Behaviour", "version": "1.0", "description": "", "reference": "... ...", } ] |
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.