Versions Compared

Key

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

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.

080 Support availabilityCorrectnessCompleteness110 lifecycle information120 Service standard reference140 Service functions160 Security constraints (Conditional)200 validation informationSWIM-SERV-210 Application message exchange pattern230 Service monitoring
RequirementVerification typeCheck that:Level of implementationNotes
SWIM-SERV-010 Service description coverageCorrectness[  ] 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 identificationCompleteness

[  ] The service description has a title.

[  ] The service description has an edition.

[  ] The service description has a reference date.

Mandatory
SWIM-SERV-040 Service identificationCompleteness

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

[  ] The service description includes a version for the service.

Mandatory
SWIM-SERV-050 Service abstractCompleteness[  ] The service description includes a short textual description summarising the service.Mandatory
SWIM-SERV-060 Service providerCompleteness

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

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

[  ] 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 informationCompleteness[  ] 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 providercategoriesCompleteness

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

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

Recommended

service description includes, if applicable, qualifying dates for the lifecycle stage.

Mandatory
SWIM-SERV-120 Service standard referenceCompleteness

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

RecommendedSWIM-SERV-090 Geographical extent of informationCompleteness

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 payload

a statement on any deviation from or addition to the service standard.

Mandatory SWIM-SERV-100 Service categories(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 environmentCompleteness[  ] The service description includes , if applicable, the reference the service categorisation schemes usedor refers to information about the operational environment.Mandatory
SWIM-SERV-140 Service functionsCompleteness

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

Mandatory

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 conditionsCompleteness

[  ] 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 constraintsCompleteness[  ] 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 consumerConsistency[  ] The service description includes or refers to information about the operational environmenttechnical constraints corresponds to the described service.Mandatory (Conditional)
SWIM-SERV-180 Quality of serviceCompleteness

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

MandatoryConsistency[  ] The functions and real-world effects are consistent with the operational needs.SWIM-SERV-150 Service access and use conditionsCompleteness

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 informationCorrectness

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

Mandatory

details concerning any modifications that have been applied to the information are correct.

Recommended
SWIM-SERV-200 Service validation informationCompleteness[  ] The service description includes or refers to information about the security constraints which apply to accessing and using the service.MandatorySWIM-SERV-170 Additional technical information for the service consumerConsistencythe 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 patternCompleteness[  ] 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.MandatorySWIM-SERV-180 Quality of serviceCompleteness
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 behaviourCompleteness

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

MandatorySWIM-SERV-190 Source of informationCorrectness

[  ] 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-230 Service monitoringCompleteness[  ] The service description includes or refers to information about the validation that has occurred.MandatoryConsistency[  ] If validation has been performed, that the statement includes the method and the results of the validation.refers to information that describe how to use the service monitoring mechanism.Mandatory (Conditional)
SWIM-SERV-240 Service interfacesCompleteness

[  ] The service description includes or refers to information about the

application message exchange pattern(s) used by the service.
MandatoryConsistency

exposed service interfaces.

[  ]

The information is consistent with the selected service interface binding.
SWIM-SERV-220 Service behaviourCompleteness

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-250 SWIM TI Profile and interface bindingsCompleteness

[  ] The service description includes or refers to information

that describe how to use the service monitoring mechanism.
Mandatory (Conditional)SWIM-SERV-240 Service interfacesCompleteness

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



...