Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
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
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 name | description | type | guidance | rule |
---|---|---|---|---|
serviceType | An indication of the status of the service with regard to SWIM Service conformance. | CodeSWIMService ConformanceStatusType | Select a code value | Mandatory |
lifeCycleStage | A classification of services based on their current, past, or future availability for provisioning. [SWIM-SERV-009] | CodeLifeCycleStepType | This 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 |
businessActivityType | The type of business activity. | CodeBusinessActivityType | List one or more codes | Mandatory, minItems=1 |
intendedConsumer | The types of service consumers that this service is intended to serve. | CodeStakeholderType | List 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 |
informationCategory | information exchange area as defined in PCP | CodeInformationExchangeCategory | List one or more code values. | Mandatory, minItems=1 |
application MessageExchangePattern | The 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); (lightbulb)The MEP identification document would benefit from being aligned to values of the CodeApplicationMessageExchangeType (eg on "ONE_WAY", probably more) | Mandatory, minItems=1 |
geospatialCategorisation | The 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 name | description | type | guidance | rule |
---|---|---|---|---|
stateICAONationalityLetters | Nationality letters of a State as defined by ICAO. | string | List zero or more code values. Question: which document defines the values? | Optional |
firICAOLocationIndicator | A 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 ICAOLocationIndicator | A 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.