Working towards the next version of the SWIM Supporting Material

Page tree

Versions Compared

Key

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

The SWIM Service Description specification in various digital means, in support of internal processes, such as service provider requirements management.

Table of Contents
maxLevel2

Electronic source

source -  the official source of the specification as a PDF file

Search tool

searching requirements - web page from the SWIM Registry for the display of the specification requirements, allowing ordering, searching and filtering

Requirements in structured format

requirements in XLS - file with the specification requirements in Excel format

requirement in XML - file with the specification requirements in XML format

requirements in JSON - file with the specification requirements in JSON format

XML format snippet

Code Block
languagexml
themeConfluence
titleExample of a requirement expressed in XML
linenumberstrue
collapsetrue
<requirement>
	<title>Service abstract</title>
	<identifier>SWIM-SERV-007 </identifier>
	<requirementText>A service description shall include an abstract as a small textual description in plain language summarising the service.</requirementText>
	<rationale>A good abstract is valuable, in particular during service discovery.
	This requirement supports the decisions on whether the described service is suitable for use in a particular situation.</rationale>
	<verification>
		<completeness>Verify that the element is included.</completeness>
		<consistency>Not Applicable.</consistency>
		<correctness>Not Applicable.  </correctness>
	</verification>
	<examplesNotes>Note: It is best practice for an abstract to summarise the information provided elsewhere in the service description and not to bring any new information. </examplesNotes>
</requirement>

JSON format snippet

Code Block
languagejs
themeEclipse
titleExample of a requirement expressed in JSON
linenumberstrue
collapsetrue
{
	"title":"Service abstract",
	"identifier":"SWIM-SERV-007 ",
	"requirementText":"A service description shall include an abstract as a small textual description in plain language summarising the service.",
	"rationale":"A good abstract is valuable, in particular during service discovery.  <CR> This requirement supports the decisions on whether the described service is suitable for use in a particular situation.",
	"verification":{
		"completeness":"Verify that the element is included.",
		"consistency":"Not Applicable.",
		"correctness":"Not Applicable.  "
	},
	"examplesNotes":"Note: It is best practice for an abstract to summarise the information provided elsewhere in the service description and not to bring any new information. "
}


Requirements table

As opposed to the requirements in structured format, this table does not contain the full detail of the requirements.

Requirements table (multi-purpose) - table of requirements that can be sue used for multi-purposesmultiple purposes

The table only not contain a subset of the details of requirements, (such as requirement ID and title for isntance. For full details see section above Requirements in structured format.