Working towards the next version of the SWIM Supporting Material
Page History
Panel | ||
---|---|---|
| ||
|
Info | ||
---|---|---|
| ||
This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-012 Service functionality |
Requirement
Panel | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Guidance
Info | ||
---|---|---|
| ||
|
The Examples/Notes in the specification give a good summary of "function" and "real-world effect". In general, the function can be seen as an "action" that produces a "side-effect".
However, the definition of a "real-world effect" can sometimes be seen as abstract when dealing with information services. The following examples may help:
- It is possible to use a phrase such as "information is shared" when that is the purpose of the function e.g. retrieving a list of flights.
- Phrases such as "pilots are informed" are possible when the end-use of the information is not possible to discern but the end user is known.
Verification Support
Completeness | Check that: [ ] The service description includes or refers to information about the functions offered by the service in support of its capabilities. [ ] The service description includes or refers to information about their associated real-world effects. |
Consistency | Check that: [ ] The functions and real-world effects are consistent with the operational needs. |
Examples
The following example shows the content as a table.
service functions | function | description | Allow the service consumer to set (i.e. define or update) the TOBT value for a specific flight. |
---|---|---|---|
real-world effect | The Target Off-Block Time (TOBT) value is defined. The Please refer to the A-CDM Implementation Manual defines for more information on the impact of the TOBT value at various stages of the A-CDM process. | ||
function | description | Allow the service consumer to delete the TOBT value for a specific flight. | |
real-world effect | The Target Off-Block Time (TOBT) value is undefined. The Please refer to the A-CDM Implementation Manual defines for more information on the impact of the TOBT value at various stages of the A-CDM process. |
The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema
Code Block | ||||
---|---|---|---|---|
| ||||
"generalDescription": { "functionality": [{ "name": "Set TOBT", "description": "Allow the service consumer to set (i.e. define or update) the TOBT value for a specific flight.", "realWorldEffect": "ThePlease Targetrefer Off-Block Time (TOBT) value is defined. The to the A-CDM Implementation Manual defines for more information on the impact of the TOBT value at various stages of the A-CDM process." }, { "name": "Delete TOBT", "description": "Allow the service consumer to delete the TOBT value for a specific flight.", "realWorldEffect": "ThePlease Targetrefer Off-Block Time (TOBT) value is undefined. The to the A-CDM Implementation Manual definesfor more information on the impact of the TOBT value at various stages of the A-CDM process." }] } |
Complete examples are available at Example service description.