Notifications Overview
On this page
Alloy Navigator sends two kinds of notification: e-mail notifications and push notifications. A workflow notification of either kind passes three stages:
- Authoring: Workflow defines what to send, to whom, and when.
- Queue: When the workflow triggers a notification, the message is written to the notification queue, ready for delivery.
- Transport: The Automation Server takes messages from the queue and sends them. E-mail goes out through the configured mail service.
You administer notifications in the Settings App and in the Admin Center; see Admin Center and Settings App. Notifications are not authored in the Web App.
Authoring
A notification has two parts: a message defines what to send and to whom; an operation determines when to send it. Workflow has two operations that send anything, E-mail Notification and Push Notification. For workflow items and their operations, see Workflow Overview and Operations Reference. For push notifications, see Push Notifications.
The two kinds store their message differently:
| E-mail notification | Push notification | |
|---|---|---|
| Where the message is kept | As a message of its own, which several operations can share | Inside the operation that fires it: one message, one operation |
| Recipient | Address expressions in To, CC, and BCC | One person, plus the app that receives the push |
| When it is queued | After the change to the record is saved | Within the same save as the change to the record |
Any workflow item that runs operations can fire an e-mail notification: actions, triggers, service actions, functions, and scheduled tasks.
A notification has no enabled switch of its own. Enabling or disabling a notification enables or disables the operation that fires it. Because one e-mail message can be used by several operations, disabling it disables it everywhere it is used.
An e-mail message can wrap its content in an HTML template. The HTML templates form one catalog that all e-mail notifications share. Each e-mail notification also has an ID number: the Notification ID macro inserts it, and an error while the message is being prepared names it. The number comes from a counter that e-mail notifications share with workflow items and functions, so no two of them have the same number, and the numbers of e-mail notifications are not consecutive. For the macros, see Macros Reference. For writing messages, see Author E-mail Notifications.
The Self Service Portal has its own fixed set of four e-mail templates, Password Notification, Manager Notification, Authorization Request, and Registration Confirmation. They form a second catalog, apart from the workflow e-mail notifications: you can edit them, but not create or delete them. See Portal E-mail Templates.
The notification queue
Every outgoing message, e-mail or push, is a row in one notification queue. A queued message has no send date and no send error until an attempt to send it has been made. Besides workflow notifications, the queue also receives test messages, self-registration messages, and system log alerts. Each queued message records which component and which feature queued it.
An @-mention queues, for each mentioned person, an e-mail to the person's primary e-mail address, when the person has one, and a push notification. Both are recorded as queued by workflow notifications, so the feature they record does not tell them apart from the notifications authored in workflow. See Mention Notifications.
Attachments of a notification belong to its queue entry. When the entry is removed, its attachments are removed too, unless a record also holds them. Outgoing notifications have an attachment size limit of their own, separate from the general attachment limit; see Outgoing E-mail Settings.
For working with the queue, see Notification Queue.
Transport
E-mail goes out through one of five mail services: Simple Mail Transfer Protocol (SMTP), Exchange Online with OAuth authentication, Google Mail (SMTP + OAuth), Exchange Web Services (EWS), and Messaging Application Programming Interface (MAPI). For setting up the mail service and testing it, see Outgoing E-mail Settings.
Over SMTP, a message carries headers that mark it as automatic, depending on what queued it:
- An @-mention e-mail carries neither pair.
- Otherwise, a message queued by a workflow trigger or a scheduled task carries
Auto-Submitted: auto-generatedandX-Auto-Response-Suppress: NDR, RN, NRN. - Otherwise, a message queued by the Mail Connector carries
Auto-Submitted: auto-repliedandX-Auto-Response-Suppress: All. - Otherwise, a message queued from the Self Service Portal, the Web App, the Import Wizard, or the mobile apps carries neither pair.
- Otherwise, a message queued by another component, such as the Automation
Server, the REST API, archiving, or reporting, carries
Auto-Submitted: auto-generatedandX-Auto-Response-Suppress: NDR, RN, NRN.
Incoming mail processing recognizes these headers, so a notification that Alloy Navigator sent and that bounces back is recognized as automatic.
Where each part is administered
The Admin Center's class menu has no workflow node, so you author per-class e-mail and push notifications in the Settings App.
In the Settings App
- Per-class notifications: Under Workflow and Business Logic, a class node has a Workflow child that opens the workflow manager. There, Components holds E-mail Notifications and Push Notifications for the class. The Global Workflow object's e-mail notifications are under Global Components > E-mail Notifications. No node lists the e-mail notifications of scheduled tasks.
- Creating and deleting: The Settings App creates, deletes, and fully edits both kinds. The push notification list has no New or Delete: a push notification is created and deleted as an operation of its workflow item. In the E-mail Notification window, the Usage tab lists the items and functions that fire the message. The Settings App does not delete an e-mail notification while it has callers.
- The Notifications group: Global Settings, Notification Queue, Logs, E-mail Notifications with Settings and HTML Templates, and Push Notifications with Settings. The notification queue is shown as a grid with a start and stop control.
- The Self Service Portal group: E-mail Templates lists the portal's four templates. Without the Self Service Portal right, opening a template shows a message that you do not have the rights.
In the Admin Center
- The Notifications section: Its pages are Global Settings, Notification Queue, Logs, E-mail Notifications, HTML Templates, Push Notifications, and SSP E-mail Templates. The section offers Global Settings, Notification Queue, Logs, E-mail Notifications, HTML Templates, and Push Notifications to a user with the notifications permission, and each of these pages except Logs requires that permission to open. The Logs page itself requires the permission to manage logs. SSP E-mail Templates requires the Self Service Portal configuration permission, so the section is offered to a user who holds only that permission. The section opens on Global Settings.
- Global Settings sets how often the queue is checked, whether notifications are sent to the users who trigger them, and what happens to a notification with no recipient.
- Notification Queue is the queue's page. The queue also tracks whether e-mail sending is paused, with the date it was paused and who paused it. In Cloud, the page's Send toolbar button is withheld; see Administering Alloy Navigator Cloud.
- E-mail Notifications sets up the mail service. For EWS and MAPI, the page shows only the warning "This feature is not yet available in the Admin Center. Please use the desktop Settings App."
- Push Notifications has a Push Notifications Server section that holds only Connection Timeout:.
- HTML Templates lets you create, edit, and delete the HTML templates. A template that uses the same section placeholder twice is refused with "Each section placeholder can be used only once per template".
- Logs is the same log as the Outgoing Notifications tile in the Logs section; see Logs. System log alerts, which the queue also receives, are set up from the Logs section.
- SSP E-mail Templates lets you edit the portal's templates, but not create or copy them. An information banner appears above the list when more than one Self Service Portal instance has self-registration enabled.