Text Variables – Omnilert

Text variables allow you to insert dates, times, and even the sender's name into messages automatically. When combined with Message Templates and Scenarios, these variables can add vital information to alerts with ease.

Specialized variables can be used with other features including:

Omnilert Gun Detect
Omnilert Weather Alert
Tip Reporting
Panic Button Alert

For example, you can use a date variable to make sure your dispatcher never types in the wrong date again.

In the example below, I'm editing a template to add {{@date_mdy}}, which will be substituted with the current date in the format mm/dd/yyyy.

Using this template, I never have to type in today's date when I send this "Campus Closed" message. The Omnilert system will always insert the date for me.

There are many possible text variables that you can use to present different date and time formats, as well as other info, such as the sender's name.

Standard Text Variables:

Standard text variables are for general use and can be inserted in any Message Template or Scenario Action.

The following is a chart of the available text variables that you can embed into your message content:

variable	description	example output
{{@time_his}}	Message time in 24-hour clock format (hours, minutes, seconds)	09:07:21
{{@time_hist}}	Message time in 24-hour clock with time zone	09:07:21 EDT
{{@time_gis}}	Message time in 12-hour clock format	9:07:21
{{@time_gisa}}	Message time in 12-hour clock format with AM/PM	9:07:21 AM
{{@time_gisat}}	Message time in 12-hour clock format with AM/PM and time zone	9:07:21 AM EDT
{{@date_dow_short}}	Today's day of the week, in a short format.	Wed
{{@date_dow}}	Today's day of the week, in long format	Wednesday
{{@date_mdy}}	Current date, shorthand (mm-dd-yyyy)	03-18-2020
{{@date_med}}	Current date, medium format	Wed, Mar 18, 2020
{{@date_long}}	Current date, long format (Best for voice templates!)	Wednesday, March 18, 2020
{{@date_mdyhms}}	Current date with the current time	03-18-2020 09:07:21
{{@date_mdyhmst}}	Current date, time and time zone	03-18-2020 09:07:21 EDT
{{@date_ymd}}	Current date, yyyy-mm-dd format	2020-03-18
{{@date_ymdhms}}	Current date and time, yyyy-mm-dd format	2020-03-18 09:07:21
{{@date_ymdhmst}}	Current date and time, yyyy-mm-dd /w time zone	2020-03-18 09:07:21 EDT
{{@time_hiadmj}}	Current time and the date in shorthand, AM/PM, day, mmm dd	10:57:53 EDT 09:07 AM, Wed, Mar 18
{{@tomorrow_date_dow_short}}	Tomorrow's day of the week, short	Thu
{{@tomorrow_date_dow}}	Tomorrow's day of the week, long	Thursday
{{@tomorrow_date_mdy}}	Tomorrow's date, shorthand	03-19-2020
{{@tomorrow_date_med}}	Tomorrow's date, medium format	Thu, Mar 19, 2020
{{@tomorrow_date_long}}	Tomorrow's date, long format (Best for voice)	Thursday, March 19, 2020
{{@tomorrow_date_mdyhms}}	Tomorrow's date and time	03-19-2020 09:07:21
{{@tomorrow_date_mdyhmst}}	Tomorrow's date and time with time zone	03-19-2020 09:07:21 EDT
{{@tomorrow_date_ymd}}	Tomorrow's date, yyyy-mm-dd	2020-03-19
{{@tomorrow_date_ymdhms}}	Tomorrow's date. yyyy-mm-dd /w time	2020-03-19 09:07:21
{{@tomorrow_date_ymdhmst}}	Tomorrow's date. yyyy-mm-dd /w time and time zone	2020-03-19 09:07:21 EDT
{{@account_name}}	The text value of your Account Name setting.	Sample Organization
{{@admin_username}}	Sending admin's username	jdoe
{{@admin_firstname}}	Sending admin's first name	John
{{@admin_lastname}}	Sending admin's last name	Doe
{{@admin_fullname}}	Sending admin's full name (first and last)	John Doe

Special Use-Case Variables

The variables listed below are used to pass content from various features, such as Triggers and Tips to Scenarios. As such, these variables are not for use with templates, but rather will require Scenarios to function properly.

In many cases, they work with specialized features linked within the section/description.

Scenario Actions

Omnilert's Scenarios feature can be adjusted to insert on-the-fly text typed by the sending admin. This allows the sender to insert that content into your pre-existing scenario's message actions, offering some flexibility when launching a scenario.

variable	description	example output
{{custom_message}}	Inserts on-the-fly content into a Scenario before launching it from the Omnilert admin portal. See this article for more information.	Your text here

If you're new to creating/using scenarios, see Creating a Scenario [VIDEO]

Tip Reporting via the Mobile App

Omnilert's Mobile App includes a Tip Reporting function that can pass subscriber-submitted tips to scenarios.

variable	description	example output
{{tip_body}}	The text content that was submitted by the app user who is sending you a "tip report".	There is an intruder in the lobby!
{{tip_location}}	The optional location of the mobile device submitting the tip. This will be presented as a web link. (The end-user can choose to turn this off at their discretion.).	n/a
{{tip_submitter}}	If not anonymous, this will be a link to the profile details of the subscriber who submitted the tip.	n/a
{{tip_media}}	Inserts a link/URL to view media (images/video) sent with the tip submission from the mobile app, if available.	n/a
{{tip_category}}	The tip report "category" text value.	Safety Tips

SMTP Triggers

SMTP Triggers are email-triggered scenarios. SMTP Triggers allow an external email to trigger an Omnilert Scenario to launch. Content from that triggering email can be passed to the scenario's actions.

variable	description	example output
{{email_from}}	This variable will be replaced by the email's 'From Address'.	jdoe@sample.com
{{email_subject}}	This variable will be replaced by the email's 'Subject'.	There is an intruder in the lobby!
{{email_body}}	This variable will be replaced by the email's plain-text 'Message Body'.	Your email message content here.

For more detailed information about using SMTP trigger email content in scenarios, see this article.

SMS Triggers

Omnilert includes the ability to relay content from the incoming (triggering) text message. (See SMS Triggers)

variable	description	example output
{{sms_number}}	Inserts the SMS number that triggered the scenario.	2125551234
{{sms_body}}	The text message content that followed the triggering event.	Your text content here

SNPP Triggers

Omnilert's SNPP Triggers allow triggering scenario launches from incoming SNPP (paging protocol) messages. (See SNPP Triggers)

variable	description	example output
{{snpp_body}}	The SNPP text content submitted to Omnilert's SNPP server.	Your SNPP page's text here.

CAP Triggers

Omnilert Scenarios can be triggered by the receipt of a Common Alerting Protocol (CAP) message via HTTPS POST. Content from the incoming CAP message can then be passed to along to your scenario actions' message content.

(This list provided for convenience. Please see the CAP standards documentation at http://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2.html for full descriptions of CAP fields and example CAP messages.)

variable	CAP field description
{{cap_addresses}}	The group listing of intended recipients of the alert message
{{cap_altitude}}	The specific or minimum altitude of the affected area of the alert message
{{cap_areadesc}}	The text describing the affected area of the alert message
{{cap_audience}}	The text describing the intended audience of the alert message
{{cap_category}}	The code denoting the category of the subject event of the alert message
{{cap_ceiling}}	The maximum altitude of the affected area of the alert message
{{cap_certainty}}	The code denoting the certainty of the subject event of the alert message
{{cap_circle}}	The paired values of a point and radius delineating the affected area of the alert message
{{cap_code}}	The code denoting the special handling of the alert message
{{cap_contact}}	The text describing the contact for follow-up and confirmation of the alert message
{{cap_derefuri}}	The base-64 encoded data content of the resource file
{{cap_description}}	The text describing the subject event of the alert message
{{cap_digest}}	The code representing the digital digest (“hash”) computed from the resource file
{{cap_effective}}	The effective time of the information of the alert message
{{cap_event}}	The text denoting the type of the subject event of the alert message
{{cap_eventcode}}	A system-specific code identifying the event type of the alert message
{{cap_expires}}	The expiry time of the information of the alert message
{{cap_geocode}}	The geographic code delineating the affected area of the alert message
{{cap_headline}}	The text headline of the alert message
{{cap_identifier}}	The identifier of the alert message
{{cap_incidents}}	The group listing naming the referent incident(s) of the alert message
{{cap_instruction}}	The text describing the recommended action to be taken by recipients of the alert message
{{cap_language}}	The code denoting the language of the info sub-element of the alert message
{{cap_mimetype}}	The identifier of the MIME content type and sub-type describing the resource file
{{cap_msgtype}}	The code denoting the nature of the alert message
{{cap_note}}	The text describing the purpose or significance of the alert message
{{cap_onset}}	The expected time of the beginning of the subject event of the alert message
{{cap_parameter}}	A system-specific additional parameter associated with the alert message
{{cap_polygon}}	The paired values of points defining a polygon that delineates the affected area of the alert message
{{cap_references}}	The group listing identifying earlier message(s) referenced by the alert message
{{cap_resourcedesc}}	The text describing the type and content of the resource file
{{cap_responsetype}}	The code denoting the type of action recommended for the target audience
{{cap_restriction}}	The text describing the rule for limiting distribution of the restricted alert message
{{cap_scope}}	The code denoting the intended distribution of the alert message
{{cap_sender}}	The identifier of the sender of the alert message
{{cap_sendername}}	The text naming the originator of the alert message
{{cap_sent}}	The time and date of the origination of the alert message
{{cap_severity}}	The code denoting the severity of the subject event of the alert message
{{cap_size}}	The integer indicating the size of the resource file
{{cap_source}}	The text identifying the source of the alert message
{{cap_status}}	The code denoting the appropriate handling of the alert message
{{cap_urgency}}	The code denoting the urgency of the subject event of the alert message
{{cap_uri}}	The identifier of the hyperlink for the resource file
{{cap_web}}	The identifier of the hyperlink associating additional information with the alert message

See this article for more information regarding CAP triggers.

Omnilert Gun Detect

Omnilert Gun Detect provides real-time video monitoring for gun threat events. The Gun Detect text variables provided are as follows:

variable	description
{{gd_category}}	Event category (e.g. "Gun Detected")
{{gd_camera_name}}	Text name assigned to the camera that is reporting an event.
{{gd_camera_url}}	Full URL for the network camera/device reporting the event.
{{gd_camera_lat}}	Latitude for the location of the camera (if available for that camera)
{{gd_camera_lng}}	Longitude for the location of the camera (if available for that camera)
{{gd_camera_map}}	A map link while will use the location data for the camera (if available for that camera)
{{gd_camera_image}}	Link / URL for an image of the gun detection event (camera capture). Will display a thumbnail image when presented in the Omnilert Mobile App.
{{gd_camera_video}}	Link / URL for video captured of the gun detection event (camera capture). Will display a thumbnail image when presented in the Omnilert Mobile App. Click to play in the app.

Omnilert Weather Alert

The following text variables can be used to pass information from Omnilert Weather Alert notices into your Scenario's Actions.

variable	description
{{wa_location_name}}	The text name is assigned to this location. This value is set in the Omnilert settings for Weather Alert.
{{wa_headline}}	The 'headline' text from the original NOAA alert. This is a description of the weather event. This is typically one or two sentences presented in all-caps.
{{wa_severity}}	The severity of the Weather Alert (provided by NOAA). Possible values: Extreme Severe Moderate Minor Unknown
{{wa_type}}	The text value for the 'type'. This indicates the kind of alert message. (e.g. 'Blizzard Warning ') For a complete list of NOAA/NWS weather event types, please see: https://alerts.weather.gov/cap/product_list.txt
{{wa_active_until}}	The expiration date/time text content sent by NOAA. (Not all alerts will include this information.)
{{wa_affected_areas}}	The list of affected areas sent by NOAA for this Weather Alert. This can be a very long list of counties, cities, or other geographic regions.
{{wa_summary}}	The 'summary' description of the alert provided by NOAA. This is typically two or three paragraphs of weather forecast information.
{{wa_instructions}}	The 'instructions' portion of the Weather Alert (provided by NOAA). This is typically a long-form text describing what steps to take, any precautions, etc.

These variables will relay information directly from the original NOAA message along with your own pre-determined text content, links to local resources, etc. (For more info, see Weather Alert)

Panic Button Alert

The following variables can be used in Scenario Actions launched from Priority Alerts > Panic Button Alert.

The following text variables can be used to pass information from the panic button submissions into your Scenario's Actions.

variable	description
{{panic_subscriber_name}}	The first and last name of the subscriber who initiated the panic notification.
{{panic_subscriber_username}}	The username of the subscriber who initiated the panic notification.
{{panic_subscriber_action}}	The action that was chosen by that subscriber within the Omnilert App. (e.g. "Dialed 911" or "Dialed emergency call number")
{{panic_subscriber_link}}	A link to view the subscriber's detailed profile in Omnilert.
{{panic_lat}}	The latitude for the subscriber's mobile device location (if available)
{{panic_lng}}	The longitude for the subscriber's mobile device location (if available)
{{panic_map}}	A map link for the subscriber's mobile device location (if available)

Tips / Tricks:

Pick the right variable for the job. Certain variables are more appropriate for text messages (SMS) than other media, such as voice calls. For example, you might want to use a "long" date in a voice call, but shorthand in SMS. (Time values will not read properly for Text-to-Speech voice calls.)
Beware of excessive message length. Remember that a variable is a placeholder. It is possible that the variable's length will be shorter than the text it represents. Keep this in mind when composing messages to endpoints with character limits, such as SMS.
(See SMS: Handling long text messages)