Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Insert excerpt
Task Status
Task Status
nopaneltrue


Info

The following text will form the new supporting material once agreed.

Warning
titleStatus

The proposed new supporting material is based on a draft PANS-IM so may be subject to change. 




Table of Contents

Introduction

The Information Service Overview is introduced in the ICAO Procedures for Air Navigation Services – Information Management (PANS-IM, Doc 10199).

An information service provider shall provide an information service overview for each version of each information service. The information service overview is "A set of information service metadata intended to promote information service discovery and an initial evaluation of the information service characteristics". As such, it enables information service consumers to compare between different information services.


Tip
titleGood to know
  • The Service Orientation Process lists the Information Service Overview as an outcome of the design step (the service has a "Prospective" lifecycle status). This is an announcement by the service provider of an implemented service to come.
  • It is then updated by the service provider during the implementation step and completed at deployment (the service has an "Operational" lifecycle status).

Glossary

TermDefinition
Service overviewA set of information service metadata intended to promote service discovery and an initial evaluation of the information service characteristics.
Operational (status of a service)The status indicating that the service is employed in its operational environment.
Prospective (status of a service)The status indicating that the service is being designed, developed, or tested for operational activities and is expected to be available in the future.

Requirements for information service overviews

PANS-IM states that:

  • Information service providers shall provide information service metadata through information service overviews.
  • Information service overviews shall be structured using the metadata fields in Table 5-1. This practice facilitates discoverability of information services and enables information service consumers to compare different information services.
  • Information service providers shall provide a complete description of all metadata fields in the information service overview for each version of an information service.
  • Information service providers shall inform consumers where they can access the information service overviews and the metadata on information services therein.
  • The uniform resource locator (URL) where information service overviews are publicized shall be included in the AIP. In case a SWIM registry is used (see 5.4), the URL shall be the one of the registry.

Content of an information service overview

The content of an information service overview is outlined in Table 5-1 of the PANS-IM. Each field must be completed (using "NIL" where allowable and applicable.)

The following table provides supporting material for the content. It:

  • details the required content (field) of an information service overview.
  • includes the requirements for the field based on the PANS-IM and the field schema.
  • provides an example of the expected content based on Donlon.
  • provides a mapping the relationship to the relevant requirement in the SWIM Service Description Specification. This shows how the content of a service description can be used to create a service overview.
Mapping to Service Description v2.0 requirements: the ability to identify the service is in rationale but this is not
  • name
  • )1.00:
  • version
  • the notes the distinguishing aspect of the version .

    SWIM-SERV-110

    Information Service Overview Field NameInformation Service Overview RequirementsRelationship of the requirement to EUROCONTROL Specification for SWIM Service Description Edition 2.0Field schemaExample Content - Based on Donlon
    Information service name

    Information service providers shall name the information service.

    Free textDonlon TargetOffBlockTimeSetting Service
    The name of the information service should enable information service consumers to reference or identify the information service.

    The name should provide an indication of the purpose of the information service.

    Free textDonlon TargetOffBlockTimeSetting Service
    • .

    • Info
      It is not possible to turn this into a verifiable requirement.


    The name should provide an indication of the purpose of the information service.
    Info

    The service description describes the service. It does not impose requirement on the design. Therefore, the "indication of the purpose" is a best practice rather than a rule.


    Information service version

    Information service providers shall provide versioning to the information services.The service version shall be provided in numerical format (

    n.n[.n]

    1.0.0

    The service version of the information service shall allow information service consumers to distinguish between versions of an information service. shall be provided in numerical format (n.n[.n]).
    •  
    • give a best practice on using a numerical format
    Info

    The service description describes the service. It does not impose requirement on the design. Therefore, the "numerical format" is a best practice rather than a rule.


    The version of the information service shall allow information service consumers to distinguish between versions of an information service.
    • the distinguishing aspect of the version is covered in the rationale
    Info
    It is not possible to turn this into a verifiable requirement.


    Information service life cycle status

    Information service providers shall specify the stage that the information service version is currently in as one of three stages: prospective, operational or retired.

    Note.⸻ For more information on service stages see Doc 10203.

    Prospective or Operational or RetiredOPERATIONAL

    SWIM-SERV-110 Service lifecycle information

    • lifecycle stage


    Info
    the The three phases mentioned in PANS-IM are in the notes .
    See also the service category
    to SWIM-SERV-110 Service lifecycle information.

    The values are available at: https://reference.swim.aero/information-services/service-categories/CodeLifeCycleStageType.html

    Prospective or Operational or RetiredOPERATIONAL
    Information service life cycle date


    Information service providers should include the dates for current and future lifecycle stages.

    YYYY-MM-DD
    or NIL


    2018-07-31


    The planned date of retirement should be listed whenever it is known to exist.
    If an information service provider does not make the date available, the information service life cycle date metadata field shall specify “NIL”.Note


    Info

    The use of NIL is not outlined in the specification.


    Note.⸻ In the case of a prospective stage, the date indicates the date by which the information service provider plans to make the information service operational.YYYY-MM-DD
    or NIL
    2018-07-31
    Info

    The use of NIL is not outlined in the specification.

    Information service functions

    Information service providers should provide a description of the business level characteristics of the information service functions. This will provide information service consumers a business view of the interactions with the information service, without having to look at the interface details.

    The description should include the functionality of the service as a list of the functions and real world effects.

    If an information service provider does not make the information service functions available, the information service functions metadata field shall specify “NIL”.

    covered by rationale to SWIM-SERV-140 Service functions


    Free text or NIL
    • Allow the service consumer to set (i.e. define or update) the target off-block time (TOBT) value for a specific flight.
      • real-world effect: TOBT value is defined or updated
    • Allow the service consumer to delete the target off-block time (TOBT) value for a specific flight.
      • real-world effect: The TOBT value is marked as undefined
    The description should include the functionality of the service as a list of the functions and real world effects.

    SWIM-SERV-140 Service functions

    Business function: Service for the information service consumer to set (i.e. define or update) or delete the target off-block time (TOBT) value for a specific flight.
    Real world effect: The TOBT values are updated for each flight as the information service consumer performs:

    Set TOBT – TOBT value is defined or updated

    Delete TOBT – TOBT is marked as undefined

    SWIM-SERV-140

    • function
    • real-world effectfunction
    • real-world effect


    If an information service provider does not make the information service functions available, the information service functions metadata field shall specify “NIL”.


    Info

    The use of NIL is not outlined in the specification.


    Information categoryThe information domain(s) covered by the information service shall be listed as one or more of the following:
    a) flight information;
    b) aeronautical information;
    c) meteorological information;
    d) environment information;
    e) capacity, demand and flow information;
    f) surveillance information; and/or
    g) other information.

    SWIM-SERV-100

    Flight information; and/or Aeronautical information and/or Meteorological information and/or Environment information and/or Capacity, demand and flow information and/or Surveillance information and/or Other informationFLIGHT INFORMATIONSWIM-SERV-100INFORMATIONBrief description of the information service

    Information service providers shall provide a brief description of the information service to assist information service consumers on whether the described service is suitable for use in a particular situation.

    The brief description shall 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, 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.

    SWIM-SERV-050

    • abstract
    • note covers the items that are best practice to include. 
    Info

    The content can be mapped to other parts such as

    • operational needs and
    • service categories.


    Free text (intended use)

    The TargetOffBlockTimeSetting service supports flight information exchange by allowing aircraft operators and ground handlers to set the Target Off-Block Time (TOBT) for their flight departures at Donlon Airport.

    The service may be used by the Donlon Tower Controllers in specific circumstances, such as under adverse conditions or other special circumstances.

    The service is part of a set of services supporting the Airport Collaborative Decision Making (A-CDM) concept and its implementation by providing the A-CDM partners with common situation awareness about flights at a CDM airport.


    --


    The TargetOffBlockTimeSetting service supports the Airport Collaborative Decision Making (A-CDM) concept and its implementation by allowing A-CDM Partners, typically aircraft operators and ground handlers, with the capability to set TOBT that indicates the target time for the aircraft to be ready for off-block.

    SWIM-SERV-050

    • abstract
    • note covers the items that are best practice to include. 
    Info

    The content can be mapped to other parts such as

  • operational needs and
  • service categories

    for the aircraft to be ready for off-block.

    Additional information on the information service

    Information service providers should provide a description of the location at which more information, potentially including more detailed technical information on an information service, may be found.

    The location should be provided as a link to where an information service consumer can find more information.

    If an information service provider does not make additional information available on the information service overview, the additional information on the information service metadata field shall specify “NIL”.

    SWIM-SERV-170

    Info

    The use of NIL is not outlined in the specification.


    Free text or NILAdditional information on the information service can be found at the European SWIM Registry https://eur-registry.swim.aero/services/ or from the Donlon Airport Operator.

    SWIM-SERV-170

    InfoThe use of NIL is not outlined in the specification/services/ or from the Donlon Airport Operator.Quality of the service

    Information service providers shall provide a description on the qualitative and quantitative information pertaining to the characteristics of an information service to allow information service consumers to understand the quality of the information service.

    The description should specify parameters based on ISO 25010.

    The quality of the information service should be expressed using the following parameters (or other applicable parameters):
    a) performance parameters (quantitative);
    i) capacity of a service;
    ii) time behaviour of a service;
    b) reliability parameters (quantitative);
    i) availability of a service;
    ii) recoverability of a service;
    c) security parameters (qualitative);
    i) confidentiality of a service; and/or

    ii) integrity of a service.


    Note.Note.⸻ Examples of applicable parameters related to performance, reliability and security are provided in Doc 10203⸻ Examples of applicable parameters related to performance, reliability and security are provided in Doc 10203.

    SWIM-SERV-180

    • the requirement covers the top level parameter
    • the notes cover the sub-parameters e.g. capacity...


    Info
    ISO 25010 is mentioned in the notes.


    Capacity: free text (description of capacity) and/or Time behaviour: free text (description of time behaviour) and/or Availability: free text (description of availability) and/or Recoverability: free text (description of recoverability) and/or Confidentiality: free text (description of confidentiality) and/or Integrity: free text (description of integrity)
    • Availability: 99.95 % outside the planned outages
    • Capacity: 2000 service requests per hour
    • Time behaviour: 2s delay for 95% of messages

    --

    AVAILABILITY: 99.95 % outside the planned outages
    CAPACITY: 2 000 service requests per hour
    TIME BEHAVIOUR: 2 s delay for 95 % of messages

    SWIM-SERV-180

    • the requirement covers the top level parameter
    • the notes cover the sub-parameters e.g. capacity...
    InfoISO 25010 is mentioned in the notes.

    of messages

    Information service validation type

    Information service providers shall ensure that the information service is validated.

    This validation shall include the parameters provided in the quality of service metadata field of the information service overview to assist information service consumers with the initial evaluation of the information service.

    Information services shall be validated by at least one of the following validation methods:
    a) independent validation;
    b) collaborative validation;
    c) user validation; or
    d) self-validation.


    The validation method(s) used and its corresponding result shall be recorded.

    Information services may evolve which triggers the need for revalidation. Each new version of an information service should be revalidated.


    Note.⸻ For more information on the validation methods see Doc 10203.

    Independent validation and/or Collaborative validation and/or User validation and/or Self-validationSELF-VALIDATION

    SWIM-SERV-200

    Info

    Obviously the spec does not mandate that services shall be validated as this is a governance/process aspect. Instead the specification requests a description of what was done.

    • quality of service is covered by the requirement
    Info
    The spec does not specify what methods to use as this is process related. The methods are given as a best practice in the notes.


    Info

    the evolution aspect is not covered by the specification.


    Independent validation and/or Collaborative validation and/or User validation and/or Self-validationSELF-VALIDATIONInformation service validation description

    Information service providers shall provide a description of the validation method applied to assist information service consumers in assessing the confidence level of the information service.

    By sharing the validation results, information service providers reassure information service consumers that the information service and its provider have the ability to deliver the declared capabilities and quality of service.

    The description should include a brief statement on the validation results, and it should describe how the information service consumers may obtain the validation evidence.obtain the validation evidence.

    SWIM-SERV-200

    • validation method
    • validation results
    • obtaining evidence


    Info

    The reassurance is covered in the rationale


    Free text (validation result)

    Donlon Airport tested the service in accordance with its quality management system (QMS) based requirements.

    The validation was successful.

    To obtain the validation evidence, contact the Service desk [24/7]: +693 555 01 service-desk@donlon-airport.com 

    SWIM-SERV-200

    • validation method
    • validation results
    • obtaining evidence
    Info

    The reassurance is covered in the rationale

    Filtering available

    Information service providers should provide information on the availability of filtering to allow information service consumers to narrow the content of information that they consume.

    The capability of filtering information should describe the filters information service providers offer for an information service.

    If an information service provider does not offer filtering or does not make information on filtering available on the service overview, the filtering available metadata field shall specify “NIL”.

    SWIM-SERV-310

    • filter encoding
    Info

    The use of NIL is not outlined in the specification.


    Free text or NIL

    The service consumer can filter information feed based on time.

    Note: the information provided by the service is limited to DONLON (see Geographical extent of information) so there is no need for a geospatial filter in this case.

    SWIM-SERV-310

    • filter encoding
    Info

    The use of NIL is not outlined in the specification.

    Access restrictions

    Information service providers shall provide a description of any constraints on access to the information service to assist information service consumers in understanding whether they may be eligible to access the information service.

    These constraints should specify the requirements and/or restrictions on information service consumers for accessing the information exchanged by the information service that are considered to be sensitive.

    SWIM-SERV-150 and SWIM-SERV-160

    Free text

    The access to the service is subject to authorization. Authorization is dependent on formal arrangements (Service Level Agreement) with the Donlon Airport Operator.

    The access to the service is subject to authentication based on the user id and password for authorized users.

    SWIM-SERV-150 and SWIM-SERV-160


    Message exchange patterns

    Information service providers shall indicate the message exchange pattern used by the information service to assist information service consumers in understanding the relationships of multiple messages exchanged with the information service providers.

    The message exchange pattern shall be expressed as one or more of the following:
    a) request/reply;
    b) one way; and/or
    c) publish/subscribe.

    Request/Reply and/or One way and/or Publish/Subscriberequest/reply

    SWIM-SERV-210

    Info
    The types are covered in the notes to the requirement. This is a design requirement and not covered in the service description spec,



    Request/Reply and/or One way and/or Publish/Subscriberequest/replyInformation exchange models

    If information service providers use for their information service payloads the domain specific information exchange models, then information service providers shall indicate the domain-specific information exchange models used for their information service payloads, including the extensions of the information exchange models and their versions.

    If information service providers do not use the domain-specific information exchange models for their information service payloads, then information service providers shall describe the alignment to a global reference model and indicate the exchange schema used.

    Note.⸻ See the AIRM for an example of a global reference model (https://airm.aero/).

    SWIM-SERV-290Free textThe service is using an information exchange model that is specific to the service and aligned with the AIRM version 1.0.0.SWIM-SERV-290Geographical extent of information

    Information service providers shall provide a description of the geographical coverage of the information exchanged to allow information service consumers to understand the geographical coverage of the information being provided.

    Note.⸻ The geographical coverage may be expressed in terms such as ICAO Region, flight information region (FIR), aerodrome or polygon. More granular information such as coverage at airport “x” or FIR “y” may be provided as it may facilitate search responses.

    SWIM-SERV-090


    Free textDonlon airport (EADD).SWIM-SERV-090Source of information

    Information service providers should specify the sources of information exchanged.

    Information service providers should also provide information on any subsequent modifications applied in order to provide information service consumers with background on information sources and modifications.

    If an information service provider does not make the source of information available, the source of information metadata field shall specify “NIL”.

    Free text or NILThe service consumer

    .

    SWIM-SERV-190

    Info

    The use of NIL is not outlined in the specificationnot outlined in the specification.


    Free text or NILThe service consumer.

    Information security category

    Information service providers shall indicate the information security category to provide information service consumers with an understanding of the level of protection of the information.

    The information security category shall be expressed as one of the following:
    a) none;
    b) basic;
    c) intermediate; or
    d) advanced.


    Note.⸻ More information is provided in the Manual on Information Security (Doc 10204).

    None or Basic or Intermediate or Advanced

    Intermediate

    Draft PANS -

    6.1.3    Organizations shall implement an information security framework to ensure the confidentiality (when needed), integrity and availability of the information and information services.

    6.3.5.1 Assessing the impact of information security on safety risk management requires the classification of the information to be exchanged in information security categories. Based on the applicable information security category, information service providers and consumers shall apply the performance-based information security requirements in Appendix A to information systems handling the information.

    6.3.5.2 Information service providers shall state the information security category in the Quality of the service metadata field of the information service overview to provide information service consumers with an understanding of the level of protection of the information.

    Appendix B 1.3.

    Organizations shall categorize information and information systems under their responsibility based on the information security impact on safety risk analysis. Organizations shall also review categories on a periodic basis based on the risk analysis.

    Basic - Information and information systems shall be categorized based on the information security impact on safety risk analysis. Information security categories shall be reviewed every (2) years based on the latest risk analysis.

    Intermediate - Information and information systems shall be categorized based on the information security impact on safety risk analysis. Information security categories shall be reviewed annually based on the latest risk analysis.

    Advanced - Information and information systems shall be categorized based on the information security impact on safety risk analysis. Information security categories shall be reviewed monthly based on the latest risk analysis.

    None or Basic or Intermediate or Advanced

    Intermediate

    Provider organization

    Information service providers shall provide the name of their organization to assist information service consumers in identifying and gaining context on the information service.

    The name of the organization shall be followed by any abbreviated name, if any, by which the organization is known.


    Note.⸻ The provider organization may or may not be the organization originating the information.

    SWIM-SERV-060Free textDonlon Airport OperatorSWIM-SERV-060Support availability

    Information service providers should provide a description of the support offered to information service consumers on all relevant aspects related to the information service, to allow information service consumers to understand the level of support to expect.

    If an information service provider does not make support availability information available, the support availability metadata field shall specify “NO SUPPORT AVAILABLE”.

    SWIM-SERV-080Free text or NO SUPPORT AVAILABLEFor incidents on services in operation, contact the Service desk [24/7]: +693 555 01 service-desk@donlon-airport.com SWIM-SERV-080Provider point of contact

    Information service consumers should have a point of contact to request, if needed, additional information regarding an information service.

    Information service providers shall provide a point of contact such as an email or website where a potential information service consumer can direct additional questions regarding the information service.

    SWIM-SERV-070


    Free text

    To request access to the service: http://www.donlon-airport.com/swim/service-request 

    SWIM-SERV-070


    Creating an information service overview

    An information service overview can be created:

    • using a template based on the table above
    • using the Service Metadata Schema
      • as the service overview should not rely on a schema, the service metadata schema is only informative.
    • from the content an existing service description.