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


Requirement

Title

Service categories

Identifier

SWIM-SERV-009

Requirement

A service description shall include the categories to which the service belongs based on the PCP information exchange areas:

  • Aeronautical information exchange;
  • Meteorological information exchange; 
  • Cooperative network information exchange;
  • Flight information exchange.

Rationale

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

This requirement supports decision making in terms of service suitability in relation to a particular usage context.

Verification

Completeness: Verify that the PCP category is present.

Consistency: Not applicable.

Correctness: Not Applicable. 

Examples/Notes

Note: It is best practice to include additional category information, and state the service categorisation scheme used, by inclusion or reference. The SESAR 1 ISRM Portfolio [RD 5] is a good source for service categories.

Level of Implementation

Mandatory

Guidance

Examples

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


Guidance for JSON service description


UNDER WORK

Unable to render {include} The included page could not be found.

Schema

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

		"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 expressed for the cases as defined in Registry URD.

caserules
COMPLIANT
CANDIDATE
DEFINITION

Guidance

tbd

ServiceCategorisation

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
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
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
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
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

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

The type of Application MEP. [SWIM-SERV-017]

List one or more code. Message exchange pattern at application level. Typical values are: Request/Reply (synchronous or asynchronous);
Publish/Subscribe (Push or Pull);
One Way. See as well doc xxx (see handbook).

(lightbulb)The MEP identification document would benefit from being aligned to values of the CodeApplicationMessageExchangeType (eg on "ONE_WAY", probably more)

Mandatory, minItems=1
geospatialCategorisationGeographicalExtent

The geographic coverage of the information provided by the service. [SWIM-SERV-009]

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

Guidance: Consider summarising it in the service abstract as well.

Optional



CodeSWIMServiceConformanceStatusType - FR7


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

Evolution: Consider splitting notions conformance status from service type

Evolution: Consider a shorter name (eg CodeConformanceStatusType or CodeServiceTypeType).



Properties:

  • SWIM_COMPLIANT 

                TBD

Guidance: Select this code for a service instance that is operational and that is conformant to the 3 SWIM specifications. 

  • SWIM_CANDIDATE 

                TBD

Guidance: Select this code for a service instance  that is not meeting the criteria for SWIM_COMPLIANT

  • DEFINITION 

                TBD

Guidance Select this code for a service definition.


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



GeographicalExtent

Consider an additional field to define or complement the geographical extent textually (eg thru a polygon). Consider adding a list of ICAO Regions (as in SvcOvw). See Schema evolution

Rationale: Allow consumer to understand the geographical coverage of the service.
Guidance: Geographical coverage may be expressed in terms of ICAO state, FIR, Aerodrome. 

TBD: List here applicable document.


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

List zero or more code values.  

Question: which document defines the values?

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

List zero or more code values.  

Applicable values are 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

List zero or more code values.  

Applicable values are in ICAO doc 7910.

Optional


Codes


Example

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

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


  • No labels