= !BluePrint: !AlertHub module of SAMBRO =
[[TOC]]

== Introduction ==
Alerthub builds on [https://sahanafoundation.org/SAMBRO/ SAMBRO] and the [http://eden.sahanafoundation.org/wiki/UserGuidelines/Messaging Messaging] module. One can configure the Alerthub to receive messages through CAP, RSS/Atom, Twitter, Facebook news feeds to, then, aggregate all those alerts for various information needs. It is intend to serve as a [https://sahanafoundation.org/philippines-sambro-dissemination-workshop/ one-stop-shop for all your alerts]. The alerts will be classified for the ease of filtering and drilling down into desired sets of spatial and temporal hazard event data. Moreover, the classification and statistical inference will provide insightful information for improved [https://sahanafoundation.org/tag/cross-agency-situational-awareness/ cross-agency situational-awareness].

== Requirements ==
1. Register an alert feed as CAP, RSS/Atom, and Twitter
1. Stage the data from feeds in a database and sanitize the data for processing
1. Develop various database Views and Alerhub APIs mainly for
   1. generating exports in CSV and JSON formats
   1. automation (e.g. extracting data for running the classifier)
1. Implement standard EDEN reporting tool for generating cross-tabs and charts for SAMBRO Alerthub data.
1. Allow privileged users to subscribe notification of a filtered subset of the events (e.g. use trending hashtags)


=== Functional ===


=== Interoperability ===

=== Visualization ===

== Use-Cases ==
* The National Disaster Management Organization (NDMO) wants to host a, one-stop-shop, National Alerthub for private media groups (priviedged Subscribers) and the public (e.g. static views of most recent alerts).
* A vetted organization makes a request to the Custodian for authorizing their feed a PKI and to accept digitally signed alerts. 
* 

=== Roles and responsibilities ===

||= Actor =||= Role =||
||Administrator ||Install and manage updates, database migrations, and other routine maintenance ||
||Custodian     ||add and edit news feeds; mainly from CAP, RSS/Atom, and Twitter feeds ||
||Certified     ||a SAMBRO Alerthub authenticated feed with digitally signed content and a PKI protected API ||
||Subscriber    ||is an extremely privileged user who could subscribe to various trending events or indicator thresholds to receive SMS, Email, or other means of new alerts ||


=== Diagram ===

== Design ==

=== GUI ===

=== Process Flow ===

=== Eden model ===

=== Mandatory Modules ===

=== Alerthub specific modules ===

== Implementations ==
1. [http://eden.sahanafoundation.org/wiki/BluePrint/CAPBroker/Philippines Philippine Atmospheric Geophysical and Astronomical Service Administration (PAGASA)] - is implemented to serve as the [https://sahanafoundation.org/philippines-sambro-dissemination-workshop/ Philippines National Alerthub], a one-stop-shop for alert. 
2. [http://cap.sahana.io/ GRAB - Globally Relayed Alerts and Bulletins] has been collecting data, on a prototype basis.

== References ==
1. [https://s3-eu-west-1.amazonaws.com/alert-hub/index.html WMO Filtered Alerthub]
2. [https://github.com/waidyanatha/IAN/wiki github code of IAN prototype] 

== Notes ==

== Current status ==
- [https://github.com/sahana/SAMBRO/releases Alerthub releases]


=== Available features ===
1. Map view of alerts with filtering
2. Table view of alert with filtering
3. CAP RSS and Atom feed register
4. RSS and Atom (non-CAP) feed register
5. Twitter feed register
6. Facebook feed register


=== Missing features ===
1. Spatial and Temporal filter widget to focus in on a particular time and space
   a. We need to add the timeslider to set the situational awareness window for user to set the:
      i. date attributes they want to filter by Then be able to set the start and end date using the slider
      i. alerts displayed on the map should vary accordingly
      i. default slider can be set to the expire date to show active alerts
      i. code:sahana/eden@039228c demo:http://cad.aidiq.com/eden/event/incident/browse