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 5 Next »


Requirement

Title

Service standard reference

Identifier

SWIM-SERV-010

Requirement

A service description shall include 

  • a statement indicating whether the service adheres to a service standard; and if so,
  • a reference to the service standard;
  • a statement on any implemented options of the service standard; and
  • a statement on any deviation from the service standard.

Rationale

The reference to standards is essential information, fostering reuse.

Verification

Completeness: Verify that the statement about adherence to a reference standard is included.

Consistency: If the service adheres to a service standard, verify that the reference to the service standard is included.

Correctness: Not Applicable.

Examples/Notes

Example service standard references:

  • “EUROCAE Arrival Sequence standardised service design, version 1.0”;
  • “Not adherent to a service standard”.

Level of Implementation

Mandatory

Guidance

Examples

See the Service Standard Reference section within the Donlon TOBT Setting Service Description.

Guidance for JSON service description - underwork

underwork - tentative JSON Guidance

This is a tentative for integrating in the SWIM Service Description Handbook the guidance material for producing JSON service descriptions.

Schema

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

		"serviceDescriptionReferences":
				{
					"description" : "A container for references to documents describing specific aspects of the service instance.",
					"$ref" : "#/definitions/ServiceDescriptionReferences"
				}


		"ServiceDescriptionReferences" : 
		{
			"description" : "References to complementary documents that provide additional details about the service.",
			"type": "object",
			"additionalProperties": false,
			"required": ["implementedStandard"],
			"properties":
			{
				"implementedStandard":
				{
					"description" : "A standard used for the implementation of the service.",
					"type" : "array",
					"items" : { "$ref":"#/definitions/ImplementedStandard" },
					"minItems": 1
				},
				...
			}
		},


		"ImplementedStandard" : 
		{
			"description" : "A standard used for the implementation of the service.",
			"type": "object",
			"additionalProperties": false,
			"required": ["standardType", "isConformant"],
			"properties":
			{
				"standardType":
				{
					"description" : "The type of implemented standard.",
					"$ref" : "#/definitions/CodeServiceStandardType"
				},
				"isConformant":
				{
					"description" : "An indication whether the information service conforms to a reference. [SWIM-SERV-010]",
					"type" : "boolean"
				},
				"title":
				{
					"description" : "The name by which the document is formally known. [SWIM-SERV-005;SWIM-SERV-010]",
					"type" : "string",
					"minLength":1
				},
				"version":
				{
					"description" : "The current version or revision level of the document.",
					"type" : "string"
				},
				"conformanceStatement":
				{
					"description" : "A statement about the degree of conformance of the service against the standard.",
					"type" : "string",
					"minLength":1
				},
				"description":
				{
					"description" : "The description of the entity.",
					"type" : "string",
					"minLength":1
				},
				"reference":
				{
					"description" : "An external reference at which the standard can be retrieved or consulted.",
					"type" : "string"
				}
			}
		},

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTmandatory, 1 or more values
CANDIDATEsame
DEFINITIONsame

Guidance

Fill in one or more values in attribute applicationMessageExchangePattern, within service categorisation.

Enumerated values

REQUEST_REPLY An application MEP consisting of a consumer sending a request to an information service, the service then executing the request and providing a reply to the consumer.
ONE_WAY An application MEP consisting of a consumer sending a message to an information service without any requisite response from the information service.
PUBLISH_SUBSCRIBE An application MEP consisting of a consumer sending a subscription request to an information service, the service then providing the consumer with means to access the subscribed information.
FAN_OUT An application MEP consisting of a consumer sending sequentially a message to multiple information service according to the One-Way application MEP.
SYNCHRONOUS_REQUEST_REPLY A Request/Reply application MEP requiring that the consumer wait for the information service to provide a response, and is unable to send/receive any other requests/responses until the initial response is received.
ASYNCHRONOUS_REQUEST_REPLY A Request/Reply application MEP that does not restrict the consumer from completing other operations while waiting for the information service to respond.
PUBLISH_SUBSCRIBE_WITH_PUSH_MECHANISM A Publish/Subscribe pattern whereby the information service sends necessary updates (publish) to the consumer, in accordance with the subscription.
PUBLISH_SUBSCRIBE_WITH_PULL_MECHANISM A Publish/Subscribe pattern whereby the information service keeps necessary updates available to the consumer, in accordance with the subscription.
BROKERED_PUBLISH_SUBSCRIBE_WITH_PUSH_MECHANISM A Publish/Subscribe pattern with push mechanism introducing a layer of decoupling between the publisher and subscribers by means of a broker.

JSON example

non adherence
		"serviceDescriptionReferences": {
			"implementedStandard": [
				{
					"standardType": "SERVICE_STANDARD",
					"isConformant": false
				}
			],
TBD adherence
		"serviceDescriptionReferences": {
			"implementedStandard": [
				{
					"standardType": "SERVICE_STANDARD",
					"isConformant": true,
					"title": "EUROCONTROL Specification for Airspace Management (ASM) Support System Requirements supporting the ASM processes at local and FAB level, Part II – ASM to ASM Systems Interface Requirements", 
					"version": "1.0",
					"description": "ASM to ASM service as from EUROCONTROL-SPEC-179",
					"conformanceStatement": "",
					"reference": ""
				}
			],

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

  • No labels