SWIM Supporting Material

Verification checklist for service definitions

The specification contains a conformity checklist. It sets out whether conformance with the requirement is "mandatory", "recommended", “optional“ or applicable "when the conditions apply". The organisation or person responsible for the service definition is expected to complete the checklist. It is then possible to attach the checklist to the service definition as evidence of conformance.

To conform with a requirement, the entire requirement has to be satisfied. This includes the need to perform verification. Each requirement contains a statement on the type of verification that is expected (i.e. "completeness", "correctness", "consistency"). The checklist below elaborates on these statements e.g. by spelling out the elements when the requirement states "Verify that the 3 elements are included".

The checklist below is a summary of all of the verification details for easy reference. It is possible to use the table within your own processes.

Requirement

Verification type

Check that:

Level of implementation

Notes

Requirement

Verification type

Check that:

Level of implementation

Notes

SWIM-DEFN-010 Service definition coverage

Correctness

[  ] The service definition describes one and only one service.

Mandatory

 

SWIM-DEFN-020 Service definition language

Correctness

[  ] The textual descriptions in the service definition are correct British English.

Mandatory

 

SWIM-DEFN-030 Service definition identification

Completeness

[  ] The service definition has a title.

[  ] The service definition has an edition.

[  ] The service definition has a reference date.

Mandatory

 

SWIM-DEFN-040 Service identification

Completeness

[  ] The service definition includes a name for the service.

Mandatory

 

SWIM-DEFN-050 Service abstract

Completeness

[  ] The service definition includes a short textual description summarising the service.

Mandatory

 

SWIM-DEFN-085 Service definition provider

Completeness

[  ] The service definition includes the service definition provider's name.

[  ] The service definition includes the service definition provider's abbreviated name (if applicable).

[  ] The service definition includes the description of the organisation responsible for the service definition .

Mandatory

 

SWIM-DEFN-090 Geographical extent of information

Correctness

[  ] The information about the geographical coverage of the exchanged information service payload in the service definition is correct.

Optional

 

SWIM-DEFN-095 Intended service providers and consumers

Correctness

[  ] The information about the typical service provider type and typical service consumer(s) type in the service definition is correct.

Recommended

 

SWIM-DEFN-100 Service categories

Completeness

[  ] The service definition includes the service categories to which the service belongs.

[  ] The service definition includes, if applicable, the reference the service categorisation schemes used.

Mandatory

 

SWIM-DEFN-120 Service standard reference

Consistency

[  ] The service definition references the service standards to which the service adheres.

Mandatory (Conditional)

 

SWIM-DEFN-130 Operational environment

Completeness

[  ] The service definition includes or refers to information about the operational environment.

Mandatory

 

SWIM-DEFN-140 Service functions

Completeness

 

 

[  ] 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.

Mandatory

 

Consistency

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

SWIM-DEFN-150 Service access and use conditions

Correctness

[  ] The information about the legal constraints which apply to accessing and using the service in the service definition is correct.

[  ] The information about the service policies which apply to accessing and using the service in the service definition is correct.

[  ] The information about the service consumption constraints which apply to accessing and using the service in the service definition is correct.

Recommended

 

SWIM-DEFN-160 Security constraints

Correctness

[  ] The information about the security constraints which are expected to apply to accessing and using the service in the service definition is correct.

Recommended

 

SWIM-DEFN-180 Quality of service

Completeness

[  ] The service definition includes or refers to information about the minimum quality of service offered with regards to performance.

[  ] The service definition includes or refers to information about the minimum quality of service offered with regards to reliability.

[  ] The service definition includes or refers to information about the minimum quality of service offered with regards to security.

Mandatory

 

SWIM-DEFN-185 Quality of data

Completeness

[  ] The service definition includes or refers to information about the expected minimum quality of the data to be provided by the service.

Mandatory

 

SWIM-DEFN-190 Source of information

Correctness

[  ] The information on the expected source(s) of the information provided is correct in the service definition is correct.

Recommended

 

SWIM-DEFN-200 Service validation information

Correctness

[  ] The information about any service prototyping activities that have taken place in the service definition is correct.

Optional

 

SWIM-DEFN-210 Application message exchange pattern

Completeness

[  ] The service definition includes or refers to information about the application message exchange pattern(s) expected to be used by the service.

Mandatory

 

Consistency

[  ] The information is consistent with the selected service interface binding.

SWIM-DEFN-220 Service behaviour

Completeness

[  ] The service definition includes or refers to information about the expected typical behaviour of the service.

Mandatory

 

SWIM-DEFN-230 Service monitoring

Not Applicable

 

Optional

 

SWIM-DEFN-240 Service interfaces

Completeness

[  ] The service definition includes or refers to information about the exposed service interfaces.

[  ] The  information about the exposed service interfaces includes the name of the service interface.

[  ] The  information about the exposed service interfaces includes a textual description of the service interface including its purpose.

[  ] The  information about the exposed service interfaces includes an indication that the interface is a provider side interface or a consumer side interface.

Mandatory

 

SWIM-DEFN-250 SWIM Technical Infrastructure Profile

Completeness

[  ] The service definition includes or refers to information about the profile and interface bindings for each service interface.

[  ] The  information about the profile and interface bindings includes the selected SWIM TI Profile and its version.

Mandatory

 

SWIM-DEFN-255 SWIM service and network interface binding

Not Applicable

 

Optional

 

SWIM-DEFN-260 Service interface protocols and data format

Consistency

[  ] The protocols are consistent with the selected interface binding.

Optional

 

SWIM-DEFN-270 Service operations

Completeness

[  ] The service definition includes or refers to information about the exposed service operations.

[  ] The  information about the service operations includes the name of the service operation.

[  ] The  information about the service operations includes a description of the intent and the results of the service operation.

Mandatory

 

Consistency

[  ] The service operations are consistent with the messaging technology needs.

SWIM-DEFN-280 Service messages

Completeness

[  ] The service definition includes or refers to information about the input messages that are exchanged by the service.

[  ] The service definition includes or refers to information about the output messages that are exchanged by the service.

[  ] The service definition includes or refers to information about the error messages that are exchanged by the service.

Mandatory

 

SWIM-DEFN-290 Information definition (minimum)

Completeness

[  ] The service definition includes or refers to information about the exchanged information service payload.

[  ] The  information about the exchanged information service payload includes the name of the elements.

[  ] The  information about the exchanged information service payload includes the definition of the elements.

[  ] The  information about the exchanged information service payload includes the data type used by the elements if applicable.

[  ] The  information about the exchanged information service payload includes the semantic correspondence of the elements with the AIRM.

Mandatory

 

Consistency

[  ] The elements are consistent with each other and with the AIRM concepts used in the semantic correspondence.

SWIM-DEFN-300 Information definition (extended)

Not Applicable

 

Recommended

 

SWIM-DEFN-310 Filter encoding

Completeness

[  ] The service definition includes or refers to information about the filter encoding if filter expressions are applied.

Mandatory (Conditional)

 

SWIM-DEFN-320 Machine-readable service interface definition

Completeness

[  ] The service definition includes or refers to a service interface definition in a machine-readable format if the service interface binding supports it.

Recommended (Conditional)

 

Consistency

[  ] The provided elements are consistent with the selected binding.

SWIM-DEFN-330 Model view

Correctness

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

Optional

 

SWIM-DEFN-350 Abbreviations and acronyms

Completeness

[  ] The service definition includes or refers to definitions for all the abbreviations and acronyms used in the service definition .

Mandatory

 

Consistency

[  ] The abbreviations/acronyms and their definitions are used consistently in the service definition.

 

Status: Living Material