Changes between Version 2 and Version 3 of S3/Notifications

Timestamp:

09/05/13 10:15:59 (12 years ago)

Author:

Dominic König

Comment:

--

S3/Notifications

@@ -26 +26 @@
 A custom interface can be found in private/templates/DRMP/controllers.py. This interface manages a single subscription per user with multiple resources using a common filter.
 == Notifications ==
+
+=== Data Model ===
+
+Notifications build on the S3SubscriptionModel (see above) and the web2py Scheduler (for running tasks and logging).
+
+=== Process ===
+
+[[Image(notification_process.png)]]
+
+1) A background task "check_subscriptions" (installed in zzz_1st_run.py) is run every 5 minutes to check for updates of resources which have subscriptions. The "check_subscriptions" task schedules a separate, asynchronous "notify_notify" task for each resource/subscription pair which has updates.
+2) Each "notify_notify" task generates a local HTTP POST request to the subscribed controller (request format "msg"), applying the subscription filters.
+3) This request is handled by the S3Notifications.send() method, impersonating the subscriber. The send() method extracts the new/updated records, and renders and sends the notification message(s) to the subscriber.
+4) Sending of the messages uses current.msg.send_by_pe_id(), which in turn uses the contact information of the subscriber stored in pr_contact.
+
+=== Framework ===
+
+Notifications require a scheduler worker process to run in the background.
+
+=== Configuration ===
+
+==== Per Deployment ====
+
+==== Per Resource ====
+
+==== Per Subscription ====
+== Notifications ==