Changes between Version 19 and Version 20 of BluePrint/Messaging/Parsing


Ignore:
Timestamp:
06/28/12 19:06:33 (9 years ago)
Author:
Ashwyn
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/Messaging/Parsing

    v19 v20  
    4646''tbc''
    4747
    48 === Data Model ===
     48 
     49== Project Plan ==
     50 
     51Project Deliverable:
     52 
     53The project aims at parsing inbound messages such as SMS from CERT responders after deployment.
     54It enables the processing of responses to deployment notifications; which is essentially controlled by the module to which the message is routed.
     55
     56Project Justification:
     57 
     58Parsing of inbound messages is a critical utility for a trained volunteer group such as CERT(Community Emergency Response Teams) where communication between various deployments and volunteers play a vital role. As this will be a deployment-specific option, the functionality becomes an important component for Sahana Eden.
     59
     60Implementation Plan:
     61
     62* Keeping the development of Profile Layer in mind and the functionality being a part of deployment-specific options, the rules for parsing are contained in private/templates/default/parser.py.
     63
     64* The module contains a class S3ParsingModel which contains the “msg_workflow” data model (See https://docs.google.com/document/d/1Y9dDCshurrZSw33r-RC_uVQ_Va6_LEZM-2aLcaT2Krc/edit?pli=1) and another class S3Parsing in which the parsing routines are defined which decide the various parsing workflows.
     65
     66The current parsing rules implement the functionality in the following manner:
     671. The inbound message text is passed as an argument to the parse_message() method in the s3msg.py module.
     682. The text is matched with a predefined list of primary and contact keywords after splitting with whitespace as the delimiter.
     693. A database query is generated to the concerned database according to the matched keywords.
     704. The query retrieves the relevant field values and generates a reply to the inbound message query.
     715. Also these parsing rules have been implemented only for modules –  ‘Person’ , ‘Hospital’  and ‘Organisation’.
     72Extending these rules to other modules can be in scope of the project.
     73 
     74*One of the main issues will be  identifying the messages that belong to a particular  source, so it could have its own processing.Now, that here is handled by the data model which defines a ‘msg_workflow' table in the database which links the Source to the Workflow with any required args.So the essential features of this approach have been listed below:
     751. The Parser workflow table links 'Source X' to 'Workflow Y'.
     762. Now, designing the details of the Workflow Y would be a developer task.
     773. Whereas linking ‘Source X’ to ‘Workflow Y’ will be a configurable option.
     784. So essentially,the Parser Table links Source to Workflow with any other required args & this acts like a Template for the schduler_task table.
     79
     80* Now, a task process_log() is defined in tasks.py , where the objective of process_log() is to scan through all the messages in msg_log; and process those for parsing which are flagged as unparsed (is_parsed=False).The task is scheduled in zzz_1st_run.py where it is chained to the concerned parsing task(this is achieved by the msg_workflow table, the ‘source_task_id’ field in msg_log will help retrieve the respective parsing workflow_task_id from msg_workflow).
     81* Also,this allows for chaining of workflows where a source for a workflow could be another workflow instead of an Incoming source.We can have 2nd-pass Parser workflows which don't start from the Source direct but can plugged as output from a 1st-pass one.
     82            Source -> process_log() ->1st pass parser -> detailed Parser ---> Module
     83* Here,the 1st pass parser is customized per-deployment;and decides which email source goes to a particular workflow (simple msg_workslow link) or decides based on other factors such as keywords to which main workflow the messages should be passed.
     84* The data model is  integrated with the templates folders (or a sub-folder say private/templates/parsing) which serves as the initial UI.The post-install UI will consist of a CRUD interface admin panel, a simple s3_rest_controller().However, eventually this is planned to be the part of the WebSetup.
     85* We want to be able to direct the message to the appropriate module to handle the data.This could be done either by launching a real REST request or else simulating one via the API.
     86{{{
     87resource = s3mgr.define_resource("module", "resourcename")
     88}}}
     89* Messages which are routed to a specific resource can be subscribed to by the user.For this purpose,we can use the existing Save Search and Subscription functionality where the user can subscribe to new messages for a specific resource using a resource filter.The msg_log can be made a component for the resources.Now,if it's a component, then when someone opens the resource, messages will be there in a tab.Also, if the message has to be tied to multiple resources, then we can use a relationship (link) table.
     90* Implementing/extending  the utility for other modules especially the IRS module will be of real use, where enabling to log reports through SMS will be vital, which can also use the OpenGeoSMS encoding standards(LatLon generates a google-maps URL) for integration with our Android Client. A dedicated routine to generate OpenGeoSMS URLs already exists in prepare_opengeosms() in s3msg.py itself. So integration with the parsing routine won’t be difficult. Other modules for which this can be implemented are : ‘Request’  and ’Inventory’.
     91* Finally the code will be tested on the system and the bugs (if any ;-) ) will be fixed.
     92
     93Future Options:
     94* Though the parsing rules will be generic , a few minor tweaks for other processes such as Email and Twitter will have to be performed to maintain its generic nature.
     95* One of the most valuable functionality that can be added here is to make the SMS communication more interactive. e.g. the text body received does not match any of the expected  keywords , the API dispatches a reply stating the expected format of the message.
     96* Adapting the parsing rules to cover as wide a base of inbound messages as possible. This will involve making a wider collection of keywords to be searched for every concerned module.Linking different labels  across the DB to module-specific keywords will be really helpful.Also the list of primary keywords to be matched can also be made a deployment-specific option.
     97 
     98== Data Model ==
    4999
    50100Data Model Blueprint: msg_workflow