Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »


Requirement

Title

Service validation

Identifier

SWIM-SERV-027

Requirement

A service description shall include a statement indicating

  • whether a validation of the service has been performed; and if so,
  • the method used; and
  • the results achieved.

Rationale

This requirement ensures the service description contains sufficient statements on the testing done to enable the consumer to have confidence in the quality of the service.

Verification

Completeness: Verify that the validation statement is included.

Consistency: If validation has been performed, verify that the statement includes the method and the results of the validation.

Correctness: Not Applicable.

Examples/Notes

Example service validation statement:

  • “The service has not been validated yet”.

Level of Implementation

Mandatory


Guidance

No guidance provided.


ServiceGeneralDescriptionvalidationActivity whereby a service is checked for conformance with the service objectives and requirements. [SWIM-SERV-027]ValidationOfServiceSWIM-SERV-027 Service validationFR3
Guidance: list one or more validation activities.













1600ValidationOfService---An activity whereby a service is checked 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]---SWIM-SERV-027 Service validationFR3

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.

(M)

1601ValidationOfServicetypeThe type of service validation. [SWIM-SERV-027]CodeServiceValidationType

SvcOvw

SWIM-SERV-027 Service validation

FR3

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: State the validation method used, (User Validated, Self-Validation, Collaborative, or Independent)Optional

1602ValidationOfServicedescriptionThe description of the service validation. [SWIM-SERV-027]stringSWIM-SERV-027 Service validationFR3

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.

Mandatory




























Guidance for JSON service description 

UNDERWORK

Schema

The guidance concerns JSON Schema v0.0.3 (see Schema releases).

		"ServiceGeneralDescription" : 
		{
			"description" : "Description of the service in terms of what it provides, the purpose and under which conditions and quality levels the service is provided.",
			"type": "object",
			"additionalProperties": false,
			"required": ["operationalNeed", "functionality", "qualityOfService", "accessAndUseCondition", "validation"],
			"properties":
			{


				"validation":
				{
					"description" : "Activity whereby a service is checked for conformance with the service objectives and requirements. [SWIM-SERV-027]",
					"type" : "array",
					"items" : { "$ref":"#/definitions/ValidationOfService" },
					"minItems": 1
				}
			}


		}

		
		"ValidationOfService" : 
		{
			"description" : "An activity whereby a service is checked 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]",
			"type": "object",
			"additionalProperties": false,
			"required": ["type", "description"],
			"properties":
			{
				"description":
				{
					"description" : "The description of the service validation. [SWIM-SERV-027]",
					"type" : "string",
					"minLength":1
				},
				"type":
				{
					"description" : "The type of service validation. [SWIM-SERV-027]",
					"$ref" : "#/definitions/CodeServiceValidationType"
				}
			}
		}




		"CodeServiceValidationType" : 
		{
			"description" : "A code listing types of service validations.",
			"type": "string",
			"enum":
			[
				"COLLABORATIVE_VALIDATION",
				"INDEPENDENT_VALIDATION",
				"SELF_VALIDATION",
				"USER_VALIDATION"
			]
		}

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTConditional Mandatory
CANDIDATEOptional
DEFINITIONOptional

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 


attributetypedescriptionguidancerule
monitoringDescriptionstringDescription if available of the existing monitoring capabilities and how this can be used by the consumer.

Provide the description so that the mechanism can be used by the consumer.

Mandatory

Case 2 - No mechanism is made available

Nothing needs to be described.

Example

A mechanism is made available
		"serviceTechnicalDescription": {


 			"serviceMonitoring": {
				"monitoringDescription": "The service is monitored, however there is no monitoring interface provided to the consumers"
			}

		}
No mechanism is made available
		"serviceTechnicalDescription": {

		}

A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.

  • No labels