Changes between Version 1 and Version 2 of UserGuidelines/Alerts

08/20/12 17:27:20 (12 years ago)



  • UserGuidelines/Alerts

    v1 v2  
    55== Purpose ==
    6 The Alerting module enables Eden instances to create, aggregate and propagate comprehensive and annotated alert messages. The module also acts as a broker to the Common Alerting Protocol adapted by Governments and NGOs for alerting.
     6The Alerting module enables Eden instances to create, aggregate and propagate comprehensive and annotated alert messages. The module also acts as a broker to the Common Alerting Protocol adapted by Governments and NGOs for exchanging alert messages.
    8 == Data-structures ==
    9 * *Alerts* --
    10 * *Alert templates* --
    11 * *Profiles* --
     8== Data ==
     9Note: the alert data model and its children are more or less identical to those in the [ CAP 1.2 Specification]. The help text next to each field in the UI describes the purpose of these as in the specification document.
     10* '''Alerts''' -- The qualifiers of the alert message. Includes alert identifier, sender, message type, scope (audience), references to other cap alerts and other fields.
     11  * '''Alert information''' -- An alert can contain more than one information element, the primary purpose of this is to annotate the alert message in multiple languages. An information part of the alert contains fields that are pertinent to the actual subject and characters of the alert. Fields include: language, category of the alert, a short description of the event, expected response type, priority, urgency, severity, certainty, target audience, auxiliary codes and parameters as metadata to the event, time of effectiveness, onset and expiry, name of the sender, headline of the event, a url, contact information etc.
     12    * '''Resource''' -- One or more files attached to the information (could be things like a map of the affected area, documents containing instructions etc.)
     13    * '''Area''' -- Each alert information item may contain one or more area fields which describe the affected geographical area and optionally provide data to place it on a map.
     14* '''Alert templates''' -- these are a subset of alert and alert information fields which can be filled in before hand and kept ready for use during a time of emergency. This will be part of the pre-planning process for the particular Eden instance. A default empty template is provided on a fresh installation. As a first step of the alert creation procedure you will need to select a template to apply to the alert message.
     15* '''CAP Profile''' -- These are site-wide configuration settings that can be used for configuring the cap module for a specific region's (usually a country) requirements for disaster preparedness. For an example look at [ Canadian CAP Profile].
    1317== Workflow ==
    14 Any complex, non-CRUD workflows. Possibly include a flow chart / diagram. Ensure that you attached the raw file (ideally in an open format - ) as well as the image.
     18The workflow for creation of a CAP alert is as below.
    16 == Reports ==
    17 Any non-CRUD reports
    19 == Screen Shots ==
    20 A selection of screenshots (~5) and a description of what they could be used for.
     20* As the first step of the process, you will need to select a template.
     21* A form is displayed to you after the template has been applied on it. You can edit the information regarding the alert message now.
     22* After you save the alert message by clicking on "Save and add information", you will be redirected to another form where you can add the Alert information in a certain language.
     23* After saving the alert information you can click on the "Open" button against the information row to edit it further or to add its components such as Area or Resource.
    2225== Video Tour ==
    23 <5 Min overview.
    24 This should start with a screen stating:
    25 "Sahana Eden - <Application Name> Application"
    27 Advice for creating a screen captured video:
    29   * Be very careful to not take screen captures of your browser with multiple tabs open; only a single window with the Eden application (full screen mode is best to also avoid open applications being shown in the task bar).
    30   * Hide your bookmarks folders, and anything else *not* related to Sahana Eden that's in the browser window before starting the screen capture.
    31   * Fill in *every* field on *every* form shown with meaningful data (not gibberish, something that makes sense), not simply the required fields.
    32   * Press *every* button on every screen related to the module or application you are creating a screen cast for.
    33   * Take care again to not have gibberish entries (such as "kjdssga" for a name) or lots of unrelated data (i.e. organizations or incidents in India, Japan, Bhutan, the United States, and Tksfd) when showing screens with tabular data.  There is nothing wrong with entering a bunch of data as if responding to an event near your home as you will know the geography and organizations that make sense to include.
    34   * Alternatively, use a sample data set (if available) provided for the purpose of creating a demonstration.
    35   * Be very careful with spelling and try to avoid having your browser suggest entries based on previous demonstrations and selecting them rather than typing in a new data element (ajax lookups that are a part of Sahana Eden is okay as that is demonstrating Eden's capabilities).
    37 Finally, please provide a full resolution screen capture such that when the video is brought into full screen mode, or shown through a projector for demonstration or training purposes, that the image is clear and easy to read.
     26Coming soon.