wiki:BluePrint/SaveSearch_Sub

Version 5 (modified by Pratyush Nigam, 10 years ago) ( diff )

--

Save Search & Subscription


Save Search and Subscription Functional Specifications


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

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 NamePurposeDatatype/tableRequired
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
subscribedThe subscribed status of the user to a particular saved search.booleanYes
filter_nameThe query entered by the user.stringYes
filter_varsThe advanced filters selected by the user.string (Assumption for the time being)No

Subscription

Holds information about the subscription details.

Field NamePurposeDatatype/tableRequired
timestamp Keeps the track of last updated time. table
search_idRefers to the saved search it is subscribed to.FK referenced from filter.id (integer)
email_subStatus of email subscription.boolean
sms_subStatus of sms subscription.boolean
twitter_subStatus of twitterl subscription.boolean

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.
  • UI for Subscription - The UI for subscribing to the saved searches can be implemented that the user would use for reviewing his saved searches.
  • UI for Updating the User - There will be a separate UI for the user to view the updation for his subscribed searches. This model can be based on something like google reader where the user will click on the subscribed saved searches and then would be able to see the updates on the UI.

Flowcharts

Attachments (4)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.