Open Geospatial Consortium |
Submission Date: 2023-09-27 |
Approval Date: <yyyy-mm-dd> |
Internal reference number of this OGC® document: 10-182r5 |
Category: OGC® Standards Working Group Charter |
Authors: Chris Little |
OGC PubSub SWG |
Copyright notice |
Copyright © 2023 Open Geospatial Consortium |
To obtain additional rights of use, visit http://www.opengeospatial.org/legal/ |
To: OGC members & interested parties
A new OGC Standards Working Group is being formed. The OGC members listed below have proposed the OGC PubSub SWG. The SWG proposal provided in this document meets the requirements of the OGC Technical Committee (TC) Policies and Procedures.
The SWG name, statement of purpose, scope, list of deliverables, audience, and language specified in the proposal will constitute the SWG’s official charter. Technical discussions may occur no sooner than the SWG’s first meeting.
This SWG will operate under the OGC IPR Policy. The eligibility requirements for becoming a participant in the SWG at the first meeting (see details below) are that:
-
You must be an employee of an OGC member organization or an individual member of OGC;
-
The OGC member must have signed the OGC Membership agreement;
-
You must notify the SWG chair of your intent to participate to the first meeting. Members may do so by logging onto the OGC Portal and navigating to the Observer page and clicking on the link for the SWG they wish to join and;
-
You must attend meetings of the SWG. The first meeting of this SWG is at the time and date fixed below. Attendance may be by teleconference.
Of course, participants also may join the SWG at any time. The OGC and the SWG welcomes all interested parties.
Non-OGC members who wish to participate may contact us about joining the OGC. In addition, the public may access some of the resources maintained for each SWG: the SWG public description, the SWG Charter, Change Requests, and public comments, which will be linked from the SWG’s page.
Please feel free to forward this announcement to any other appropriate lists. The OGC is an open standards organization; we encourage your feedback.
The purpose of the OGC PubSub SWG is to define an OGC Implementation Standard that enables publish/subscribe functionality for resources supported by OGC API Standards in a well-defined manner.
OGC API Standards specify Web based capabilities which are typically based on polling for collection resource updates (new or changed or deleted features/records, coverages, maps, data, etc.). Depending on a collection’s temporal resolution or frequency of updates or size, an event-driven / Publish-Subscribe architecture provides a timely, efficient and low latency approach for delivery of data updates or notifications.
The SWG shall review existing material, e.g. in form of OGC Engineering Reports and Standards (both OGC and external), to produce a version 1.0 implementation standard that clearly defines how to enable publish/subscribe functionality for implementations of OGC API Standards in a common way. The standard may be specified as a single part or as a multi-part standard. If applicable, this standard may become a future part of the OGC API - Common standard.
The items that need to be addressed by the SWG include:
-
Write a core requirements class that clearly defines the requirements for enabling publish/subscribe functionality.
-
Write a requirements class to publish the definition of an event-driven API with AsyncAPI.
-
Write one or more additional requirements classes that define how to realize the core publish/subscribe functionality for a specific service binding (MQTT, AMQP, Kafka, etc.) – for the bindings the SWG decides to support in the initial version of the standard.
-
Write extension documents that define how to integrate publish/subscribe functionality with OGC API Standards.
-
Write extension documents that define baseline payloads for publish/subscribe services
-
Develop examples and – if necessary to enable core functionality – conceptual models and their JSON Schema implementation (e.g. for notification metadata).
-
Address any other technical and/or editorial issues that arise during the review period.
The Standard will include security considerations.
Only those functional requirements and comments submitted through the formal process as identified in the Policy and Procedures shall be addressed. Items suggested through emails, vocal discussions, etc. will be outside of the scope of this SWG unless the SWG decides to include them.
|
Note
|
The management of subscriptions is out of scope of Part 1, but will be considered for future extensions. |
This proposed standard is intended to be a major component of the OGC API framework. The proposed standard will take advantage of Web API patterns identified in OGC API standards (e.g., MQTT in OGC SensorThings API) and other ongoing API efforts (e.g. AsyncAPI) to better align with current and emerging IT practices.
The scope of the OGC PubSub SWG is confined to enabling basic publish/subscribe functionality for resources from existing and future OGC API Standards. Any other requirement or functionality the SWG decides to be not contributing to core publish/subscribe functionality is also out of scope.
The starting point for this implementation standard shall be the "Discussion Paper for Publish-Subscribe Workflow in OGC APIs" (OGC 23-013). This charter also recognizes the prior work done for OGC Web Services (OWS) as specified in the OGC® Publish/Subscribe Interface Standard 1.0 - Core Standard (OGC 13-131r1).
The OGC PubSub SWG shall be inactivated after the following milestones have been achieved:
-
The SWG has reviewed input provided by the OGC and perhaps other communities.
-
The SWG produced the candidate standards listed below.
-
SWG membership approves a recommendation to submit the documents to the TC for consideration as OGC Adopted Standards.
-
The candidate standards have been approved by the OGC Technical and Executive Planning Committees as OGC Adopted Standards.
There shall be at least two deliverables:
-
A document describing the core requirements regarding the support of publish-subscribe functionality in implementations of OGC API Standards.
-
A document describing how to implement these core requirements for each of the bindings the SWG decides to support. At least one such document will be produced by the SWG.
The SWG may also decide to cover both deliverables in a single document.
Any organization that has a requirement for enabling clients to subscribe to a resource that is published by an implementation of an OGC API Standard and of interest to the client and to have the API notify the client when such data is available. Also, organizations that want to enable Event Architecture as well as Event Processing functionality in their computing environment.
In general, all geospatial service providers / end users that have a need to publish/receive notifications about events of interest as soon as they are detected.
The Architecture DWG will review the proof-of-concept at https://github.com/opengeospatial/pubsub and this SWG charter. A statement of endorsement is anticipated at the September 2023 OGC Member Meeting.
The following standards and projects may be relevant to the SWG’s planned work, although none currently provide all the functionality anticipated by this committee’s deliverables:
-
OGC 06-121r3, OpenGIS® Web Services Common Standard
-
IETF, Request for Comments (RFC) 4287, The Atom Syndication Format (“Atom 1.0”), December 2005, http://www.ietf.org/rfc/rfc4287.txt
-
IETF, Request for Comments (RFC) 3920, Extensible Messaging and Presence Protocol (XMPP): Core, http://tools.ietf.org/html/rfc3920
-
XML Base, XML Base (Second Addition), W3C Recommendation 28 January 2009, http://www.w3.org/TR/xmlbase/
-
OGC 09-001, SWE Service Model Standard
-
OGC 06-028r3, Sensor Alert Service Best Practices
-
OGC 09-000, Sensor Planning Service 2.0
-
OGC 06-095, Web Notification Service Best Practices
-
OGC 08-133, Sensor Event Service Discussion Paper
-
OGC 08-132, Event Pattern Markup Language Discussion Paper
-
OGC 09-032, OWS-6 SWE Event Architecture Engineering Report
-
OGC 09-050r1, OWS-6 AIM Engineering Report
-
OGC 10-061r1, OWS-7 Dynamic Sensor Notification Engineering Report
-
OGC 10-073r1, OWS-7 CCSI-SWE Best Practices Engineering Report
-
OGC 10-060r1, OWS-7 Event Architecture Engineering Report
-
OGC 10-079r3, OWS-7 Aviation Architecture Engineering Report
-
OGC 10-069r2, OWS-7 Geosynchronization service
-
OASIS WS-Notification v1.3, http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wsn
-
W3C Member Submission 20060315, Web Services Eventing Submission (WS-Eventing), http://www.w3.org/Submission/2006/SUBM-WS-Eventing-20060315
-
OGC® Publish/Subscribe Interface Standard 1.0 - Core, (OGC 13-131r1)
-
OGC® Publish/Subscribe Interface Standard 1.0 SOAP Protocol Binding Extension, (OGC 13-133r1)
The following people support this proposal and are committed to the Charter and projected meeting schedule. These members are known as SWG Founding or Charter members. The charter members agree to the SoW and IPR terms as defined in this charter. The charter members have voting rights beginning the day the SWG is officially formed. Charter Members are shown on the public SWG page.
Name |
Organization |
|
Panagiotis (Peter) A. Vretanos |
CubeWerx Inc. |
|
Chris Little |
Met Office |
|
Steve Olson |
NOAA |
|
Tom Kralidis |
Meteorological Service of Canada |
|
Clemens Portele |
interactive instruments |