Context Navigation

GHC2013SocialMediaHITProcessing

Timestamp:: 10/05/13 11:35:19 (11 years ago)
Author:: Fran Boon
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

BluePrint/SocialMedia/GHC2013SocialMediaHITProcessing

-              v27
+              v28
 a training game -- workers got "experience points" and were awarded badges. See: http://gwob.org/101010-hackathon-winners/
+== Project breakdown ==
+=== Current System ===
+For ease of getting a large dataset to play with, we will use Twitter for this example, although the same system can be used for other message channels, like Email, SMS & RSS.
+Test Server to see User Interface:
+* http://demo.eden.sahanafoundation.org/eden/msg/
+Install on your own system:
+* Install Eden
+* Install the [https://pypi.python.org/pypi/TwitterSearch/ TwitterSearch] library
+* Follow the [UserGuidelines/Messaging#TwitterSearch User Guidelines] to get a Twitter OAuth account & use this to search
+Relevant documentation:
+* DeveloperGuidelines/Messaging
+* DeveloperGuidelines/Messaging/Channels
+Note: Documentation for both end-users & devs could use improvement
+* feel free to dive in!
+=== Projects ===
+There are 2 projects that we can work on during this session:
+(A) Some simple enhancements to the current interface
+(B) Creating a 'Human Intelligence Tasking' module to allow the processing of these messages to be divided up amongst a lot of workers
+==== Simple Enhancements ====
+The current workflow for a user to search Twitter is very cumbersome!
+Some ideas for improvements (although feel free to come up with your own!)
+* There should be an option (on by default) to have the Search run after save
+* The next screen should be the Results: {{{s3db.configure(create_next = URL(f="twitter_result"))}}}
+* There should be some filters above the results:
+ * http://eden.sahanafoundation.org/wiki/S3/FilterForms
+* There should be a link to see the results on a Map
+ * this will require modifying the code to have the msg_twitter_result table use self.gis_location_id() Foreign key instead of !lat/lon fields
+ * The S3Map() method is then automatically accessible via /eden/msg/twitter_result/map
+ * This will use the same filters defined for the list view
+* There should be a Report method configured for charts based on pivot tables
+ * http://eden.sahanafoundation.org/wiki/S3/S3Report
+* We could create a 'Summary' view which allows the Table, Chart & Map to be separate tabs on a single page, sharing a common set of filters, keeping the settings when moving between the views
+ * Example: http://demo.lacrmt.sahanafoundation.org/eden/vulnerability/risk/summary
+ * This is accessible via /eden/msg/twitter_result/summary
+ * The Chart, Table, Filter, map settings are inherited
+ * The configuration of which Tabs to display can be seen in the CRMT template
+  * https://github.com/flavour/eden/blob/master/private/templates/CRMT/config.py#L235
+* We want to add tools to the Table view to Geocode, Classify, Whitelist sender, Blacklist sender
+==== HIT Module ====
+===== Project breakdown =====
 This project is intended to be easy to subdivide into tasks that can be worked on somewhat independently and in parallel,
 given the choice of a few naming conventions for new database tables and fields.
 …
 are other things besides people that have addresses and such, there is a superentity for person-like types.
 But when we know we're referring to an actual person, we refer to their record in pr_person.
-=== Set up incoming messages ===
-Read the information on how messages are received by Eden from Twitter or SMS, and get test messages into an Eden instance.
+Relevant documentation:
+ * UserGuidelines/Messaging (very much in need of clarification and concrete examples)
+ * DeveloperGuidelines/Messaging
+ * DeveloperGuidelines/Messaging/Channels
+User interface:
+http://demo.eden.sahanafoundation.org/eden/msg/
+In summary:
+* Install the [https://pypi.python.org/pypi/TwitterSearch/ TwitterSearch] library
+* Follow the [UserGuidelines/Messaging#TwitterSearch User Guidelines] to get a Twitter OAuth account & use this to search
+=== Fill in required "new module" boilerplate ===
+===== Fill in required "new module" boilerplate =====
 Look at the lesson on "making a new module" in the Eden book:[[BR]]
 http://booki.flossmanuals.net/sahana-eden/_draft/_v/1.0/building-a-new-application/
 …
 Copy it to {{{models/000_config.py}}} and add an entry for the hit module.
 === Add a database table for message processing tasks ===
+===== Add a database table for message processing tasks =====
 We want to add a table that holds the data entered by one worker for one message.
 …
 the quality of their work and refer them to more training if needed.
 === Track which messages have been processed ===
+===== Track which messages have been processed =====
 We don't want to add fields to {{{msg_message}}} just for our module. But we need a way to tell when
 …
 {{{msg}}} module's incoming message handling to pick out the desired messages and create records for them.
 === Add a controller function to generate task pages for workers ===
+===== Add a controller function to generate task pages for workers =====
 Look at:
  * Other controllers in {{{eden/controllers}}}
 …
  * Return the standard form for the new record to the user.
 === Add a view that presents a task to the worker and submits their work ===
+===== Add a view that presents a task to the worker and submits their work =====
 The worker will get an autogenerated "edit" form, produced by the controller
 and view code together. If a plain edit form is ok, then this may be a very
 …
 be left until after the controller is done.
 === Generate a list of categories from the database ===
+===== Generate a list of categories from the database =====
 We would like to encourage workers to use existing categories when there is a close enough match, but be able to add new ones
 if not. So, we want to give the worker a menu of categories to choose from, consisting of all the current categories found in the