= SAMBRO User Guide =
[[TOC]]

[http://eden.sahanafoundation.org/wiki/Deployments/SAMBRO 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. [[br]]

=== 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:

== Role Specific Topics ==

==== 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. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Publish#CreateaCAPMessage Create a Message] for the first time and as a message originator
1. [# Update a Message] using an existing message
1. [# Cancel a Message] that has been wrongly issued or provided wrong information
1. [# 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. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Implement#CreateaTemplate Create Message Templates] for categories of events and user groups
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Profile Define CAP Profile] specific information (waring priorities, event types, incident tables)
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Implement#ConfiguretheBroker Configure Broker] with identifier, warning priorities, and other relevant implementation or country context information
1. [# Update Register of Alerting Authorities]; i.e. setup your organizational structure and alerting jurisdictions
1. [# 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)
1. [# Customize] the CAP Broker for the implementation context (e.g Admin contact details, banner or logo changes
1. [# Basic Administration] tasks for activating an instance for the users
1. [# Testing the installation] to ensure all SAMBRO specific features are functional

== Future Plans ==

See the [wiki:BluePrint/CAPBroker BluePrint/CAPBroker]