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

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 namedescriptiontypeguidancerule
serviceTypeAn indication of the status of the service with regard to SWIM Service conformance.CodeSWIMService ConformanceStatusTypeSelect a code valueMandatory
lifeCycleStageA classification of services based on their current, past, or future availability for provisioning. [SWIM-SERV-009]CodeLifeCycleStepTypeThis is the life-cycle stage of a service instance. Use OPERATIONAL if already operational, either use PROSPECTIVE. Don't put any value for a DEFN.Mandatory; value= OPERATIONAL
businessActivityTypeThe type of business activity.CodeBusinessActivityTypeList one or more codesMandatory, minItems=1
intendedConsumerThe types of service consumers that this service is intended to serve.CodeStakeholderTypeList one or more codes. 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
informationCategoryinformation exchange area as defined in PCP
CodeInformationExchangeCategory

List one or more code values.  


Mandatory, minItems=1
application MessageExchangePatternThe type of Application MEP. [SWIM-SERV-017]CodeApplication MessageExchangePatternType

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
geospatialCategorisationThe geographic coverage of the information provided by the service. [SWIM-SERV-009]GeographicalExtent

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


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