Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Current »


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

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

Example of a requirement expressed in XML
<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

Example of a requirement expressed in JSON
{
	"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

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

The table is limited to requirements' title, ID and implementation level. 

  • No labels