Changes between Version 35 and Version 36 of BluePrint/SaveSearch_Sub

Timestamp:

08/29/12 23:45:06 (12 years ago)

Author:

James O'Neill

Comment:

--

BluePrint/SaveSearch_Sub

@@ -15 +15 @@
  name::
   Name of the saved search as specified by the user.
- description::
-  Description of the Saved Search
  pe_id::
   The person entity to be notified when the search results change. Defaults to the pe_id record associated with the current user account.
@@ -31 +29 @@
  public::
   Is this saved search viewable to everyone? This should trigger an authorisation process. Boolean, default is `False`.
+ comments::
+  Reusable comments field for the user to write in.
 
 === Views ===
@@ -44 +44 @@
 
 {{{
-org_search_text_advanced=red+cross&org_search_type=3&org_search_sector_filter=any&org_search_sector=3&org_search_sector=2&org_search_home_country=NZ
+organisation.country__belongs=NZ&organisation.organisation_type_id__belongs=2&organisation.sector_id__anyof=1%2C2&parent.acronym%7Cparent.name%7Cacronym%7Cname__like=%2Ared%2A
 }}}
 
@@ -50 +50 @@
 
 {{{
-Search=red cross AND Type=Red Cross / Red Crescent AND Sector=DRR,Food Security AND Home Country=New Zealand
+Search=red AND Type=Red Cross / Red Crescent AND Sector=DRR,Food Security AND Home Country=New Zealand
 }}}
 
@@ -63 +63 @@
 A page to edit a saved search. The `name`, `pe_id`, `notification_format`, `notification_method` and `notification_frequency` can be changed here.
 
-=== Workflow ===
-1. User executes search
-1. Activate Save Search widget
-1. Request is sent to `/msg/search_notifications/`, with the first query string argument specifying what period this applies to, e.g., daily, monthly, etc.
-1. Records with a `modified_on` value greater than `last_executed` are returned.
+=== Process ===
+
+==== Saving a search ====
+1. User searches a resource
+1. If the search has no errors, a "Save this search" button is shown next to the submit ("Search") button in the search form.
+   * The filters, added to the current resource using add_filter(), are extracted from the resource and stored as a pickled string.
+   * This button POSTs an s3json request to a save_search REST controller.
+   * The s3json contains the prefix, resource_name, and the filters applied to the resource.
+
+==== Notifications ====
+1. Subscription notifications are sent by a cron task sending a request to `/msg/search_subscription_notifications/`
+   * The first query string argument specifies what period this applies to, e.g., daily, monthly, etc.
+1. The controller fetches the saved searches with that frequency.
+1. The resource is created, and the filters are applied.
+1. The resource, with filters, and saved search record is passed to a notification function for the specific notification_method of each saved search.
+1. Records with a `modified_on` value greater than `last_executed` are added to the message.
+1. Format the response for special media, e.g., Twitter, SMS.
+1. The message is sent via the method specified.
 1. `last_executed` field updated to when the request was made.
-1. Format the response for special media, e.g., Twitter, SMS.
 
 === Tasks ===