Working towards the next version of the SWIM Supporting Material

Page tree

Versions Compared

Key

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


Table of Contents

Requirement

Expand
titleRequirement [+]
Panel
borderColorlightgrey
bgColorwhitesmoke
borderStyledashed

Title

Quality of service

Identifier

SWIM-SERV-014

Requirement

A service description shall include statements on the quality of service offered with regards to:

  • availability of the service;
  • response time of the service; and
  • throughput of the service.

Rationale

This is a key criterion in deciding to use the service.

This is key information to be included in a service level agreement and will influence the content of the SLA. It informs contract negotiations between consumers and providers.

Verification

Completeness: Verify that quality statements are included in the service description.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Note: The availability is typically expressed as a percentage representing the ratio between minimum target uptime versus maximum uptime. The service provider needs to describe the service outages he intends to mask/alleviate. The availability information needs to be expressed for various situations, e.g. planned and unplanned outages. The service provider needs to describe the schedule of planned outages.

Example of availability: ≥ 99.95 % of Continuous Operations.

Note: The response time expressing the delay to process a service request could include: delay in seconds, percentage of messages, message size.

Example of response time: 2s delay for 95% of messages of average size 1MB, with no compression.

Example of response time: max 3s response to complete a service request, measured from the time the service provider agent receives the request to the time the service provider transmits the response.

Note: The throughput is typically expressed as a number of service requests that the service can accommodate within the given time period.

Example of throughput: 200 service requests per minute.

Note: It is a good practice to describe the measuring conditions of the quality of service figures given.

Level of Implementation

Mandatory


Guidance

Examples

See the Quality of Service section within the Donlon TOBT Setting Service Description.

Guidance for JSON service description 

Excerpt

Include Page
SCOI:with JSON guidance
SCOI:with JSON guidance

Schema

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

Expand
titleSchema excerpt [+]
Code Block
languagejs
		"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":
			{

				"qualityOfService":
				{
					"description" : "The degree or level of confidence that the performance of a service meets users requirements. [SWIM-SERV-014]",
					"type" : "array",
					"items" : { "$ref":"#/definitions/QualityOfService" },
					"minItems": 1
				},

		},



		"QualityOfService" : 
		{
			"description" : "The degree or level of confidence that the performance of a service meets users requirements.",
			"type": "object",
			"additionalProperties": false,
			"required": ["name", "description"],
			"properties":
			{
				"description":
				{
					"description" : "Description of the quality of service offered with regards to: 1)availability of the service; 2)response time of the service; and 3)throughput of the service (SWIM-SERV-014). It also describes less quantitative aspects suchs as 4)integrity, 5)confidentiality and possibly any other service related qualities defined in ISO 25010",
					"type" : "string",
					"minLength":1
				},
				"name":
				{
					"description" : "The name of the quality of service. [SWIM-SERV-014]",
					"type" : "string",
					"minLength":1
				}
			}
		},
Expand
titleRules [+]

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTmandatory
CANDIDATE
DEFINITION

Guidance

Rationale: This is a key criterion in deciding to use the service. This is key information to be included in a service level agreement

and will influence the content of the SLA. It informs contract
negotiations between consumers and providers.

Guidance: Include at least statements on the quality of service offered with regards to availability, response time and throughput of the service.

Within field qualityOfService (itself within field serviceGeneralDescription) list three or more occurrences of type QualityOfService. 

QualityOfService - Mandatory

The degree or level of confidence that the performance of a service meets users requirements.

Rationale: Operational needs relate to the operational context in which the service is used. IERs reference the requirements that are at the origin of the service. 
This information supports decision making in terms of service suitability within a particular operational context.

Guidance:

  • include information about the operational needs fulfilled by the service;
  • indicate whether information exchange requirements (IER) were used in the identification of the needs for the service; and if so
  • include or refer to the information exchange requirements (IER).
  • indicate relationship to PCP and/or SESAR Deployment Plan


attribute namedescriptiontypeguidancerule
nameThe name of the quality of service.string

Provide a clear and concise name for the quality of service, such as "Availability", "Response time", "Throughput".

Consider as well describing less quantitative aspects such as "Integrity", "Confidentiality" and other service related qualities defined in ISO 25010

Mandatory
description

Description of the quality of service offered with regards to: 1)availability of the service; 2)response time of the service; and 3)throughput of the service (SWIM-SERV-014).

It also describes less quantitative aspects suchs as 4)integrity, 5)confidentiality and possibly any other service related qualities defined in ISO 25010

stringSee Notes / Examples of the requirement.Mandatory

Example

Code Block
languagejs
         "serviceGeneralDescription": {

            "qualityOfService": [
                {
                    "name": "Availability",
                    "description": "99.95 % outside the planned outages. Schedule of planned outages: http://www.donlon-airport.com/swim/planned-outages"
                },
                {
                    "name": "Capacity",
                    "description": "2000 service requests per hour"
                },
                {
                    "name": "Response time",
                    "description": "2s delay for 95% of messages"
                }
            ],

        },


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