SWIM Supporting Material
Verification checklist for service descriptions
- WILSON Scott
The specification contains a conformity checklist. It sets out whether conformance with the requirement is "mandatory", "recommended" or "mandatory when the conditions apply". The organisation or person responsible for the service description is expected to complete the checklist. It is then possible to attach the checklist to the service description 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 |
|---|---|---|---|---|
| SWIM-SERV-010 Service description coverage | Correctness | [ ] The service description describes one and only one service. | Mandatory | |
| SWIM-SERV-020 Service description language | Correctness | [ ] The textual descriptions in the service description are correct British English. | Mandatory | |
| SWIM-SERV-030 Service description identification | Completeness | [ ] The service description has a title. [ ] The service description has an edition. [ ] The service description has a reference date. | Mandatory | |
| SWIM-SERV-040 Service identification | Completeness | [ ] The service description includes a name for the service. [ ] The service description includes a version for the service. | Mandatory | |
| SWIM-SERV-050 Service abstract | Completeness | [ ] The service description includes a short textual description summarising the service. | Mandatory | |
| SWIM-SERV-060 Service provider | Completeness | [ ] The service description includes the service provider's name. [ ] The service description includes the service provider's abbreviated name (if applicable). [ ] The service description includes the description of the organisation responsible for the service. | Mandatory | |
| SWIM-SERV-070 Provider point of contact | Correctness | [ ] The name of the provider point of contact is correct. [ ] The contact information of the provider point of contact is correct. [ ] The role of the provider point of contact is correct. | Recommended | |
| SWIM-SERV-080 Support availability | Correctness | [ ] The name of the support point of contact is correct. [ ] The contact information of the support point of contact is correct. [ ] The role of the support point of contact is correct. | Recommended | |
| SWIM-SERV-090 Geographical extent of information | Completeness | [ ] The service description includes information about the geographical coverage of the exchanged information service payload. | Mandatory | |
| SWIM-SERV-100 Service categories | Completeness | [ ] The service description includes the service categories to which the service belongs. [ ] The service description includes, if applicable, the reference the service categorisation schemes used. | Mandatory | |
| SWIM-SERV-110 Service lifecycle information | Completeness | [ ] The service description includes information on the lifecycle stage that the service is currently in. [ ] The service description includes, if applicable, qualifying dates for the lifecycle stage. | Mandatory | |
| SWIM-SERV-120 Service standard reference | Completeness | [ ] The service description includes a reference to the service standard to which the service adheres. [ ] The service description includes a statement on any implemented options of the service standard. [ ] The service description includes a statement on any deviation from or addition to the service standard. | Mandatory (Conditional) | |
| Consistency | [ ] If the service adheres to a service standard, verify that the reference to the service standard is included. | |||
| SWIM-SERV-130 Operational environment | Completeness | [ ] The service description includes or refers to information about the operational environment. | Mandatory | |
| SWIM-SERV-140 Service functions | Completeness | [ ] The service description includes or refers to information about the functions offered by the service in support of its capabilities. [ ] The service description includes or refers to information about their associated real-world effects. | Mandatory | |
| Consistency | [ ] The functions and real-world effects are consistent with the operational needs. | |||
| SWIM-SERV-150 Service access and use conditions | Completeness | [ ] The service description includes or refers to information about the legal constraints which apply to accessing and using the service. [ ] The service description includes or refers to information about the service policies which apply to accessing and using the service. [ ] The service description includes or refers to information about the service consumption constraints which apply to accessing and using the service. | Mandatory | |
| SWIM-SERV-160 Security constraints | Completeness | [ ] The service description includes or refers to information about the security constraints which apply to accessing and using the service. | Mandatory | |
| SWIM-SERV-170 Additional technical information for the service consumer | Consistency | [ ] The information about the technical constraints corresponds to the described service. | Mandatory (Conditional) | |
| SWIM-SERV-180 Quality of service | Completeness | [ ] The service description includes or refers to information about the minimum quality of service offered with regards to performance. [ ] The service description includes or refers to information about the minimum quality of service offered with regards to reliability. [ ] The service description includes or refers to information about the minimum quality of service offered with regards to security. | Mandatory | |
| SWIM-SERV-190 Source of information | Correctness | [ ] The source(s) of the information provided is correct. [ ] The details concerning any modifications that have been applied to the information are correct. | Recommended | |
| SWIM-SERV-200 Service validation information | Completeness | [ ] The service description includes or refers to information about the validation that has occurred. | Mandatory | |
| Consistency | [ ] If validation has been performed, that the statement includes the method and the results of the validation. | |||
| SWIM-SERV-210 Application message exchange pattern | Completeness | [ ] The service description includes or refers to information about the application message exchange pattern(s) used by the service. | Mandatory | |
| Consistency | [ ] The information is consistent with the selected service interface binding. | |||
| SWIM-SERV-220 Service behaviour | Completeness | [ ] The service description includes or refers to information about the typical behaviour of the service. [ ] The service description includes or refers to information about error handling during the typical behaviour of the service. | Mandatory | |
| Consistency | [ ] The names of the interfaces, service operations and exchanged information are consistent with the interface definitions. | |||
| SWIM-SERV-230 Service monitoring | Completeness | [ ] The service description includes or refers to information that describe how to use the service monitoring mechanism. | Mandatory (Conditional) | |
| SWIM-SERV-240 Service interfaces | Completeness | [ ] The service description 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 | |
| Consistency | [ ] For each provider side interface, verify that the network address is provided. | |||
| SWIM-SERV-250 SWIM TI Profile and interface bindings | Completeness | [ ] The service description 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. [ ] The information about the profile and interface bindings includes a reference to a service interface binding as specified in the selected SWIM TI Profile. [ ] The information about the profile and interface bindings includes a reference to a network interface binding as specified in the selected SWIM TI Profile. [ ] The information about the profile and interface bindings includes references to additionally supported requirements as specified in the selected SWIM TI Profile. | Mandatory | |
| Consistency | [ ] The selected service interface binding, network interface binding and additionally supported requirements are consistent with the selected SWIM TI Profile and version. | |||
| SWIM-SERV-260 Service interface protocols and data format | Completeness | [ ] The service description includes or refers to information about the service interface protocols (including name and version) for each provider side and consumer side interface. [ ] The service description includes or refers to information about the data format to be used for each provider side and consumer side interface. | Mandatory | |
| Consistency | [ ] The protocols are consistent with the selected interface binding. | |||
| SWIM-SERV-270 Service operations | Completeness | [ ] The service description 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 against the messaging technology needs. | |||
| SWIM-SERV-280 Service messages | Completeness | [ ] The service description includes or refers to information about the input messages that are exchanged by the service. [ ] The service description includes or refers to information about the output messages that are exchanged by the service. [ ] The service description includes or refers to information about the error messages that are exchanged by the service. | Mandatory | |
| SWIM-SERV-290 Information definition - minimum | Completeness | [ ] The service description 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-SERV-300 Information definition - extended | - | - | Recommended | |
| SWIM-SERV-310 Filter encoding | Completeness | [ ] The service description includes or refers to information about the filter encoding if filter expressions are applied. | Mandatory (Conditional) | |
| SWIM-SERV-320 Machine-readable service interface definition | Completeness | [ ] The service description includes or refers to a service interface definition in a machine-readable format if the service interface binding supports it. | Mandatory (Conditional) | |
| Consistency | [ ] The provided elements are consistent with the selected binding. | |||
| SWIM-SERV-330 Model view | Completeness | [ ] 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. | Recommended | |
| Consistency | [ ] The model view is consistent with the service description (e.g. same service operation name) | |||
| Correctness | [ ] The model view is aligned with the declared notation. | |||
| SWIM-SERV-340 Examples of code | Consistency | [ ] The provided examples correspond to the described service. | Recommended | |
| SWIM-SERV-350 Abbreviations and acronyms | Completeness | [ ] The service description includes or refers to definitions for all the abbreviations and acronyms used in the service description. | Mandatory | |
| Consistency | [ ] The abbreviations/acronyms and their definitions are used consistently in the service description and are consistent with those used in the information service payload. |
Status: Living Material