wiki:BluePrint/SaveSearch_Sub

Version 32 (modified by Michael Howden, 9 years ago) ( diff )

--

Allow person entities (people, groups, organisations) to save a search and be notified when the results change.

Overview

In an event of disaster, this functionality would help a lot in terms of providing information (take the example of dissemination of information related to availability of food, shelter, hospitals etc.). The project's essential capability is to disseminate information about various aspects through various means such as email/twitter/sms. Integrating this service into a Sahana Eden system will add to the platforms' capability of tackling various issues faced in emergency/disaster management.

Models

A single model for holding information about the search query and the parameters that are saved by the user. This will be in /modules/eden/pr.py as a component of pr_entity.

name
Name of the saved search as specified by the user.
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.
query
The query string for the search.
notification_format
Format for the notification, either a list (default), map, report, graph (this is a report).
notification_method
Subscription mode, e.g., email (default), Twitter, SMS.
notification_frequency
How often the search is checked for changes, e.g., never (default), every 15 minutes (not hourly?), daily, weekly and monthly.
last_executed
The date and time the search was last executed by the subscription method. Set to match modified_on when record is first created.
public
Is this saved search viewable to everyone? This should trigger an authorisation process. Boolean, default is False.

Views

Each search page will have a widget the user can activate to save the current search. They will be directed to a new page where they can type a name for the search.

Saved Search List

Each person entity has a component for saved searches. This page will list all searches saved for this person entity, displaying the name of the search (as defined by the user when it was saved) and the query parameters.

Given the following search query string

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

The user should see

Search=red cross AND Type=Red Cross / Red Crescent AND Sector=DRR,Food Security AND Home Country=New Zealand

Any field that has no matching representation should be omitted.

The user will have three options for each search record:

  • run executes the search
  • edit allows the user to edit the saved search record
  • delete deletes the saved search record

Saved Search Edit

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
  2. Activate Save Search widget
  3. Redirected to Save Search add form
  4. Name search
  5. Request is sent to /msg/search_notifications/, with the first query string argument specifying what period this applies to, e.g., daily, monthly, etc.
  6. Records with a modified_on value greater than last_executed are returned.
  7. last_executed field updated to when the request was made.
  8. Format the response for special media, e.g., Twitter, SMS.

Tasks

Phase I

  • Implement model
  • Implement representation functions for query string
  • Implement or update controllers
    • /msg/search_notifications/ to be called via cron, first argument is the frequency.
    • Records with a modified_on value greater than last_executed are returned.

Phase II

  • Expand /msg/search_notifications/ to notify all people within a pr_group by fetching the relevant contact details from all members.
  • Add formatters/codecs to format the response for Twitter, SMS, etc.
  • Extend OAuth implementation for Twitter and Facebook to allow posting to users account.

Tests

  • Save a search without any filters.
  • Save a search after performing a search with filters.
  • Attempt to save a search with empty name; must fail.
  • Delete a saved search.
  • Edit and save a saved search.
  • Executing a search from the saved search list page.
  • Send notification email.

Attachments (4)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.