Working towards the next version of the SWIM Supporting Material
Page History
Table of Contents |
---|
Requirement
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Guidance
No guidance provided.
Guidance
: list one or more validation activities.for
conformance with the service objectives and requirements. Note: the service objectives and requirements are captured in the service overview and the technical specifications. [SWIM-SERV-027]Rationale: User needs to know how the information service was validated in order to have confidence in the service.
Guidance: indicate whether a validation of the service has been performed; and if so, the method used; and the results achieved.
SvcOvw
Note: Missing a value for "not validated yet" (see Code Lists walk-through).
Note: Is mandatory except for the case not validated.
Descr: The validation method used
Name: Consider renaming type to method. (In addition (consider renaming type as well CodeValidationMethodType)
Guidance: Include a brief statement on the validation results, and if/how the potential consumers may obtain the validation evidence.
Example: This information service has undergone extensive testing prior to deployment by the information service provider “LMN”, infrastructure service provider “ABC”, and regulator “XYZ” to ensure that specific QoS standards are met. Operational monitoring by the information service provider is in place and the information service continues to meet all QoS requirements. For more information on this organization’s validation policies please see <URL>. Specific information regarding the validation by the regulator is available in a validation report upon request.
Guidance for JSON service description
Excerpt | ||||||
---|---|---|---|---|---|---|
UNDERWORK
|
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Rules expressed for the cases as defined in Registry URD.
|
Guidance
Guidance: When such a mechanism is made available to consumers, it is mandatory to describe it.
Case 1 - A mechanism is made available
Rationale: Allow the service consumer to use the available mechanism and monitor the service.
Within field serviceMonitoring, itself within field serviceTechnicalDescription, provide the following attribute
Provide the description so that the mechanism can be used by the consumer.
Case 2 - No mechanism is made available
Nothing needs to be described.
2 cases can be distinguished, depending on whether validation has been performed or not.
- case 1 - validation activities have been performed
- case 2 - no validation activity
Requirement: indicate whether a validation of the service has been performed; and if so, the method used; and the results achieved.
Rationale: User needs to know how the information service was validated in order to have confidence in the service.
Case 1 - Validation activities performed
Within field validation, itself within field serviceGeneralDescription, list one or more instance of ValidationOfService, describing the validation activities.
Optionally provide a validation report.
ValidationOfService - Mandatory (one or more)
An activity whereby a service is checked for conformance with the service objectives and requirements.
attribute name | description | type | guidance | rule | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | The validation method used |
| Select the validation method used for this validation activity. | Mandatory | |||||||||||||
description | The description of the service validation | string | Include a brief statement on the validation results, and if/how the potential consumers may obtain the validation evidence. Example: This information service has undergone extensive testing prior to deployment by the information service provider “LMN”, infrastructure service provider “ABC”, and regulator “XYZ” to ensure that specific QoS standards are met. Operational monitoring by the information service provider is in place and the information service continues to meet all QoS requirements. For more information on this organization’s validation policies please see <URL>. Specific information regarding the validation by the regulator is available in a validation report upon request. | Mandatory |
Validation report - Optional
Documents of type SERVICE_VALIDATION_REPORT may optionally be provided. See Guidance on serviceDocument.
Case 2 - No validation activity
Within field validation, itself within field serviceGeneralDescription, list one instance of ValidationOfService.
ValidationOfService - Mandatory (one)
An activity whereby a service is checked for conformance with the service objectives and requirements.
attribute name | description | type | guidance | rule | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | The validation method used |
| Do not select a value | No use | |||||||||||||
description | The description of the service validation | string | Make explicit that no validation has been performed. Eg "The service has not been validated yet." | Mandatory |
Example
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceTechnicalDescriptionserviceGeneralDescription": { "validation": [ { "serviceMonitoringtype": {"SELF_VALIDATION", "monitoringDescriptiondescription": "The service is monitored, however there is no monitoring interface provided to the consumers has been subject to intensive Verification and Validation, in alignment with our Quality Management System." }, { "type": "COLLABORATIVE_VALIDATION", "description": "The service has been subject to two validation sessions with service consumers. The validation report is available upon request." } ] } |
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceTechnicalDescriptionserviceGeneralDescription": { "validation": [ { "description": "The service has not been validated yet." } ] } |
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.