how to create a CAP message template

Creating Alert Template

An alert template is a pre-populated CAP message that is created to speed-up with the message creation as well as preserving the consistency of a message. Wherever the event specific information such as the DATE or LOCATION or other information you may create place holders for those values within the text. You should mark up places in the text that need to be changed within a pair of square brackets with capitalized text inside as shown below.

Example the headline text in a CAP message template for a earthquake event could be something like this: [YYYY] [MMM] massive earthquake hit [LOCATION]. If we talk about the recent earthquake in Nepal, then the message creator would replace the MMM YYYY and LOCATION to create the headline to be specific as such: then the headline could be 2015 April - massive earthquake hit Nepal.

You can fill in the alert details and info segment details in the template alert message. For creating predefined area, see here

Here I will guide you through how to create Earthquake Template. You can use this as a guideline to create any event specific template.

  1. In your browser, open up the SAMBRO system
  1. Once you have opened the system, various menu options are available on the top. Click on Alerting option.

  2. This opens up the table with the alert. We now begin to create template. On the side menu, under TEMPLATES, there is an option to Create. Click on that.

  3. Now a form appears to fill in the Alert section of CAP Template Message. Fill in the values. You can refer the picture on the side.

5. After you fill out necessary information and click on Save button at the bottom of the form I mentioned above, you can now see one extra tab [Information template]. Now go to the Information template tab and begin to fill the information.
To add information, you can see Add alert information on the right side of your screen. A form appears. Now you can begin to add information to the alert. Refer the image on the side.

Importing/ Prepopulating Multi Language Alert Template

You can prepopulate the multi-language template into the system or if your site is already live, you can import the multi-language.

  1. First start by importing Alert. In the browser, go to /eden/cap/alert/import. You can download the template and use that to prepare the data.

The column name -

  • Template Title (does exactly what it says),
  • Identifier (you need to remember this because we use this identifier to link to the info segment which you will see below [of course, the identifier for the actual alert is not this one so don't be afraid ;-)]),
  • Scope (is one of 'Public, Restricted or Private' : take care of the match case as this will go into database),
  • Restriction (if Scope=Restricted, use this to denote who is the restriction scope audience),
  • Recipients (use list of strings eg '["Coast Guard", "Public", "Local Officials"]' to fill the value in this field)
  • Note' (free text that gives in the purpose or the significance of the message)
  • Incidents(list of strings as Recipients. The list of possible values that can come in are here) - value on the left side of the colon (eg. "civil.volunteerRequest", "civil.publicEvent" etc) OR on this page, search for cap_incident_type_opts = { and you will find them.


  1. Now you can add multi-language info. In the browser, go to /eden/cap/info/import. You can download the template and use that to prepare the data.

The column name -

  • Identifier (the same identifier as above - for which alert this info is targeted)
  • Language - the language in which the info is targeted (use en-US for English; for other language see here. Use the value in the left side)
  • Category (list of strings. The list of possible values that can come in are {use value in the left side}
    • “Geo” - Geophysical (inc. landslide)
    • “Met” - Meteorological (inc. flood)
    • “Safety” - General emergency and public safety
    • “Security” - Law enforcement, military, homeland and local/private security
    • “Rescue” - Rescue and recovery
    • “Fire” - Fire suppression and rescue
    • “Health” - Medical and public health
    • “Env” - Pollution and other environmental
    • “Transport” - Public and private transportation
    • “Infra” - Utility, telecommunication, other non-transport infrastructure
    • “CBRNE” – Chemical, Biological, Radiological, Nuclear or High-Yield Explosive threat or attack
    • “Other” - Other events
  • Event Type - the event_type relating to this alert (can use the one already in system at /eden/event/event_type or use new one here)
  • Response Type - list of strings, can be multiple separated by comma(,).Possible values are
    • “Shelter” – Take shelter in place or per <instruction>
    • “Evacuate” – Relocate as instructed in the <instruction>
    • “Prepare” – Make preparations per the <instruction>
    • “Execute” – Execute a pre-planned activity identified in <instruction>
    • “Avoid” – Avoid the subject event as per the <instruction>
    • “Monitor” – Attend to information sources as described in <instruction>
    • “Assess” – Evaluate the information in this message. (This value SHOULD NOT be used in public warning applications.)
    • AllClear” – The subject event no longer poses a threat or concern and any follow on action is described in <instruction>
    • “None” – No action recommended
  • Audience - The text describing the intended audience of the alert message
  • Event Code - list of dictionary with KEY:VALUE, can be multiple, separated by comma(,) eg. [{"KEY1":"VALUE1"},{"KEY2":"VALUE2"},...]
  • Sender Name - The human-readable name of the agency or authority issuing this alert.
  • Headline - A brief human-readable headline. Note that some displays (for example, short messaging service devices) may only present this headline; it SHOULD be made as direct and actionable as possible while remaining short. 160 characters MAY be a useful target limit for headline length.
  • Description - An extended human readable description of the hazard or event that occasioned this message.
  • Instruction - An extended human readable instruction to targeted recipients.
  • Contact - The text describing the contact for follow-up and confirmation of the alert message
  • Parameters - same as Event Code


Last modified 7 years ago Last modified on 02/17/16 01:33:56

Attachments (2)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.