Subscription and Notification

From SDMX2 Global Registry Documentation
Jump to: navigation, search

Subscribing to Changes in the Registry Content

Introduction

There are two methods that can be used to keep an individual or an application (such as another registry) updated on the structures that are new or are changed in the Global Registry.

  1. Poll the Registry RSS feed. This is available at http://test.sdmxregistry.org/rss.xml. The format of the returned information can be determined by looking at the result of an RSS request.
  2. Use the Subscription/Notification Mechanism

This tutorial shows how to set up a Subscription (option (2).

Set up a Subscription

Log in

In order to be able to set up a subscription you must be a registered user and logged in.

Major Aspects

The major aspects of a Subscription are:

  • It can be for a single Registry construct or a group of constructs based on object type, or even all events in the Registry
  • When an event occurs to an object which is being “monitored” by a Subscription, a Notification is sent to the subscribed user
  • The Notification can be set up as an e-mail, or set up to notify a remote application (by URL), or both, and many different “end points” can be notified (e.g. many e-mail addresses)

The functionality in the Global Registry comprises two major steps:

Subscribing1.png


  1. Set up the Profile – this records the mechanism by which you wish to be notified (e-mail or (for an application) by HTTP address). The profile saves having to repeat this information in every subscription you make.
  2. Identify the Registry construct(s) for which the Subscription is required and link this to the relevant Profile – it is possible to subscribe to events related to structural metadata and to data registrations.
Set up the profile

Subscribing2.png

Select Subscriptions from the main menu.

Subscribing3.png

A profile can be added, edited, and deleted. Click on Add Profile to add a new profile.

Subscribing4.png

Enter the Id of the profile and the address to be used in any notification that is sent from the registry.

Subscribing5.png

The address is added either as an e-mail address or an HTTP address. It is possible to add multiples of each type of address and these can be removed as required.

Add a Structure Subscription

The subscription mechanism is very flexible. It is possible to subscribe to all events, to a specific event for any or all of:

  • Structure type (e.g. codelist)
  • Maintenance Agency (e.g. SDMX)
  • Id (of a specific structure – the system will prompt with a list of structures filtered by any structure type and agency entered, if any)
  • Version – if a specific structure is selected the version of the structure will be shown. If required, this can be cleared and then the subscription will be for any version of the chosen structure.

Note that many combination of these fields can be entered. For example it is possible to subscribe to:

  • All code lists for any maintenance agency regardless of version
  • All code lists that are version 1.0
  • A specific code list of any version

Subscribing6.png

Select Structure Subscriptions.

Subscribing7.png

Click on Add to add a subscription.

Subscribing8.png

Each subscription must have a unique Id for the logged on user. Choose the profile to be used (i.e. this identifies the address or addresses to which any notification should be sent) In this example the subscription is for a specific event. Click on Add Event.

Subscribing9.png

The event must be for a specific structure type. The other boxes can be filled in or left blank (“wildcarded”).

Subscribing10.png

In this example a code list maintained by SDMX is chosen.

Subscribing12.png

If the next two boxes are left blank then the subscription will be for any code list of any version maintained by SDMX. Clicking on “Lookup Registry Structures” will allow the choice of a specific code list.

Subscribing13.png

Here CL_FREQ is chosen.

Subscribing14.png

Although a specific version of the code list is selected it is possible to subscribe to any version of CL_FREQ by removing the version.

Subscribing15.png

Here, the version has been removed and the subscription is for any version.

Subscribing16.png

Add a Data Registration Subscription

Subscribing17.png

Click on Data Subscriptions

Subscribing18.png

Add the id, select a profile, and choose an event type or All (data registrations).

Subscribing19.png

Registrations are recorded for a Provision Agreement but the subscription can be for:

  • any data registration for any Provision Agreement linked to a specific Dataflow
  • any data registration for any Provision Agreement linked to any Dataflow for a specific Data Structure.

Subscribing20.png

Here a specific Dataflow is chosen.

Subscribing21.png

Clicking on Save will save the Subscription.

Subscribing22.png