SAMBRO User Guide

An Introduction to SAMBRO (Sahana Alerting and Messaging Broker)

Purpose

The user guide is comprehensive with instructions from setting up SAMBRO software to issuing alerts. It is intended for all user levels: novices to experts. The guide is structured to take you through an actual implementation with real world examples and data.

How to use the Guide

The user guide is designed to quickly access relevant information for performing a task and understanding the technical details. Notice that the most frequently used activities are listed first, for the users, and the seldom used (one time type) activities are listed at the bottom. We have segmented the topics as bellow:

Publishers (Alert Issuers)

The section discusses ways and means for creating a CAP message, having it authorized, and then issuing (or disseminating) to the subscribers

1. Create a Message for the first time and as a message originator
2. Update a Message using an existing message
3. Cancel a Message that has been wrongly issued or provided wrong information
4. Clear a Message when the event has subsided to inform the subscribers with an 'All Clear' message

Implementers (Super Users)

Section is for CAP Implementers for orienting the CAP Broker in the country or implementation specific context.

1. Create Message Templates for categories of events and user groups
2. Define CAP Profile specific information (waring priorities, event types, incident tables)
3. Configure Broker with identifier, warning priorities, and other relevant implementation or country context information
4. Update Register of Alerting Authorities; i.e. setup your organizational structure and alerting jurisdictions
5. Manage Users by associating them with the relevant roles and alerting authority

Administrators

1. Install software with web2py framework and other dependencies for Map (GIS), Messaging (Email, SMS, other)
2. Customize the CAP Broker for the implementation context (e.g Admin contact details, banner or logo changes
3. Basic Administration tasks for activating an instance for the users
4. Testing the installation to ensure all SAMBRO specific features are functional

Subscribers (Alert Recipients)

Data

Note: 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.

• Alerts -- The qualifiers of the alert message. Includes alert identifier, sender, message type, scope (audience), references to other cap alerts and other fields.
  • 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.
    • Resource -- One or more files attached to the information (could be things like a map of the affected area, documents containing instructions etc.)
    • 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.
• 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.
• 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.

Workflow

Before creating a CAP template and a message, you should have created a CAP Profile first.

Configuring a CAP Profile

​ Watch the Video

CAP profiles can be configured using the deployment settings.

The following settings can be set as follows

    settings.cap.identifier_prefix = "prefix"  # string
    settings.cap.identifier_suffix = "suffix"  # string
    settings.cap.codes = [...]           # key-value pairs
    settings.cap.parameters = [...]      # key-value pairs
    settings.cap.geocodes = [...]        # key-value pairs
    settings.cap.base64 = False          # boolean
    settings.cap.languages = OrderedDict([
                                 ("en-US", "English"),
                                 ("fr", "Français")
                                 ...])
    settings.cap.priorities = OrderedDict([
                                  ("<value>, "<Translated title>", <urgency>, <severity>, <certainty>, <color>),
                                  ...
                              ])

Key-value pairs above are python lists containing many dictionaries detailing the behavior and parameters for the key-value pair. It should take the following form

    kvpairs = [
        dict(key="<key>", value="<value>", comment="<help text>", immutable=<immutable>, options=[("<value>", "<Value title>"), ...]),
        ...
    ]

• Here the comment and options dictionary values are optional.
• The options argument is a list of ("<value>", "<value title>") pairs and provides a drop-down to pick the value for the key from.
• The mutable argument is a bit-map saying whether to lock the key field or the value field or both in the key-value user interface. (by locking we mean disabling.) You can use it like so:

      KEY_MUTABLE = 1
      VALUE_MUTABLE = 2
  
      immutable = KEY_IMMUTABLE # only key is immutable
      immutable = VALUE_IMMUTABLE # only value is immutable
      immutable = KEY_IMMUTABLE | VALUE_MUTABLE # both immutable
      immutable = 0 # both immutable
  

Future Plans

See the BluePrint/CAPBroker