Workflow Substitution Tags

Overview

Workflow Substitution Tags allow Notification Templates used by SafeZone Workflows to include dynamic information from the event that triggered the workflow.

When the workflow runs, each tag is automatically replaced with the corresponding value available from the triggering event. For example, a workflow triggered by a user checking in could add the user's name, location and check-in time to an email sent to their supervisor.

Workflow Substitution Tags can also pass information collected from external subscribed web feeds into SafeZone Notification Templates. This enables external events to trigger notifications containing information such as an event title, severity, affected area or link to further information.

Workflow Substitution Tags differ from Notification Template Substitution Tokens. Notification Template Substitution Tokens prompt an operator to select or enter information when manually sending a notification. Workflow Substitution Tags require no operator input and are populated automatically when a workflow runs.

The tags available to a Notification Template depend on the event that triggered the workflow. A tag that is not populated by the selected trigger may produce an empty value or may not be suitable for that workflow.

Using Workflow Substitution Tags

Add the required tags to the content of the Notification Template used by the workflow. Tags can be combined with fixed text to produce a complete notification.

For example:

Hello {trigger.checkin.fields.display_or_full_name},

Your check-in was received at {trigger.checkin.in:datetime(G)}.

When the workflow runs, SafeZone replaces the tags with the information from the check-in event.

Workflow notifications may use channels such as Push Notifications, SMS and Email, subject to the workflow action, organisation licensing and available configuration.

Test each workflow and its Notification Template before operational use. The values available vary according to the trigger, the user's profile, device permissions, location availability and other event data. 

Common Use Cases

Notify a Supervisor When a User Checks In

A check-in workflow can notify a supervisor or another defined recipient that a user has arrived at a location.

Subject: User check-in received

{trigger.checkin.fields.display_or_full_name} has checked in.

Location:
{trigger.checkin.geoloc.text}

Date and time:
{trigger.checkin.in:datetime(G)}

Check-in tags can provide profile and location information associated with the person checking in.

Notify a Supervisor When a User Checks Out

A check-out workflow can confirm that a user has completed an activity or left a monitored location.

Subject: User check-out received

{trigger.checkout.fields.display_or_full_name} has checked out.

Provide Awareness of an Alert

Alert tags can include information about the person raising an alert and the location from which it was raised.

Subject: SafeZone alert raised

A SafeZone alert has been raised by
{trigger.alert.raiser.fields.display_or_full_name}.

Email:
{trigger.alert.raiser.fields.email}

Location:
{trigger.alert.geoloc.text}

Important: Workflow notifications should not replace SafeZone Command or OmniGuard as the primary tools for managing alerts. They should be used to provide additional awareness to appropriate recipients.

Include an Alert Location

Alert latitude and longitude tags can be combined to create a Google Maps link.

http://www.google.com/maps/place/{trigger.alert.geoloc.lat:number(F3)},{trigger.alert.geoloc.lon:number(F3)}

The current tag reference also includes a dedicated map.google.url tag. Confirm which location and map tags are populated by the workflow trigger before using them in an operational template.

Notify When an Alert Is Acknowledged

Alert acknowledger tags can pass information about the person who acknowledged an alert.

Subject: Alert acknowledged

The alert has been acknowledged by:

{trigger.alert.acknowledger.fields.display_name}

Email:
{trigger.alert.acknowledger.fields.email}

Send a Tip Report by Email

A Tip Report workflow can pass the report category, summary, sender details, location and image into an email. Different Tip Report categories can be routed to different recipients or User Groups.

Subject: New Tip Report - {trigger.tip.category.name}

Summary:
{trigger.tip.summary}

Raised by:
{trigger.tip.raiser.fields.display_name}

Email:
{trigger.tip.raiser.fields.email}

Image:
{trigger.tip.img.url}

Images are best suited to Email Notifications. Where no image was included with the Tip Report, an image tag may not return a usable value.

Notify When a Tip Report Is Resolved

Tip resolver tags can include information about the person who resolved the report.

Subject: Tip Report resolved

The Tip Report has been resolved by:

{trigger.tip.resolver.fields.display_name}

Email:
{trigger.tip.resolver.fields.email}

Notify When a User Joins a User Group

A workflow can send a notification when a user is subscribed to a User Group.

{trigger.usergroup-subscribe.user.fields.display_name}
has been subscribed to
{trigger.usergroup-subscribe.group.name}.

Notify When a User Leaves a User Group

A similar workflow can notify recipients when a user is removed from or unsubscribes from a User Group.

{trigger.usergroup-unsubscribe.user.fields.display_name}
has been unsubscribed from
{trigger.usergroup-unsubscribe.group.name}.

Publish Information from an External Web Feed

Web Subscription tags can place information collected from an external feed into a SafeZone Notification Template. Supported data in the current reference includes general feed information and fields associated with RSS, Atom, GeoRSS, CAP and embedded CAP content.

Subject: {trigger.websub.item.name}

Event:
{trigger.websub.item.capsembedded.event}

Severity:
{trigger.websub.item.capsembedded.severity}

Affected area:
{trigger.websub.item.capsembedded.areaDesc}

Summary:
{trigger.websub.item.capsembedded.summary}

External feeds do not necessarily provide every available field. Templates should use only the tags known to be supplied by the configured feed and should be tested using representative feed data.

Available Tag Categories

The complete current reference is provided in the CSV attachment. Tags are grouped into the following categories.

• Alert – Information about the alert acknowledger, entity, raiser, resolver, subject and alert location.
• Check-in – Profile, user identifier and location information associated with a check-in.
• Check-out – Profile and user identifier information associated with a check-out.
• Tip Report – Tip category, summary, image, location, raiser and resolver information.
• User – Profile information associated with a workflow user.
• Sender – Profile information associated with the sender.
• Map and Location – Coordinates, address components, building and floor information, map links and map images.
• User Group Subscription – Information about a user and the User Group to which they have subscribed.
• User Group Unsubscription – Information about a user and the User Group from which they have unsubscribed.
• Web Subscription – General feed, RSS, Atom, GeoRSS, CAP and embedded CAP information.
• Workflow Parameters – SafeZone region, Region Group, sender, user and User Group identifiers passed to the workflow.
• Date and Time – The current date and time when the workflow action runs.

Profile and Sensitive Information

Some Workflow Substitution Tags reference user profile information that may be sensitive, confidential or subject to local privacy requirements. Examples include medical information, mobility needs, care plans, next-of-kin details, security notes and other personal information.

Only include such information where there is a clear operational requirement. Carefully control the Notification Template, workflow recipients, delivery channels and relevant user permissions.

Avoid sending sensitive information through broad distribution lists or channels that may display notification content on unattended or locked devices. 

Complete Tag Reference

The complete current list of Workflow Substitution Tags is provided in the attached CSV file. It contains:

• The tag path supplied by the current reference export.
• The corresponding display name.
• A high-level category.
• The object to which the tag belongs.

The availability of a tag does not mean that it will be populated by every workflow. Select tags that correspond to the configured workflow trigger and test the resulting notification before deployment.