Page History

...

1. Create a configuration file in the default location /etc/aviso/config.yaml with the following settings:

   Code Block
   language yml
   username: <user_email> listeners: - event: dissemination request: destination: <user_destination> stream: enfo step: [1,2,3] triggers: - type: echo

   The first line is required for a correct authentication, the username is the email associated to the user's ECMWF account. This can be checked by logging at https://api.ecmwf.int/v1/key/.

   This file is a basic example of a dissemination event listener. request describes for which dissemination events the user wants to execute the triggers. It is made by a set of fields. Users have to specify only the fields that they wants to use as filters. destination is a mandatory field and it is associated to one or more destinations which are linked to the user's ECMWF account. Only the notifications complying with all the fields defined will execute the trigger. The trigger in this example is echo. This will simply print out the notification to the console output.

2. Save the ECMWF key as a file in /etc/aviso/key. The key can be obtained by logging at https://api.ecmwf.int/v1/key/ . 

3. Launch the aviso application

   Code Block
   language bash theme DJango
   user@local aviso listen

   Once in execution this command will create a process waiting for notifications. Users can terminate the application by typing CTRL+C

   Note that the configuration file is read only at start time, therefore every time users make changes to it needs they need to restart the listening process.

   Note that before starting to listen for new notifications, the application checks what was the last notification received and it will then return immediately all the notifications that have been missed since. It will then start listening for new ones. The first ever time the application runs however no previous notification will be returned.

...

Aviso configuration file allows the definition of multiple listeners, each listener is compose or a composed of:

• an event type

...

• a request block

...

• a triggers block.

Event

Aviso offers notifications for the following types of events:

...