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.
...
[ ] The service description has a title.
[ ] The service description has an edition.
[ ] The service description has a reference date.
...
[ ] The service description includes a name for the service.
[ ] The service description includes a version for the service.
...
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 a short textual description summarising the service information about the geographical coverage of the exchanged information service payload. | Mandatory | ||||||||
SWIM-SERV-060 100 Service providercategories | Completeness | [ ] The service description includes the service categories to which the service provider's namebelongs. [ ] 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, if applicable, the reference the service categorisation schemes used. | Mandatory | ||||||||
SWIM-SERV-070 Provider point of contactCorrectness110 Service lifecycle information | Completeness | [ ] The name of the provider point of contact is correct.[ ] The contact information of the provider point of contact is correctservice description includes information on the lifecycle stage that the service is currently in. [ ] The role of the provider point of contact is correct. Recommendedservice description includes, if applicable, qualifying dates for the lifecycle stage. | Mandatory | ||||||||
SWIM-SERV- | 080 Support availabilityCorrectness120 Service standard reference | Completeness | [ ] The name of the support point of contact is correct.[ ] The contact information of the support point of contact is correctservice description includes a reference to the service standard to which the service adheres. [ ] The role of the support point of contact is correct. | Recommended | SWIM-SERV-090 Geographical extent of information | Completeness | service description includes a statement on any implemented options of the service standard. [ ] The service description includes information about the geographical coverage of the exchanged information service payloada statement on any deviation from or addition to the service standard. | Mandatory | SWIM-SERV-100 Service categories | Completeness(Conditional) | |
Consistency | [ ] The service description includes the service categories to which the service belongs.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 , if applicable, the reference the service categorisation schemes usedor refers to information about the operational environment. | Mandatory | ||||||||
SWIM-SERV- | 110140 Service | lifecycle informationfunctions | Completeness | [ ] The service description includes or refers to information on the lifecycle stage that about the functions offered by the service is currently in support of its capabilities. [ ] The service description includes , if applicable, qualifying dates for the lifecycle stage. Mandatoryor 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- | 120 Service standard reference150 Service access and use conditions | Completeness | [ ] The service description includes a reference or refers to the service standard to which information about the legal constraints which apply to accessing and using the service adheres. [ ] The service description includes a statement on any implemented options of the service standardor refers to information about the service policies which apply to accessing and using the service. Consistency[ ] The service description includes a statement on any deviation from or addition to the service standard. | Mandatory (Conditional) | or refers to information about the service consumption constraints which apply to accessing and using the service. | Mandatory | |||||
SWIM-SERV-160 Security constraints | Completeness | [ ] If the service adheres to a service standard, verify that the reference to the service standard is included.The service description includes or refers to information about the security constraints which apply to accessing and using the service. | Mandatory | ||||||||
SWIM-SERV-130 Operational environmentCompleteness170 Additional technical information for the service consumer | Consistency | [ ] The service description includes or refers to information about the operational environmenttechnical constraints corresponds to the described service. | Mandatory (Conditional) | ||||||||
SWIM-SERV- | 140 Service functions180 Quality of service | 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 | minimum quality of service offered with regards to performance. [ ] The service description includes or refers to information about the legal constraints which apply to accessing and using the serviceminimum quality of service offered with regards to reliability. [ ] The service description includes or refers to information about the service policies which apply to accessing and using the serviceminimum 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 service description includes or refers to information about the service consumption constraints which apply to accessing and using the service. Mandatorydetails concerning any modifications that have been applied to the information are correct. | Recommended | ||||||||
SWIM-SERV- | 160 Security constraints200 Service validation information | 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 | Consistencythe 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 technical constraints corresponds to the described application message exchange pattern(s) used by the service. | Mandatory | (Conditional)SWIM-SERV-180 Quality of service | Completeness | ||||||
Consistency | [ ] The service description includes or refers to information about the minimum quality of service offered with regards to performance.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 minimum quality typical behaviour of the service offered with regards to reliability. Recommended[ ] 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. | 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- | 200230 Service | validation informationmonitoring | 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 patternrefers 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 application message exchange pattern(s) used by the service. | Mandatory | Consistency | exposed service interfaces. [ ] The information is consistent with the selected service interface binding. | SWIM-SERV-220 Service behaviour | Completeness The information about the exposed service interfaces includes the name of the service interface. [ ] The service description includes or refers to The information about the typical behaviour exposed service interfaces includes a textual description of the service interface including its purpose. [ ] The service description includes or refers to The information about error handling during the typical behaviour of the servicethe exposed service interfaces includes an indication that the interface is a provider side interface or a consumer side interface. | Mandatory | |||
Consistency | [ ] The names of the interfaces, service operations and exchanged information are consistent with the interface definitionsFor each provider side interface, verify that the network address is provided. | ||||||||||
SWIM-SERV- | 230 Service monitoring250 SWIM TI Profile and interface bindings | 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 interfacesabout 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 exposed service interfaces includes the name of the service interfaceprofile and interface bindings includes a reference to a service interface binding as specified in the selected SWIM TI Profile. [ ] The information about the exposed service interfaces includes a textual description of the service interface including its purposeprofile and interface bindings includes a reference to a network interface binding as specified in the selected SWIM TI Profile. [ ] The information about the exposed service interfaces includes an indication that the interface is a provider side interface or a consumer side interfaceprofile and interface bindings includes references to additionally supported requirements as specified in the selected SWIM TI Profile. | Mandatory | |||
Consistency | [ ] For each provider side interface, verify that the network address is provided.SWIM-SERV-250 SWIM TI Profile and interface bindingsThe 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 | Mandatory | ||||||||||
SWIM-SERV-270 Service operations | |||||||||||
SWIM-SERV-280 Service messages | |||||||||||
SWIM-SERV-290 Information definition - minimum | |||||||||||
SWIM-SERV-300 Information definition - extended | |||||||||||
SWIM-SERV-310 Filter encoding | |||||||||||
SWIM-SERV-320 Machine-readable service interface definition | |||||||||||
SWIM-SERV-330 Model view | |||||||||||
SWIM-SERV-340 Examples of code | |||||||||||
SWIM-SERV-350 Abbreviations and acronyms |
...