wiki:UserGuidelines/SAMBRO

Version 24 (modified by Nuwan Waidyanatha, 6 years ago) ( diff )

--

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) Admin type activities are listed at the bottom. More or less in the reverse order of a typical work flow. We have segmented the work flow topics as bellow:

Subscribers (Alert Recipients)

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

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.

Future Plans

See the BluePrint/CAPBroker

Attachments (1)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.