= SAMBRO 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 '''role specific work flow topics'''. If you are a particular user searching for a topic, '''first navigate to the type of user you are and then select the work flow activity'''.

== Role Specific Topics ==

==== Subscribers (Alert Recipients) ====
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Subscribe#RSSAtomFeeds RSS/Atom Feeds] for your alert hub or RSS/Atom Reader for all alerts
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Subscribe#SubscribeViaEmailSMSandFTP Email, SMS, FTP] subscription to receive event and area specific alerts
1. '''UNAVAILABLE''' [# Social Media] - link to Twitter, FaceBook news feeds applying the instructions given by the Administrator
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Subscribe#Viewpublishedalerts View Alerts] and interpret them on a map and complete
==== 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. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Publish#UpdateCancelorClearaCAPMessage Update] a message using an existing message
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Publish#UpdateCancelorClearaCAPMessage Cancel] a message that has been wrongly issued or provided wrong information
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Publish#UpdateCancelorClearaCAPMessage Clear] a message when the event has subsided to inform the subscribers with an 'All Clear' message
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Publish#AuthorizeaCAPMessage Authorize] a message before issuing, posting or dissemination

==== 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/Admin/UserManagement Manage Users] by associating them with the relevant [http://eden.sahanafoundation.org/wiki/BluePrint/CAPBroker#Use-Cases roles] and alerting authority
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Implement#CreateMessageTemplate Create Message Templates] for categories of events and user groups
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Implement#CreatingPredefinedAlertArea Predefined Alert Area] polygon and area description developments
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Implement#ManagingtheRegisterofAlertingAuthoritiesandOIDs Update Register of Alerting Authorities]; i.e. setup your organizational structure and alerting jurisdictions
1. [wiki:UserGuidelines/SAMBRO/Profile Define CAP Profile] specific information (waring priorities, event types, incident tables)
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/SAMBRO/Implement#Configure Configure Broker] with identifier, warning priorities, and other relevant implementation or country context information
1. [# Testing the implementation] after setup, configuration, and adding users
==== System Administrators ====
1. [http://eden.sahanafoundation.org/wiki/InstallationGuidelines Install] the Sahana Eden software with web2py framework and other dependencies.
     1.1 Recommend that you [http://eden.sahanafoundation.org/wiki/InstallationGuidelines/Linux/Server install on a Linux server]
     1.1 [# Setup the server with a Public IP] to be visible over the Internet
     1.1 [# Configure the installation] to send receive SMS, Email.
     1.1 [# Activate the SAMBRO template] by changing the default template.
1. [http://eden.sahanafoundation.org/wiki/ConfigurationGuidelines Customize] the CAP Broker for the implementation context (e.g Admin contact details, banner or logo changes
1. [http://eden.sahanafoundation.org/wiki/UserGuidelines/Admin Basic Administration] tasks for activating an instance for the users
1. [# Testing the installation] to ensure all SAMBRO specific features are functional

== Design and Specifications ==

For advance users or developers interested in  the SAMBRO software design requirements and specifications are discussed in the[[br]]
[wiki:BluePrint/CAPBroker CAP Broker BluePrint]