Registry Data Structure

 

Schema for service descriptions

https://github.com/eurocontrol-swim/service-metadata-schema/blob/sds-upgrade/description/SRV-DESC_SCHEMA.json 

Schema for service definitions

https://github.com/eurocontrol-swim/service-metadata-schema/blob/v2/definition/DEFINITION-V2.json 

Guidelines

Guidelines on how to understand the different elements part of this schema .

Element Name Attribute Name Description Attribute Type Service Spec Trace Guideline COMP Rule DEFN Rule CAND Rule
InformationService --- Description of an information service. [SWIM-SERV-010] --- SWIM-SERV-010 Service Description coverage Guidance: Describe here your prospective service, operational service or service definition. Mandatory same same
InformationService descriptionInformation Metadata about the description. DescriptionInformation multiple Note: This information is about the document  more than the underlying service. Mandatory same same
InformationService serviceIdentification Information for identifying the service. ServiceIdentification SWIM-SERV-030 Service identification Rationale: This requirement supports the identification and citation of a service description. Mandatory, minLength=1 same same
InformationService serviceAbstract A brief summary of the service offering. [SWIM-SERV-050] string SWIM-SERV-050 Service abstract Rationale: The abstract, by ensuring an understanding of the service, supports the decisions on whether the service is suitable for use in a particular situation. Mandatory, minLength=5 same same
It is best practice for the abstract to include:
the information domain(s) covered by the information service
the operational need being addressed by the information service
the intended use of the information service, and
the intended consumer audience for the information service

It is good to consider including:

- the geographical extent of the information provided

- the service's first date of operation e.g. "The service has been in operation since yyyy-mm-dd".
InformationService serviceProvider Description about who provides the service, when and how it is supported. [SWIM-SERV-060] ServiceProvider SWIM-SERV-060 Service provider Rationale: Knowing the service provider is essential to business experts. Mandatory same as 
serviceDefinitionProvider		 same
InformationService serviceCategorisation A taxonomy used to classify a service by the type of service provided or by some other technological or architectural solution. ServiceCategorisation SWIM-SERV-100 Service categories Service category information allows discovering services by a series of classification criteria. Mandatory same same
InformationService generalDescription A container for information about what the service provides, its purpose and under which conditions and quality levels it is provided. ServiceGeneralDescription multiple   Mandatory same same
InformationService informationDescription A container for the description of the information exchanged by the information service. ServiceInformationDescription multiple Rationale: Provide a description of the information/data that is exchanged by the service. Mandatory same same
InformationService technicalDescription A container for information about the security mechanisms, technical constraints and monitoring of the information service. ServiceTechnicalDescription multiple Note: the attribute is mandatory, so that authors consider the underlying Mandatory Conditional information. Mandatory same same
InformationService serviceInterface The means by which the underlying capabilities of a service are accessed. ServiceInterface multiple Guidance: Describe one or more interfaces. Mandatory, minItems=1 same same
Provide all interfaces: provider side and consumer side interfaces.
InformationService

references

 A container for references to documents describing specific aspects of the service instance. ServiceDescriptionReferences multiple   Mandatory    
DescriptionInformation --- Meta information about the service description. --- multiple Note: This groups information specific to the service description, and not about the underlying service. Mandatory same same
DescriptionInformation descriptionIdentification Information that supports the identification and citation of a service description. [SWIM-SERV-030] DescriptionIdentification SWIM-SERV-030 Description identification   Mandatory same same
DescriptionInformation abbreviations Abbreviations or acronyms used by the service description. Abbreviation SWIM-SERV-350 Define abbreviations Guidance: Define all abbreviations and acronyms used in the description. Unless they are systematically made explicit, such as in "IFR (Instrument Flight Rules)". Mandatory, minItems=0 same same
ServiceIdentification --- Information for identifying the service. --- multiple Note: The name of the service is a piece of identifying information that gives stakeholders a way to reference or identify a service. Mandatory same same
ServiceIdentification name A piece of identifying information that gives stakeholders a way to reference or identify a service. [SWIM-SERV-040] string SWIM-SERV-040 Service identification   Mandatory, minItems=0 same same
ServiceIdentification version The version of the information service. [SWIM-SERV-040] string SWIM-SERV-040 Service identification   Mandatory, minItems=0 same same
DescriptionIdentification --- Information that supports the identification and citation of a service description. [SWIM-SERV-030] --- SWIM-SERV-030 Description identification Rationale: This requirement supports the identification and citation of a service description. Mandatory same same
DescriptionIdentification title The name by which the document is formally known. [SWIM-SERV-030] string SWIM-SERV-030 Description identification   Mandatory, minLength=5 same same
DescriptionIdentification edition The edition of the document. [SWIM-SERV-030] string SWIM-SERV-030 Description identification Note: The edition of the service description is not to be confused with the version of the service. A service description can evolve to a new edition while still describing the same service version. Mandatory, minLength=1 same same
DescriptionIdentification referenceDate A reference date for use in citing the service description. [SWIM-SERV-030] string SWIM-SERV-030 Description identification   Mandatory, format is "yyyy-mm-dd" same same
Abbreviation --- An abbreviation or acronym used by the service description. [SWIM-SERV-350] --- SWIM-SERV-350 Abbreviations and acronyms Guidance: BIt is possible to include abbreviations and acronyms in the service description in combination with references to external sources. Mandatory same same
Abbreviation name The name of the abbreviation. [SWIM-SERV-350] string SWIM-SERV-350 Abbreviations and acronyms The abbreviated form eg "IFR". Mandatory, minLength=1 same same
Verification: Check if the abbreviation exists in AIRM, verify the term is the same.
Abbreviation description The description of the abbreviation. string SWIM-SERV-350 Abbreviations and acronyms The term in full lenth eg "Instrument Flight Rules". Verification: Check if the term exists in AIRM and is abbreviated, verify the abbreviation is the same. Mandatory, minLength=5 same same
ServiceProvider --- An entity (person or organization) that offers the use of capabilities by means of a service. [SWIM-SERV-060] --- SWIM-SERV-060 Service provider Guidance:
Knowing the name (and abbreviated name) of the service provider is essential to business experts and service consumers in order to ensure they know with whom they are interacting.		 Mandatory same as serviceDefinitionProvider same
ServiceProvider provider The full official name of the organisation. [SWIM-SERV-060] string SWIM-SERV-060 Service provider   Mandatory, minLength=1 same  
ServiceProvider providerDescription Description of the organisational unit responsible for the service. [SWIM-SERV-060] string SWIM-SERV-060 Service provider description of the organisation responsible for the service. Mandatory, minLength=5 same  
ServiceProvider providerType The type of service provider. [SWIM-SERV-060] CodeStakeholderType SWIM-SERV-060 Service provider name     Mandatory, minItems=1
ServiceProvider abbreviation The abbreviated name of the organisation. [SWIM-SERV-060] string SWIM-SERV-060 Service provider abbreviated name (if applicable)      
ServiceProvider pointOfContact List of persons or groups within the service provider organization, suitable for making a human contact for any purpose. [SWIM-SERV-070] PointOfContact SWIM-SERV-070 Service provider Provider point of contact      
PointOfContact --- List of persons or groups within the service provider organization, suitable for making a human contact for any purpose. --- SWIM-SERV-070 Guidance: The point of contact can have multiple roles. For example it may be:
- customer relations covering the basics on how to gain access to the service;
- a url that allows a potential service consumer to download technical details and user manuals about the service.		 Mandatory    
Example points of contact: “Customer Relations, to request access to the service,  http://www.donlon-airport.com/swim/service-request ”; “Service Desk, to report incidents on services in operation, contact [24/7] +693 555 01  [email protected] ”.
PointOfContact name The name of the point of contact. string SWIM-SERV-070 name Mandatory, minLength=1 same same
PointOfContact contactInformation Information used to correspond with the point of contact. ContactInformation SWIM-SERV-070 contact information Mandatory   same
PointOfContact role The role of the point of contact. string SWIM-SERV-070 role Mandatory   same
ContactInformation --- Information used to correspond with the point of contact. [SWIM-SERV-070] --- SWIM-SERV-070   Mandatory   same
ContactInformation type The type of contact information. [SWIM-SERV-070] CodeContactInformationType SWIM-SERV-070 The type of contact information. Mandatory same same
ContactInformation address A phone number or an electronic mail address used to correspond with the point of contact. [SWIM-SERV-070] string SWIM-SERV-070 A phone number or an electronic mail address used to correspond with the point of contact. Mandatory same same
ServiceCategorisation --- A taxonomy used to classify a service by the type of service provided or by some other technological or architectural solution. [SWIM-SERV-100] --- SWIM-SERV-100 Service categories Rationale: Service category information allows discovering services by a series of classification criteria. Mandatory same same
ServiceCategorisation serviceType An indication of the status of the service with regard to SWIM Service conformance. CodeSWIMService ConformanceStatusType SWIM-SERV-100 Service categories Guidance: Select a code as indicated in Code Lists walk-through. Mandatory, value= SWIM_COMPLIANT same, value=SWIM_DEFINITION same, value= SWIM_CANDIDATE
ServiceCategorisation lifeCycle A classification of services based on their current, past, or future availability for provisioning. [SWIM-SERV-110] lifeCycle SWIM-SERV-110 Service lifecycle information This requirement ensures that the service consumer can assess the lifecycle stage and make a decision on whether to use the service. Mandatory   same
ServiceCategorisation businessActivityType The type of business activity. CodeBusinessActivityType SWIM-SERV-100 Service categories Select one or more code values      
ServiceCategorisation intendedConsumer The types of service consumers that this service is intended to serve. CodeStakeholderType SWIM-SERV-100 Service categories Select one or more code values      
Note: 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.
ServiceCategorisation informationCategory A categorisation of services based on information domains. Multiple categories are acceptable, each category is a choice between an enumeration or a string in case no value in the enumeration is applicable. CodeInformationExchangeCategory SWIM-SERV-100 Service categories Select one or more code values Mandatory, minItems=1 same same
ServiceCategorisation application MessageExchangePattern The type of Application MEP. [SWIM-SERV-210] applicationMessageExchangePattern SWIM-SERV-210 Application message exchange pattern Select one or more code values. Mandatory, minItems=1 same same
Typical message exchange patterns (as from the SWIM Technical Infrastructure Yellow Profile [RD 4]): Request/Reply (synchronous or asynchronous); Publish/Subscribe (Push or Pull);
One Way (also known as Fire and Forget).
ServiceCategorisation geospatialCategorisation The geographic coverage of the information provided by the service. [SWIM-SERV-090] GeographicalExtent SWIM-SERV-090 Geographical extent of information Rationale: This allows information service consumers to understand the geographical coverage of the information being provided. This enables the assessment of the use of the service. Mandatory Optional Mandatory
Guidance: The geographical extent of the information can be expressed in various ways. 
ServiceCategorisation other Other information [SWIM-SERV-100] other SWIM-SERV-100 Service categories Other information Optional same same
other name Name of the category. [SWIM-SERV-100] string SWIM-SERV-100 Service categories Name of the category. Mandatory same same
other value Value taken by the service in the category. [SWIM-SERV-100] string SWIM-SERV-100 Service categories Value taken by the service in the category. Mandatory same same
other categorisationScheme A reference to the categorisation scheme used. [SWIM-SERV-100] Reference SWIM-SERV-100 Service categories A reference to the categorisation scheme used. Optional Mandatory Optional
GeographicalExtent --- The geographic coverage of the information provided by the service. --- SWIM-REG-0004 Service categorization Guidance: Geographical coverage may be expressed in terms of ICAO state, FIR, Aerodrome. Optional same same
SERV-OVW-008 Geographical extent Rationale: Allow consumer to understand the geographical coverage of the service.
GeographicalExtent countryCode Nationality letters of a State as defined by ICAO. [SWIM-REG-0004] string SWIM-REG-0004 Service categorization List zero or more code values.  Applicable values are in ICAO doc 7910. Optional same same
GeographicalExtent fir A four-letter code group formulated in accordance with rules prescribed by ICAO and assigned to the airspace. [SWIM-REG-0004] string SWIM-REG-0004 Service categorization List zero or more code values.  Applicable values are in ICAO doc 7030. Optional same same
GeographicalExtent aerodrome A four-letter code group formulated in accordance with rules prescribed by ICAO and assigned to the aerodrome. [SWIM-REG-0004] string SWIM-REG-0004 Service categorization List zero or more code values.  Applicable values are in ICAO doc 7910. Optional same same
GeographicalExtent description Additional optional description of the geographical extent. string SWIM-SERV-090 Geographical extent of information   Optional same same
GeographicalExtent region An ICAO region as defined in Appendix 1 to the Directives to Regional Air Navigation Meetings and Rules of Procedure for their Conduct (ICAO Doc 8-AN/874). [SERV-OVW-008] CodeICAORegionType SWIM-SERV-090 Geographical extent of information   Optional same same
GeographicalExtent geometry A geoJSON GeometryCollection allowing to describe the geographical geometry of the InformationGeographicalExtent. GeometryCollection https://geojson.org/schema/GeometryCollection.json   Optional same same
ServiceGeneralDescription --- Description of the service in terms of what it provides, the purpose and under which conditions and quality levels the service is provided. --- multiple   Mandatory same same
ServiceGeneralDescription operationalEnvironment Details about the operational environment to which the service relates. [SWIM-SERV-130] OperationalEnvironment SWIM-SERV-130 Operational environment

Guidance: 

the operational needs. This is the service from the point of view of the service consumer.  It details what the service should do to satisfy the consumer's needs. 

the capabilities. This is the service from the provider viewpoint. It details what the service can do.

 Mandatory same same
Rationale:

    
Information about the operational environment is useful to get an understanding of the service.

Information about the operational needs addressed by the service and the capabilities the service offers supports decision making in terms of service suitability within a particular operational context.
ServiceGeneralDescription functionality A type of activity describing the functionality of a service. [SWIM-SERV-140] Functionality SWIM-SERV-140 Service functions A function is a type of activity describing the functionality of a service. Mandatory same same
Rationale: The functions provide business and operational experts with a business view of the interactions with the service without having to look at the interface details.
ServiceGeneralDescription accessAndUseCondition Conditions which apply to accessing and using the service, such as legal constraint, service policies, service consumption constraints and security constraints. [SWIM-SERV-150] AccessAndUseCondition SWIM-SERV-150 Service access and use conditions List the conditions that apply to access or use the service. Mandatory Optional Mandatory
Rationale: This requirement ensures that a service consumer is aware of any restrictions on the access and use of the service.
It is good practice to share business constraint information associated with the conditions of usage of the service.
ServiceGeneralDescription dateInOperation Date at which the service went into operation or is planned to become operational. string   Date at which the service went into operation or is planned to become operational. Mandatory Optional Optional
ServiceGeneralDescription qualitiesOfService The degree or level of confidence that the performance of a service meets users requirements. [SWIM-SERV-180] QualityOfService SWIM-SERV-180 Quality of service Guidance: The quality of service informs the negotiations of the "formal arrangement". This is further explained at Formal Arrangements - Service Level Agreements. Mandatory same same
Rationale: This is a key criterion in deciding to use the service. Statements on the quality of service are typically included in the formal arrangements made between the service provider and a service consumer when contracting to use the service. The information in the service description informs contract negotiations between consumers and providers.
ServiceGeneralDescription serviceSupport Service support point of contact information. [SWIM-SERV-080] PointOfContact SWIM-SERV-080 Support availability
 		 Rationale: This information is essential to allow service consumers to understand the type of support to expect. Optional same same
ServiceGeneralDescription concepts Optional information intended for a good understanding of the service. This may cover design concepts related to the service, logical model, design considerations, or any other information not pertaining to the other fields. Concept SWIM-SERV-ADD Additional info List additional information deemed useful for a good use of the service. Optional same same
SWIM-SERV-024 Filter capabilities Use as well for pre-defined uses such as, for instance, Filter capabilities or Sources of information.
SERV-OVW-008 Geographical extent         The Concept type covers some predefined uses as well. Each predefined use is related to a requirement, and proposes a value for the "name" field (which would allow automatic processing).
SERV-OVW-017 Sources of information  
ServiceGeneralDescription validation Activity whereby a service is checked for conformance with the service objectives and requirements. [SWIM-SERV-200] ValidationOfService SWIM-SERV-200 Service validation information List one or more validation activities. Mandatory    
OperationalNeed --- A statement of the operational attributes of a system needed for the effective and/or efficient provision of air traffic services to users. [SWIM-SERV-130] --- SWIM-SERV-130 Operational environment Rationale: 

Information about the operational environment is useful to get an understanding of the service.

Information about the operational needs addressed by the service and the capabilities the service offers supports decision making in terms of service suitability within a particular operational context.

 Optional same same
OperationalNeed name The name of the operational requirement. [SWIM-SERV-130] string SWIM-SERV-130 Operational environment The name of the operational requirement. Mandatory same same
OperationalNeed description Description of the operational needs fulfilled by the service. Includes or refers to information exchange requirements. [SWIM-SERV-130]. string SWIM-SERV-130 Operational environment Description of the operational needs fulfilled by the service. Includes or refers to information exchange requirements. Optional Optional Mandatory
OperationalNeed reference   Reference SWIM-SERV-130 Operational environment   Optional same same
SupportedCapability --- A statement of the operational capabilities supported by the service. [SWIM-SERV-130] --- SWIM-SERV-130 Operational environment A statement of the operational capabilities supported by the service. Optional same same
SupportedCapability name The name of the supported capability. [SWIM-SERV-130] string SWIM-SERV-130 Operational environment The name of the supported capability. Mandatory same same
SupportedCapability description Description of the operational capability supported by the service. [SWIM-SERV-130]. string SWIM-SERV-130 Operational environment Description of the operational capability supported by the service. Optional same same
SupportedCapability reference   Reference SWIM-SERV-130 Operational environment   Optional same same
Functionality --- A type of activity describing the functionality of a service. [SWIM-SERV-140] --- SWIM-SERV-140 Service functions Rationale: The functions provide business and operational experts with a business view of the interactions with the service without having to look at the interface details.

Guidance: 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".

 Mandatory same same
Functionality name The name of the service function. string SWIM-SERV-140 Service functions The name of the service function. Mandatory same same
Functionality description Description of the service function. [SWIM-SERV-140] string SWIM-SERV-140 Service functions Description of the service function. Mandatory same same
Functionality realWorldEffect An ultimate purpose associated with the interaction with the service. It may be the response to a request for information or the change in the state of some entities shared between the participants in the interaction. [SWIM-SERV-140] string SWIM-SERV-140 Service functions An ultimate purpose associated with the interaction with the service. It may be the response to a request for information or the change in the state of some entities shared between the participants in the interaction. Mandatory same same
AccessAndUseCondition --- A condition which applies to accessing and using the service, such as legal constraint, service policies, service consumption constraints and security constraints. [SWIM-SERV-150] --- SWIM-SERV-150 Service access and use conditions Rationale: 

This requirement ensures that a service consumer is aware of any restrictions on the access and use of the service.

It is good practice to share business constraint information associated with the conditions of usage of the service.

 Mandatory Optionale Mandatory
AccessAndUseCondition type The type of service access or use condition. [SWIM-SERV-150] CodeAccessAndUseConditionType SWIM-SERV-150 Service access and use conditions Select the code value indicating the type of condition: LEGAL CONSTRAINT , SERVICE POLICY, SERVICE CONSUMPTION CONSTRAINT, SECURITY CONSTRAINT, OTHER. Mandatory same same
AccessAndUseCondition name The name of the condition. [SWIM-SERV-150] string SWIM-SERV-150 Service access and use conditions Provide a short name for the condition. Mandatory same  
AccessAndUseCondition description Description of the conditions that influence accessing and using the service, such as legal constraint; service policies; service consumption constraints. Concrete access control and other security mechanisms are described in the technical section of the form. [SWIM-SERV-150] string SWIM-SERV-150 Service access and use conditions Describe the conditions which apply to accessing and using the service, so that the consumer is aware of any limitations on the access and use of the service. Optional Optional Optional
Note: the SD spec includes examples of such conditions.
Note: Concrete access control and other security mechanisms are described in the technical section of the form (see SecurityMechanism)
AccessAndUseCondition reference   Reference SWIM-SERV-150 Service access and use conditions   Optional Optional Optional
QualityOfService --- The degree or level of confidence that the performance of a service meets users requirements. [SWIM-SERV-180] --- SWIM-SERV-180 Quality of service Rationale: 

This is a key criterion in deciding to use the service.

Statements on the quality of service are typically included in the formal arrangements made between the service provider and a service consumer when contracting to use the service. The information in the service description informs contract negotiations between consumers and providers.

 Mandatory same same
QualityOfService name The name of the quality of service. [SWIM-SERV-180] string SWIM-SERV-180 Quality of service Provide a clear and concise name for the quality of service, such as "Availability", "Response time", "Throughput". Mandatory same same
Consider as well describing less quantitative aspects such as "Integrity", "Confidentiality" and other service related qualities defined in ISO 25010
QualityOfService description Description of the quality of service offered with regards to: 1)availability of the service; 2)response time of the service; and 3)throughput of the service (SWIM-SERV-014). It also describes less quantitative aspects suchs as 4)integrity, 5)confidentiality and possibly any other service related qualities defined in ISO 25010 string SWIM-SERV-180 Quality of service See Notes / Examples of the requirement. Optional Optional Mandatory
QualityOfService reference   Reference SWIM-SERV-180 Quality of service   Optional Optional Optional
Concept --- Optional information intended for a good understanding of the service. This may cover design concepts related to the service, logical model, design considerations, or any other information not pertaining to the other fields. [SWIM-SERV-330, SWIM-SERV-340] --- SWIM-SERV-330 Model view Exposing the business logic of the service in a formalised notation and standardised notation allows operational and technical experts to understand how the service works and make comparisons. Optional Optional Optional
SWIM-SERV-340 Examples of code Providing example code is a best practice to speed up prototyping.
Concept name The name of the concept. string SWIM-SERV-340 Examples of code Guidance: Define a name that makes clear what the description is about. Mandatory same same
For -predefine use, use the name as defined below precisely (which would allow automatic processing):
Concept description Description of the concept. string SWIM-SERV-340 Examples of code Provide the description. Optional Optional Mandatory
Concept reference   Reference SWIM-SERV-340 Examples of code        
ValidationOfService --- An activity whereby a service is checked for conformance with the service objectives and requirements. Note: the service objectives and requirements are captured in the service overview and the technical specifications. [SWIM-SERV-200] --- SWIM-SERV-200 Service validation information

A service description shall include or refer to information about the validation that has occurred indicating:

whether a validation of the service, including the quality of the service, has been performed; and if so,

the method used;

the summary of the validation steps performed;

the results achieved;

how the service consumer may obtain the validation evidence.

This requirement ensures the service description contains sufficient statements on the testing done to enable the consumer to have confidence in the service’s ability to deliver the declared capabilities and in the quality of the service.

 Mandatory Optional Optional
ValidationOfService type The validation method used. [SWIM-SERV-200] CodeServiceValidationType SWIM-SERV-200 Service validation information The validation method used. Mandatory Mandatory Mandatory
ValidationOfService description The description of the service validation. Including; summary of validation steps, results achieved and pointer to validation evidence. [SWIM-SERV-200] description SWIM-SERV-200 Service validation information The description of the service validation. Including; summary of validation steps, results achieved and pointer to validation evidence. Optional same same
ValidationOfService validationSteps Summary of the validation steps performed. [SWIM-SERV-200] string SWIM-SERV-200 Service validation information Summary of the validation steps performed. Optional same same
ValidationOfService validationResults The results achieved on the validation. [SWIM-SERV-200] string SWIM-SERV-200 Service validation information The results achieved on the validation. Optional same same
ValidationOfService evidence Where or how to obtain the available evidence of the validation. [SWIM-SERV-200] string SWIM-SERV-200 Service validation information Where or how to obtain the available evidence of the validation. Optional same same
ServiceInformationDescription --- A container for the description of the information exchanged by the information service. [SWIM-SERV-290] --- multiple A container for the description of the information exchanged by the information service. Mandatory same same
ServiceInformationDescription informationDefinition A formal representation of information concepts or data concepts. [SWIM-SERV-290][SWIM-SERV-300] InformationDefinition SWIM-SERV-290 Information definition - minimum

 

This requirement ensures that the precise meaning of the exchanged information is shared by all parties of the information exchange.

 

A service description should include or refer to information about the exchanged Information service payload including:

the cardinality applicable to the element, including whether the element is optional, conditional or mandatory in the exchange;

constraints applicable to the element, such as:
value ranges;
special values;
character set restrictions; and

the structure and relevant relationships between the elements.

 Mandatory Mandatory Mandatory
SWIM-SERV-300 Information definition - extended
ServiceInformationDescription filtering The filtering capabilities, including meaning and syntax of filter expressions, which can be applied to the information exchange. [SWIM-SERV-310] Filtering SWIM-SERV-310 Filter encoding Rationale: This requirement ensures that the precise meaning of the filter expressions is understood. Optional same same
ServiceInformationDescription sourceOfInformation A description of the origins of information provided by the information service along with an indication whether there were any subsequent modifications. [SWIM-SERV-190] string SWIM-SERV-190 Source of information This provides service consumers with background on the source and modifications that have been applied. This will provide confidence in the quality of the information. Optional same same
InformationDefinition --- A formal representation of information concepts or data concepts. [SWIM-SERV-290] --- SWIM-SERV-290 Information definition - minimum This requirements sets out the minimum detail needed to describe each element of the information that is exchanged. For example, if the exchange involves information about "aerodromes" the "aerodrome" element type should be described. This means the element type should be given a name, a description, etc based on the bulleted list in the requirement. The result is called an information definition. Mandatory same same
InformationDefinition name The name of the element. [SWIM-SERV-290] string SWIM-SERV-290 Information definition - minimum The name of the element. Mandatory same same
InformationDefinition definition The definition of the element. [SWIM-SERV-290] string SWIM-SERV-290 Information definition - minimum The definition of the element. Mandatory same same
InformationDefinition airmCorrespondence The semantic correspondence of the element with the ATM Information Reference Model. [SWIM-SERV-290] string SWIM-SERV-290 Information definition - minimum The semantic correspondence of the element with the ATM Information Reference Model. Mandatory same same
InformationDefinition

datatype

 The data type used by the element whether the information definition used by the service conforms to the ATM Information Reference Model. [SWIM-SERV-290] string SWIM-SERV-290 Information definition - minimum The data type used by the element whether the information definition used by the service conforms to the ATM Information Reference Model. Optional same same
InformationDefinition cardinality The cardinality applicable to the element, including whether the element is optional, conditional or mandatory in the exchange. [SWIM-SERV-300] string SWIM-SERV-290 Information definition - minimum The cardinality applicable to the element, including whether the element is optional, conditional or mandatory in the exchange. Optional same same
InformationDefinition constraints Constraints applicable to the element, e.g., value ranges, special values, character set restrictions... [SWIM-SERV-300] string SWIM-SERV-290 Information definition - minimum Constraints applicable to the element, e.g., value ranges, special values, character set restrictions... Optional same same
InformationDefinition path An expression representing the structural relation of the element within the payload. [SWIM-SERV-300] string SWIM-SERV-290 Information definition - minimum An expression representing the structural relation of the element within the payload. Optional same same
Filtering --- The filtering capabilities, including meaning and syntax of filter expressions, which can be applied to the information exchange. [SWIM-SERV-310] --- SWIM-SERV-310 Filter encoding If information service payload filtering is available, a service description shall include or refer to information about the filter encoding. Optional same same
Filtering capability A filtering capability, including meaning and syntax of filter expressions, which can be applied to the information exchange [SWIM-SERV-310] FilteringCapability SWIM-SERV-310 Filter encoding A filtering capability, including meaning and syntax of filter expressions, which can be applied to the information exchange Mandatory same same
FilteringCapability --- A filtering capability, including meaning and syntax of filter expressions, which can be applied to the information exchange [SWIM-SERV-310] --- SWIM-SERV-310 Filter encoding A filtering capability, including meaning and syntax of filter expressions, which can be applied to the information exchange Mandatory same same
FilteringCapability name The name of the filtering capability. [SWIM-SERV-310] string SWIM-SERV-310 Filter encoding The name of the filtering capability. Mandatory same same
FilteringCapability description The description of the filtering capability. [SWIM-SERV-310] string SWIM-SERV-310 Filter encoding The description of the filtering capability. Optional same same
FilteringCapability reference   Reference SWIM-SERV-310 Filter encoding   Optional same same
ServiceTechnicalDescription --- Description of the technical aspects of the service including data structures, interface and operations behaviour, security mechanisms and technical constraints --- multiple

Knowing and satisfying the pre-requisite constraints of a service facilitate good use of the service, such as benefiting from the indicated quality of service statements.

This requirement supports decision making in terms of assessing the implication, costs and feasibility, of using the service.

 Mandatory same same
ServiceTechnicalDescription technicalConstraint A characteristic of the environment or larger system within which the service operates. [SWIM-SERV-170] TechnicalConstraint SWIM-SERV-170 Additional technical information for the service consumer Technical constraints are a characteristic of the environment or larger system within which the service operates. There could, for example, be a constraint on the size of message that a service consumer is expected to receive. Some data set files can be quite large. Optional Optional Mandatory
ServiceTechnicalDescription behaviour The manner in which a service operates under normal and unexpected conditions. [SWIM-SERV-220] ServiceBehaviour SWIM-SERV-220 Service behaviour This requirement facilitates the understanding of the service behaviour to support operational processes.  Mandatory Mandatory Mandatory
ServiceTechnicalDescription serviceMonitoring A service monitoring mechanism available to service consumers. [SWIM-SERV-230] ServiceMonitoring SWIM-SERV-230 Service monitoring Allow the service consumer to use the available mechanism and monitor the service. Optional Optional Mandatory
ServiceMonitoring --- Tracking state and operational conditions related to the execution, performance, and real-world effects of services. [SWIM-SERV-230] --- SWIM-SERV-230 Service monitoring

The mechanisms allow the monitoring of the services provided based on e.g.

status
uptime
response times
 

A heartbeat service can be used to periodically check the status of the service and determine whether it is available.

Service monitoring is explained in the EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile. See SWIM-TIYP-0105 that explains that monitoring ensures a service's "state is known and maintained up to date and that any eventual threshold violations on their use can be identified to be handled in an appropriate manner".

 Optional Optional Mandatory
ServiceMonitoring monitoringDescription Description if available of the existing monitoring capabilities and how this can be used by the consumer. [SWIM-SERV-230]. string SWIM-SERV-230 Service monitoring Description if available of the existing monitoring capabilities and how this can be used by the consumer. Optional Optional Mandatory
ServiceMonitoring reference   Reference SWIM-SERV-230 Service monitoring   Optional Optional Optional
TechnicalConstraint --- A characteristic of the environment or larger system within which the service operates. [SWIM-SERV-170] --- SWIM-SERV-170 Additional technical information for the service consumer Technical constraints are a characteristic of the environment or larger system within which the service operates. There could, for example, be a constraint on the size of message that a service consumer is expected to receive. Some data set files can be quite large. Optional Optional Mandatory
TechnicalConstraint name The name of the technical constraint. [SWIM-SERV-170] string SWIM-SERV-170 Additional technical information for the service consumer The name of the technical constraint. Mandatory Mandatory Mandatory
TechnicalConstraint description The name of the technical constraint. [SWIM-SERV-170] string SWIM-SERV-170 Additional technical information for the service consumer The name of the technical constraint. Optional Optional Mandatory
TechnicalConstraint reference   Reference SWIM-SERV-170 Additional technical information for the service consumer   Optional Optional Optional
ServiceBehaviour --- The manner in which a service operates under normal and unexpected conditions. [SWIM-SERV-220] --- SWIM-SERV-220 Service behaviour This requirement covers the typical behaviour of the service. This tends to be easy to document under normal conditions as the service is working as hoped. Mandatory Mandatory Mandatory
ServiceBehaviour name The name of the service behaviour. [SWIM-SERV-220] string SWIM-SERV-220 Service behaviour The name of the service behaviour. Mandatory Mandatory Mandatory
ServiceBehaviour description The description of the service behaviour. [SWIM-SERV-220] string SWIM-SERV-220 Service behaviour The description of the service behaviour. Optional Optional Mandatory
ServiceBehaviour reference   Reference SWIM-SERV-220 Service behaviour   Optional Optional Optional
Interface --- The means by which the underlying capabilities of a service are accessed. multiple SWIM-SERV-240 Service interfaces Rationale: This information facilitates the unambiguous identification of the interface, the understanding of its purpose, and the location to access it. Mandatory same same
Interface name The name of the interface. string SWIM-SERV-240 Service interfaces The name of the interface. Mandatory same same
Interface description The description of the entity. string SWIM-SERV-240 Service interfaces The description of the entity. Mandatory same same
Interface provisionSide Identification of the side that provides the interface; either provider or consumer. [SWIM-SERV-240] CodeInterfaceSideType SWIM-SERV-240 Service interfaces Guidance: select the appropriate value. Optional same same
Interface messageExchangePattern The type of primitive MEP implemented by the interface. CodePrimitive MessageExchangePatternType SWIM-SERV-240 Service interfaces Rationale: makes explicit the MEP used by the operations within this interface. Optional same same
Guidance: select the appropriate value.
Interface serviceInterfaceBinding A reference to the Service Interface Binding as specificed in the selected SWIM TI Profile. [SWIM-SERV-250] Binding SWIM-SERV-250 SWIM TI Profile and interface bindings Rationale: To support the concept of interoperability between the service provider and service consumer, the SWIM TI Profiles only allow a certain set of technical solutions, which can be chosen by the service designer. Optional same same
Guidance: select the appropriate code value.
Note: the code value also indicates the TI profile and version.
Interface networkInterfaceBinding A reference to the Network Interface Binding as specificed in the selected SWIM TI Profile. [SWIM-SERV-250] Binding SWIM-SERV-250 SWIM TI Profile and interface bindings Guidance: select the appropriate code value. Optional same same
Interface schema A reference to a machine readable service interface definition. [SWIM-SERV-320] Reference SWIM-SERV-320 Machine-readable service interface definition   Optional same same
Interface reference

A reference to the service interface documentation. [SWIM-SERV-240]

 Reference SWIM-SERV-240 Service interfaces   Optional same same
Interface endpoints The Endpoint of the service. Endpoint SWIM-SERV-240 Service interfaces The Endpoint of the service. Optional same same
Interface operations The Operation of the service. Operation SWIM-SERV-270 Service operations The Operation of the service. Optional same same
Interface messages The Message of the service. Message SWIM-SERV-240 Service interfaces The Message of the service. Optional same same
Endpoint --- The Endpoint of the Interface. --- SWIM-SERV-240 Service interfaces The Endpoint of the Interface. Optional same same
Endpoint name The name of the endpoint. string SWIM-SERV-240 Service interfaces The name of the endpoint. Optional same same
Endpoint description The description of the endpoint. string SWIM-SERV-240 Service interfaces The description of the endpoint. Optional same same
Endpoint url The url of the endpoint. string SWIM-SERV-240 Service interfaces The url of the endpoint. Mandatory same same
Endpoint reference The reference of the endpoint. Reference SWIM-SERV-240 Service interfaces The reference of the endpoint. Optional same same
Endpoint operations The operations of the endpoint. Items of name. SWIM-SERV-240 Service interfaces The operations of the endpoint. Optional same same
Endpoint messages The messages of the endpoint. Message SWIM-SERV-240 Service interfaces The messages of the endpoint. Optional same same
Endpoint resourceType The resource Type of the entity. string SWIM-SERV-240 Service interfaces The resource Type of the entity. Optional same same
Operation --- Service operations may be grouped under service interfaces. --- SWIM-SERV-270 Service operations The consumer needs to know which service operations are available to be called for the expected result. Optional same same
Operation name The name of the operation. string SWIM-SERV-270 Service operations The name of the operation. Mandatory same same
Operation description The description of the operation. string SWIM-SERV-270 Service operations The description of the operation. Mandatory same same
Operation idempotency A value that indicates whether the operation is "idempotent" or "non-idempotent". CodeIdempotencyType SWIM-SERV-270 Service operations Guidance: Optionally, select the appropriate code value. Mandatory same same
Operation parameters When a service operation has several input parameters, it is best practice to indicate the role of each parameter. Parameter SWIM-SERV-270 Service operations When a service operation has several input parameters, it is best practice to indicate the role of each parameter. Optional same same
Operation binding_method   BindingMethod SWIM-SERV-270 Service operations   Optional same same
Operation messages A message associated with the operation. Message SWIM-SERV-270 Service operations A message associated with the operation. Optional same same
Message --- A discrete unit of communication intended by the source for consumption by a given recipient or group of recipients. --- SWIM-SERV-270 Service operations A type of message exchanged by the service operation Optional same same
Message direction A value that indicates whether the message is "input" or "output". CodeDirectionType SWIM-SERV-270 Service operations Guidance: Select the code value corresponding to the direction of the message: Mandatory Mandatory Mandatory
IN = input to the operation
OUT = output of the operation
Message name The name of the message. string SWIM-SERV-270 Service operations Guidance: Provide the name of the message. Mandatory Mandatory Mandatory
Note: this name will make the link to the information definition.
ServiceDescriptionReferences --- References to complementary documents that provide additional details about the service. --- multiple   Mandatory Optional Optional
ServiceDescriptionReferences implementedStandard A standard used for the implementation of the service [SWIM-SERV-120] ImplementedStandard SWIM-SERV-120 Service standard reference If the service adheres to a service standard, the service should be checked to, e.g., ensure that the minimum quality of service offered is consistent with the requirements specified in the standard. Mandatory Optional Mandatory
ServiceDescriptionReferences serviceDocument A document that relates to the information service. Document   A document that relates to the information service. Optional Optional Optional
ImplementedStandard --- A standard used for the implementation of the service. [SWIM-SERV-120] --- SWIM-SERV-120 Service standard reference Rationale: The reference to standards is essential information, fostering reuse. Mandatory Optional Mandatory
ImplementedStandard standardType The type of implemented standard. CodeServiceStandardType SWIM-SERV-120 Service standard reference Guidance Serv_Std: Select code SERVICE_STANDARD. Mandatory same same
Guidance SWIM_spec: Select code of the concerned SWIM spec.
ImplementedStandard conformanceStatement A statement about the degree of conformance of the service against the standard. [SWIM-SERV-120] string SWIM-SERV-120 Service standard reference Guidance Serv_Std: Indicate whether the service adheres to a service standard. Mandatory same same
Guidance SWIM_spec: Indicate whether the service conforms to the spec.
ImplementedStandard title The name by which the document is formally known. [SWIM-SERV-120] string SWIM-SERV-120 Service standard reference Rule Serv_Std: Mandatory when adherence. No use otherwise. Mandatory same same
Guidance Serv_Std: provide the name of the service standard or the title of the service standard document.  
Rule SWIM_spec: Optional (no added value)  
ImplementedStandard version The current version or revision level of the document. string SWIM-SERV-120 Service standard reference Rule Serv_Std: Mandatory when adherence. No use otherwise. Optional Optional Optional
Guidance Serv_Std: makes clear the version of the adhered service standard.  
Guidance SWIM_spec: provide version of spec (eg "1.0").  
ImplementedStandard description The description of the entity. string SWIM-SERV-120 Service standard reference Rule Serv_Std: Optional when adherence. No use otherwise. Optional Optional Optional
Guidance Serv_Std: optionally provide a description of the service standard.
Guidance SWIM_spec: leave empty.
ImplementedStandard reference The reference of the entity. Reference SWIM-SERV-120 Service standard reference   Optional Optional Optional
Document --- A piece of written, printed, or electronic matter that provides information or evidence or that serves as an official record. ---     Optional same same
Document documentType The type of document. CodeDocumentType   The type of document. Mandatory same same
Document title The name by which the document is formally known. string   The name by which the document is formally known. Mandatory same same
Document version The current version or revision level of the document. string   The current version or revision level of the document. Mandatory same same
Document description The description of the document. string   The description of the document. Optional same same
Document reference The reference of the document Reference   The reference of the document Optional same same
Version
2
Links
https://reference.swim.aero/resources/SWIMRegistrySchema_v0.0.3d-Compliant.json
Document Categories
Services
Image