Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. BlackBerry AtHoc Integrations
  4. Monaco Warning System Installation and Configuration Guide
  5. Set up inbound alert activation

Set up inbound alert activation

The Monaco D-21 uses XML CAP payload to activate BlackBerry AtHoc alerts. The IIM receives the message, verify its transmission envelope, and relays to BlackBerry AtHoc alerts, which validates the payload, executes the request, and responds appropriately. All BlackBerry AtHoc alerts activation use templates identified by their common names. The template can be modified at the activation level based on the CAP XML and the 
DynamicTextMode
 parameter.
/alert/info/eventCode/valueName/SCENARIO
/alert/info/eventCode/value/[name of scenario]
The node 
<eventCode>
 shall have the 
<valueName>
 element template, and <value> node shall contain the template name. Templates are identified by unique names of up to 128 characters.
The node 
<headline>
 can be used to override the template header and includes 3 to 200 characters.
The nodes 
<description>
 and 
<instruction>
 can be used to override the template body, and includes 0 to 2000 characters.
/alert/
identifier    unique identifier generated by Monaco D-21
sender        Sender identity, from Monaco D-21
sent        Date & time of message origination
status        “Actual” / “Exercise”
msgType    “Alert”
scope        “Private” / “Public”
addresses    (optional) Receiver identity
info/        (required for Alert” msgType)
    category     “Other” 
    event         The alert message header / title; informational
    urgency         “Unknown” 
    severity     “Unknown” 
    certainty    “Unknown” 
    eventCode/
          valueName    “TEMPLATE” 
          value        Scenario common name – CASE SENSITIVE
    expires         optional time to and the delivery
    headline     optional message title 
    description     optional message pre-body 
    instruction     optional message post-body
    parameter     optional code to indicate use of optional text
GUIDs are generated and used as “identifier” values. If expired, the timestamp specifies that is the time to end playing the delivery of the audio / visual alert.
The parameter 
DynamicTextMode
 is located in the 
CAP XML /alert/info/parameter
 with valueName of 
DynamicTextMode
. The values allowed in the value field are None, Replace, and Append.
If the 
DynamicTextMode
 parameter is blank, missing, or invalid the template is treated as if in None mode. If the headline, description, and instruction CAP XML fields are blank or missing, the template is treated as if in None mode.