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

underwork - tentative JSON Guidance

This is guidance on satisfying the requirements of service categorisation as found in European SWIM Registry.



Requirement

Identifier

SWIM-REG-0004

Title

Service categorization

Statement

The Registry shall enable the classification of services based on a common Service taxonomy [Annex B] that facilitates the discovery and comparability of resources.

Clarification

This is applicable to both service instances as well as service definitions

Level of Implementation

Mandatory

Guidance

Examples

See the Service categories section within the Donlon TOBT Setting Service Description.

Guidance for JSON service description

tentative JSON Guidance

Schema

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

 Schema excerpt [+]
		"InformationService" : 
		{
			"description" : "A type of service that provides an ATM information sharing capability.",
			"type": "object",
			"additionalProperties": false,
			"required": ["descriptionInformation", "name", "version", "serviceAbstract", "serviceProvision", "serviceCategorisation", "serviceGeneralDescription", "serviceInformationDescription", "serviceTechnicalDescription", "serviceDescriptionReferences", "serviceInterface"],
			"properties":
			{
				...
				"serviceCategorisation":
				{
					"description" : "A taxonomy used to classify a service by the type of service provided or by some other technological or architectural solution. [SWIM-SERV-009]",
					"$ref" : "#/definitions/ServiceCategorisation"
				},
				...
			}
		},



		"ServiceCategorisation" : 
		{
			"description" : "A taxonomy used to classify a service by the type of service provided or by some other technological or architectural solution. [SWIM-SERV-009]",
			"type": "object",
			"additionalProperties": false,
			"required": ["serviceType", "lifeCycleStage", "businessActivityType", "intendedConsumer", "informationCategory", "applicationMessageExchangePattern"],
			"properties":
			{
				"serviceType":
				{
					"description" : "An indication of the status of the service with regard to SWIM Service conformance.",
					"$ref" : "#/definitions/CodeSWIMServiceConformanceStatusType"
				},
				"lifeCycleStage":
				{
					"description" : "A classification of services based on their current, past, or future availability for provisioning. [SWIM-SERV-009]",
					"$ref" : "#/definitions/CodeLifeCycleStepType"
				},
				"businessActivityType":
				{
					"description" : "The type of business activity.",
					"type" : "array",
					"items" : { "$ref":"#/definitions/CodeBusinessActivityType" },
					"minItems": 1
				},
				"intendedConsumer":
				{
					"description" : "The types of service consumers that this service is intended to serve.",
					"type" : "array",
					"items" : { "$ref":"#/definitions/CodeStakeholderType" },
					"minItems": 1
				},
				"informationCategory":
				{
					"description" : "TBD",
					"type" : "array",
					"items" : { "$ref":"#/definitions/CodeInformationExchangeCategory" },
					"minItems": 1
				},
				"applicationMessageExchangePattern":
				{
					"description" : "The type of Application MEP. [SWIM-SERV-017]",
					"type" : "array",
					"items" : { "$ref":"#/definitions/CodeApplicationMessageExchangePatternType" },
					"minItems": 1
				},
				"geospatialCategorisation":
				{
					"description" : "The geographic coverage of the information provided by the service. [SWIM-SERV-009]",
					"$ref" : "#/definitions/GeographicalExtent"
				}
			}
		},

		"GeographicalExtent" : 
		{
			"description" : "The geographic coverage of the information provided by the service.\n",
			"type": "object",
			"additionalProperties": false,
			
			"properties":
			{
				"stateICAONationalityLetters":
				{
					"description" : "Nationality letters of a State as defined by ICAO. [SWIM-SERV-009]",
					"type" : "array",
					"items" : { "type":"string" }
				},
				"firICAOLocationIndicator":
				{
					"description" : "A four-letter code group formulated in accordance with rules prescribed by ICAO and assigned to the airspace. [SWIM-SERV-009]",
					"type" : "array",
					"items" : { "type":"string" }
				},
				"aerodromeICAOLocationIndicator":
				{
					"description" : "A four-letter code group formulated in accordance with rules prescribed by ICAO and assigned to the aerodrome. [SWIM-SERV-009]",
					"type" : "array",
					"items" : { "type":"string" }
				}
			}
		},


 Rules [+]

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTMandatory
CANDIDATEsame
DEFINITIONsame

Guidance

info

The defined service categories cover 2 requirements from the service description spec


Within field serviceCategorisation, itself within field informationService, fill in the attributes of type ServiceCategorisation

Service Categorisation - Mandatory

A taxonomy used to classify a service by the type of service provided or by some other technological or architectural solution.

Rationale: Service category information allows discovering services by a series of classification criteria. 


attribute nametypedescription & guidancerule
serviceType
 CodeSWIMServiceConformanceStatusType +
code valuedescription

SWIM_COMPLIANT 

for a service instance that is operational and that is conformant to the 3 SWIM specifications
SWIM_CANDIDATE for a service instance that is not meeting the criteria for SWIM_COMPLIANT

DEFINITION 

for a service definition

An indication of the status of the service with regard to SWIM Service conformance.

Select one code value


Mandatory
lifeCycleStage
 CodeLifeCycleStepType +
code valuedescription

OPERATIONAL  

The status indicating that the service is employed in its operational environment.
PROSPECTIVE The status indicating that the service is being designed, developed, or tested for operational activities and is expected to be available in the future.

RETIRED 

The status indicating that active support for the service has been withdrawn, the service has been partially or totally replaced by a new service, or an upgraded service has been installed.

A classification of service instances based on their current, past, or future availability for provisioning.

This is the life-cycle stage of a service instance. It has no meaning for a service definition

Select one code value, depending on the selected serviceType

serviceTypeguidance
SWIM_COMPLIANT Select OPERATIONAL
SWIM_CANDIDATE Select OPERATIONAL if already operational, else select PROSPECTIVE.
DEFINITION Do not use. (leave empty, as this code has meaning for service instances only)
Mandatory
businessActivityType
 CodeBusinessActivityType +
code valuedescription

AERODROME_OPERATION 

 Planning, execution and analysis of airport airside activities, including, but not limited to, how the aerodrome operators provide the needed ground infrastructure and precise surface guidance to improve safety and maximize aerodrome capacity in all weather conditions.
AIRSPACE_ORGANISATION_AND_MANAGEMENT how airspace organizations establish airspace structures in order to accommodate the different types of air activity, volume of traffic and differing levels of service, and about the process by which airspace options are selected and applied to meet the needs of the ATM community.

AIRSPACE_USER_OPERATIONS 

 The ATM-related aspect of flight operations.
CONFLICT_MANAGEMENT 

  - the strategic conflict management through airspace organization and management, demand and capacity balancing, and traffic synchronization;

- separation provision;

- and collision avoidance.

DEMAND_AND_CAPACITY_BALANCING    the strategic evaluation of the system-wide traffic flows and aerodrome capacities to allow airspace users to determine when, where and how they operate, while mitigating conflicting needs for airspace and aerodrome capacity.
INFORMATION_MANAGEMENT TBD
SERVICE_DELIVERY_MANAGEMENT TBD
TRAFFIC_SYNCHRONISATION TBD

The type of business activity.

Select one or more code values


Mandatory, minItems=1
intendedConsumer
 CodeStakeholderType +
code valuedescription

CIVIL_AIRSPACE_USER 


MILITARY_AIRSPACE_USER 

CIVIL_AIR_NAVIGATION_SERVICE_PROVIDER 


MILITARY_AIR_NAVIGATION_SERVICE_PROVIDER
AIR_TRAFFIC_SERVICE_PROVIDER
REGULATED_METEOROLOGICAL_SERVICE_PROVIDER
AERONAUTICAL_INFORMATION_SERVICE_PROVIDER 
COMMUNICATION_NAVIGATION_AND_SURVEILLANCE_SERVICE_PROVIDER
PROVIDER_OF_DATA_SERVICES
NETWORK_MANAGER
AIRPORT_OPERATOR
AIRSIDE_GROUND_HANDLER
MILITARY_DEFENCE_CENTRE 

The types of service consumers that this service is intended to serve.

Select one or more code values.

Guidance: list the "intended" consumer audience from your point of view. This does not mean that consumers outside that list wouldn't benefit from the service.


Mandatory, minItems=1
informationCategory
 CodeInformationExchangeCategory +
code valuedescription

AERONAUTICAL_INFORMATION_EXCHANGE 


METEOROLOGICAL_INFORMATION_EXCHANGE  

COOPERATIVE_NETWORK_INFORMATION_EXCHANGE 


FLIGHT_INFORMATION_EXCHANGE 
SWIM_INFRASTRUCTURE_EXCHANGE

Information exchange area as defined in PCP.

This is the core of requirement SWIM-SERV-009 Service categories.

Select one or more code values.  


Mandatory, minItems=1
application MessageExchangePattern
 CodeApplication MessageExchangePatternType +
code valuedescription
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.



The type of Application MEP (Message exchange pattern at application level).

This is covered by requirement SWIM-SERV-017 Message exchange pattern where a full explanation can be found (requirement, general guidance, etc).

Select one or more code values.

Typical values are:

  • Request/Reply (synchronous or asynchronous)
  • Publish/Subscribe (Push or Pull)
  • One Way
Mandatory, minItems=1
geospatialCategorisationGeographicalExtent (see below)

The geographic coverage of the information provided by the service.

Rationale: Allow consumer to understand and search on the geographical coverage of the service.

Guidance: Consider filling in the relevant attributes of type GeographicalExtent.

Optional

Geographical Extent - Optional

The geographic coverage of the information provided by the service.

Rationale: Allow consumer to understand the geographical coverage of the service.

Guidance: Geographical coverage may be expressed in terms of ICAO state, FIR, and Aerodrome. 

tip

For expressing the geographical extent in other terms, such as ICAO Region, polygon or even textually, consider adding that information to the service abstract (see SWIM-SERV-007 Service abstract) and/or using Concept type (see SERV-OVW-008 Geographical extent).


Consider filling in the relevant attributes.

attribute namedescriptiontypeguidancerule
stateICAONationalityLettersNationality letters of a State as defined by ICAO.string

Provide zero or more code values.  

Applicable values can be found in ICAO doc 7910.

Optional
firICAOLocationIndicatorA four-letter code group formulated in accordance with rules prescribed by ICAO and assigned to the airspace.string

Provide zero or more code values.  

Applicable values can be found in ICAO doc 7030.

Optional
aerodrome ICAOLocationIndicatorA four-letter code group formulated in accordance with rules prescribed by ICAO and assigned to the aerodrome.string

Provide zero or more code values.  

Applicable values can be found in ICAO doc 7910.

Optional

Example

		"serviceCategorisation": {
			"serviceType": "SWIM_COMPLIANT",
			"lifeCycleStage": "OPERATIONAL",
			"businessActivityType": [
				"AERODROME_OPERATION"
			],
			"intendedConsumer": [
				"AIRSIDE_GROUND_HANDLER",
				"CIVIL_AIRSPACE_USER",
				"MILITARY_AIRSPACE_USER"
			],
			"informationCategory": [
				"FLIGHT_INFORMATION_EXCHANGE"
			],
			"applicationMessageExchangePattern": [
				"SYNCHRONOUS_REQUEST_REPLY"
			],
			"geospatialCategorisation": {
				"aerodromeICAOLocationIndicator": [
					"EADD"
				]
			}
		}

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

  • No labels