Save Search & Subscription

---

Save Search and Subscription Functional Specifications

This is wiki page for the project -
http://eden.sahanafoundation.org/wiki/Projects/Advanced/SaveSearch
http://eden.sahanafoundation.org/wiki/Projects/Advanced/Subscription

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 Sahana system will add to the platform's capability of tackling various issues faced in emergency/disaster management.

Data Model

Saved Filters

Holds information about the search query and the parameters that are saved by the user.

Field Name	Purpose	Datatype/table	Required
timestamp	Keeps the track of time of creation and subsequent modifications.	table
user_id	The user id of the user who saved the search.	FK referenced from auth_user.id (integer)	Yes
subscribed	The subscribed status of the user to a particular saved search.	boolean	Yes
search_vars	The advanced filters selected by the user.	string (Assumption for the time being)	No

P.S. - Read filter_vars in the mockups ahead as search_vars

Subscription

Holds information about the subscription details.

Field Name	Purpose	Datatype/table	Required
timestamp	Keeps the track of last updated time.	table
user_id	The user_id of the user who selects the subscription mode	FK referenced from auth_user.id (integer)
subscribe_mode	Describes the mode(s) of subscription selected

UI Design

• Save Search Widget - The widget for saving the search will appear on the search results page, basically it will be a button which asks the user the particular search must be saved.
  
• Review of Saved Searches - A UI will be provided to view the searches that were made in the past. The user will have the option of reviewing the updated search results and delete the saved queries.
  
• Widget for Subscribing - The widget for subscription will appear on the page which contains all the saved searches, basically it will be a button which asks the user the particular saved search must be subscribed/unsubscrined.
  
• UI for Updating the User - A link to open the search page for a particular saved search will be present in the page containing saved searches.
  

Files to be modified/created

Modifications

• S3Search Module for the retrieval of filters employed by the user.
• Addition of a save search widget in the search form.
• Addition of functions for saving searches and providing subscriptions in messaging module.

Created Files

• New files need to be created in views/ for UI.

Flowcharts

Screens

Save Search Widget-

Page containing Saved Searches and widget for subscribing -
The Advanced Search options are generic.

Timeline

First trimester (25 April - 23 May) -

SMART Goal	Measure	Due Date	Status
Exploring the S3Search module and adpc code	Preparing a save search model to integrate with the S3Search module and have the basic model in place	23rd May, 2011

Second trimester (24 May - 11 July) -

SMART Goal	Measure	Due Date	Status
Implementing the save search data model	Completion of /models/ part for saving searches	5th June, 2011
Start UI and save search widget development	Elementary UI is in place	15th June, 2011
Testing	Plug the gaps and make it fully compatible with the existing code	19th June, 2011
Implementing the subscription data model	Completion of /models/ part for subscription	27th June, 2011
Start UI development for subscription/updation	Elementary UI is in place	4th July, 2011
Email sending, styling and custom frequency of notification	Feature of notifications through email is in place	11th July, 2011

Third trimester (12 July - 15 August) -

SMART Goal	Measure	Due Date	Status
Testing that Everything Works	Plug the gaps and make it fully compatible with the existing code	17th July, 2011
Documentation and Merging	Code should adhere to standard and it's merging	20th July, 2011
Contingencies and Polishing	Reserve time for contingencies	1st August, 2011