Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
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
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Guidance
info
The defined service categories cover 2 requirements from the service description spec
- SWIM-SERV-009 Service categories with attribute informationCategory
- SWIM-SERV-017 Message exchange pattern with attribute applicationMessageExchangePattern
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 name | type | description & guidance | rule | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
serviceType | An indication of the status of the service with regard to SWIM Service conformance. Select one code value | Mandatory | |||||||||
lifeCycleStage | 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
| Mandatory | |||||||||
businessActivityType | The type of business activity. Select one or more code values | Mandatory, minItems=1 | |||||||||
intendedConsumer | 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 | 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 | 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:
| Mandatory, minItems=1 | |||||||||
geospatialCategorisation | GeographicalExtent (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 name | description | type | guidance | rule |
---|---|---|---|---|
stateICAONationalityLetters | Nationality 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 |
firICAOLocationIndicator | A 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 ICAOLocationIndicator | A 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.