Skip to content

Notifications

Introduction#

The Piveau Metrics Notifications is part of the Metadata Quality Assurance (MQA) of Piveau. It notifies a publisher via email when their catalogue score decreases.

One of its key functions is the Data Provider Setting, which enables publishers to configure their notification preferences dynamically.

Key Function: Data Provider Setting#

The Data Provider Setting function allows publishers to set their own preferences for how often notifications should be sent and under what conditions. This is managed through API endpoints.

### API Endpoint

The following API endpoints allow you to manage the activation, configuration, retrieval, and removal of data provider settings for a catalogue.

#### Activate Catalogue

Publishers must first activate the catalogue to configure these settings. Only activated catalogues can have their settings adjusted.

To enable provider setting functionality, set activeStatus to true and send a POST request to the following endpoint:

/catalogue/{catalogueName}/setting

with the following request body:

{
  "activeStatus": true
}

#### Deactivate Catalogue

To disable setting functionality, set activeStatus to false and send a POST request to the following endpoint:

/catalogue/{catalogueName}/setting

with the following request body:

{
  "activeStatus": false
}

#### Configure New Setiing

After activation, set or update the setting preferances, send a POST request to the following endpoint:

/catalogue/{catalogueName}/setting

with the following request body:

{
  "receiverEmailList": [],
  "frequency": {
    "unit": "",
    "value": 0L
  },
  "threshold": 0L,
  "activeStatus": true
}
Replace the receiverEmailList, frequency, threshold and any other fields with the appropriate values when making the request.

  • receiverEmailList: List of recipients for notifications.
  • frequency: Defines how often notifications should be sent.
  • unit: Accepts "day", "week", or "month".
  • value: The number of units from the current date for the next notification.
  • threshold: Minimum decrease in score required to trigger a notification.
  • activeStatus: Enables or disables notifications for the catalogue.

#### Retrieve Current Setting

To retrieve current setting, send a GET request to the following endpoint:

/catalogue/{catalogueName}/setting

If no settings exist, a new instance is created with default values.

#### Remove Current Setting

To remove settings for a catalogue, send a DELETE request to the following endpoint:

/catalogue/{catalogueName}/setting

Note: catalogueName should be replaced with the actual catalogue name.

How Data Provider Setting Function Works#

Below is a detailed explanation of how Data Provider Setting works, including the role of the TimerManagementVerticle and its interaction with other components.

On Startup#

When the system starts, the following steps are executed:

  • Retrieve Catalogue Settings: The system fetches the settings for all active catalogues from the database.

  • Initialize Timers: For each active catalogue, the system calculates the Next Check Date based on the configured frequency. A timer is created for each catalogue using the TimerManagementVerticle. This timer ensures that checks are performed at the specified intervals.

  • Default Values: If no settings are found for a catalogue, default values (e.g., frequency of 60 minutes) are used.

When the Timer Fires for a Catalogue#

When the timer for a specific catalogue triggers, the following workflow is executed:

  • Retrieve Metadata: The system retrieves the old metadata (previous score and metrics) from metrics cache.It also fetches the current metadata from the database.

  • Compare Scores: The system compares the current score with the previous score using the formula:

current score < previous score - threshold

  • Send Notification:

If the current score is significantly lower than the previous score (based on the configured threshold), a notification is triggered.

  • A notification email is sent to the recipients listed in the settings.

  • The new metrics data is saved to the database to update the historical record.

  • Calculate Next Check Date: The system calculates the Next Check Date based on the configured frequency.This date is stored in the database to ensure the next check occurs at the correct interval.

## Key Technologies