Working towards the next version of the SWIM Supporting Material
Page History
Table of Contents |
---|
Requirement
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Guidance
Examples
See the Service Standard Reference section within the Donlon TOBT Setting Service Description.
Guidance for JSON service description
Excerpt | ||||||
---|---|---|---|---|---|---|
|
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Rules expressed for the cases as defined in Registry URD.
|
Guidance
Within "implementedStandard" field (itself within "serviceDescriptionReferences" field) create one instance of the ImplementedStandard type.
Two cases must be distinguished when filling that structure, depending on whether the service adheres to a service standard or not.
Info | ||
---|---|---|
| ||
implementedStandard is designed to cover other needs. This guidance focuses on SWIM-SERV-010 only. |
Case 1 - The service adheres to a service standard
attribute name | description | rule | guidance |
---|---|---|---|
standardType | The type of implemented standard. | Mandatory | Select code value SERVICE_STANDARD. |
isConformant | An indication whether the information service conforms to a reference. [SWIM-SERV-010] | Mandatory | select code value true |
title | The name by which the document is formally known. | Mandatory | provide the name of the service standard or the title of the service standard document. |
version | The current version or revision level of the document. | Mandatory | makes clear the version of the service standard this service version adheres to. |
conformanceStatement | A statement on any implemented options or deviation from the standard. | Mandatory Conditional | state implemented options of the service standard, if any state deviation from the service standard, if any |
description | The description of the entity. | Optional | optionally provide a description of the service standard. |
reference | An external reference at which the standard can be retrieved or consulted. | Optional | optionally provide an external link to the service standard. Prefer using this field than an instance of the Document type with code value STANDARD_REFERENCE. Note: In case of doubt, the version field makes clear the version of the standard. |
Case 2 - The service does not adhere to a service standard
attribute name | description | rule | guidance |
---|---|---|---|
standardType | The type of implemented standard. | Mandatory | Select code value SERVICE_STANDARD. |
isConformant | An indication whether the information service conforms to a reference. [SWIM-SERV-010] | Mandatory | select code value false |
title | The name by which the document is formally known. | No use | |
version | The current version or revision level of the document. | No use | |
conformanceStatement | A statement on any implemented options or deviation from the standard. | No use | |
description | The description of the entity. | Optional | optionally provide a comment. |
reference | An external reference at which the standard can be retrieved or consulted. | No use |
Example
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceDescriptionReferences": {
"implementedStandard": [
{
"standardType": "SERVICE_STANDARD",
"isConformant": true,
"title": "EUROCONTROL Specification for Airspace Management (ASM) Support System Requirements supporting the ASM processes at local and FAB level, Part II – ASM to ASM Systems Interface Requirements",
"version": "1.0",
"conformanceStatement": "All interfaces have been implemented, except for the LongTermPlanning interface",
"description": "ASM to ASM service as from EUROCONTROL-SPEC-179",
"reference": ""
}
], |
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceDescriptionReferences": { "implementedStandard": [ { "standardType": "SERVICE_STANDARD", "isConformant": false } ], |
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.