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


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.

Guidance for JSON service description 

tentative JSON Guidance

Schema

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

 Schema excerpt [+]
		"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":
			{
				"type":
				{
					"description" : "The type of service validation. [SWIM-SERV-027]",
					"$ref" : "#/definitions/CodeServiceValidationType"
				},
				"description":
				{
					"description" : "The description of the service validation. [SWIM-SERV-027]",
					"type" : "string",
					"minLength":1
				}
			}
		}


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

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTMandatory
CANDIDATEOptional
DEFINITIONOptional

Guidance

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 namedescriptiontypeguidancerule
typeThe validation method used
 CodeServiceValidationType +

Code values as defined in the draft ICAO service overview.

COLLABORATIVE_VALIDATIONA validation of service jointly carried out by the service provider together with service users.

INDEPENDENT_VALIDATION 

A validation of service carried out by an independent authority.

SELF_VALIDATION 

 A validation of service carried out by the service provider.
USER_VALIDATIONA validation of service carried out by service users.

Select the validation method used for this validation activity.


Mandatory

descriptionThe description of the service validationstring

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 namedescriptiontypeguidancerule
typeThe validation method used
 CodeServiceValidationType +

Code values as defined in the draft ICAO service overview.

COLLABORATIVE_VALIDATIONA validation of service jointly carried out by the service provider together with service users.

INDEPENDENT_VALIDATION 

A validation of service carried out by an independent authority.

SELF_VALIDATION 

 A validation of service carried out by the service provider.
USER_VALIDATIONA validation of service carried out by service users.

Do not select a value



No use

descriptionThe description of the service validationstring

Make explicit that no validation has been performed.

Eg

"The service has not been validated yet."
Mandatory

Example

validation activities have been performed
		"serviceGeneralDescription": {

			"validation": [
				{
					"type": "SELF_VALIDATION",
					"description": "The service 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."
				}
			]

		}
no validation activity
		"serviceGeneralDescription": {

			"validation": [
				{
					"description": "The service has not been validated yet."
				}
			]

		}


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

  • No labels