Changes between Version 1 and Version 2 of DeveloperGuidelines/SaveSearchAndSubscription


Ignore:
Timestamp:
08/21/11 06:13:20 (10 years ago)
Author:
Pratyush Nigam
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/SaveSearchAndSubscription

    v1 v2  
    88== Data Model ==
    99
    10 
    11 === Data Model ===
    12 
    13 
    1410==== Save Search ====
    15 
    1611Holds information about the search query and the parameters that are saved by the user. The data model can be found in models/04_pr.py.
    1712
     
    2419
    2520==== Subscription ====
    26 
    2721Holds information about the subscription details. The data model can be found in models/msg.py.
    2822
     
    3226||subscribe_mode||Describes the mode(s) of subscription selected ||||
    3327||subscription_frequency||The frequency at which the subscription are to be sent.||||
    34 ||person_id||The person_id of the user who saves the search||FK referenced from pr_person||     
     28||person_id||The person_id of the user who saves the search||FK referenced from pr_person||
     29
     30== UI Design ==
     31
     32* 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 whether the particular search must be saved.[[BR]]
     33* Review of Saved Searches - A tab named "Saved Searches" is present in pr/person for this purpose. The user will have the option of modifying, deleting, loading and subscribing/unsubscribing the saved searches.[[BR]]
     34* 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/unsubscribed.[[BR]]
     35* Load Search - A load search button to open the saved search will be present alongside the delete and subscribe/unsubscribe button so that the user is enabled to look at the current results of the saved search by opening the search page.[[BR]]
     36* Subscription Details - A tab named "Subscription Details" is present in pr/person for this purpose. The user is provided with an option to modify/create his subscription information.
     37
     38== Files modified ==
     39
     40Following are the files which were modified -
     41
     42* modules/s3/s3search.py - For the purpose of putting in the save search widget and saving the search parameter when the user wants to save/load a search. Several big and small modification were done to put these features.
     43* models/04_pr.py - Contains the Save Search Data model.
     44* models/msg.py - Contains the Subscription Data model.
     45* controllers/pr.py - Modifications were done in person() to put the Saved Searches and Subscription Details tabs. Also, to provide the functionality of loading filter.
     46* controller/msg.py - It contains functions to review the subscription details and other functions to send emails containing updates to the subscribed users.
     47* cron/crontab - To schedule the daily/weekly/monthly checks for updated results in saved search and subsequently sending of emails for them.
     48* Deployment Settings to enable or disable save search and subscription is also there in place.
     49
     50== Improvements for future ==
     51* Sending Email in XSLT format.
     52* Adding the SMS/Twitter modes of subscription.