Push Notifications
On this page
A push notification is queued by a workflow operation in the notification queue and sent by the Automation Server. For each push, the Automation Server selects the recipient's devices that match it and sends one request per device to one configured push notification URL. For how the notification queue and the other notification types fit together, see Notifications Overview; for the workflow operations, see Operations Reference. For what people see on their devices, see Push Notifications on Your Device, and for configuring the mobile apps, see Mobile App Configuration.
Push notifications in the Settings App
A push notification exists only as a Push Notification operation in a workflow program, the program of an item or of a function. It is created and deleted in that program. The Admin Center's class menu has no workflow node, so you author push notifications in the Settings App.
A class node under Workflow and Business Logic has a Workflow node that opens the workflow manager. Not every class node has one: the All Configuration Items, All Tickets, My Tickets, and Software Catalog nodes have no Workflow node, and the Workflow node of Stock Rooms opens an editor of toolbar actions instead of the workflow manager. In the workflow manager, each class has Actions, Triggers, and Components, and Components holds the class's E-mail Notifications and Push Notifications lists. The Global Workflow object has no Push Notifications list.
Add a push notification
- Go to the Programming tab of the workflow item that sends the push.
- In the operations tree, select the row after which the step goes, and choose New > Push Notification. The new row is added after the selected row; when the selected row is an IF, ELSE IF, or ELSE group, the new row becomes the first row inside that group. The Push Notification window opens.
- In To:, choose the Person who receives the push. The picker, Select Person, lists active Persons. Instead, you can click the expression button, which opens Build Expression, and enter an expression that returns one Person id.
- In Title:, enter the title. The ellipsis button opens Select Placeholder and inserts the placeholder you choose.
- Under Tapping on the notification will open:, choose Current Object, shown with the class name in parentheses, or choose Another Object and enter an expression that returns one object id.
- Under Send notification to:, choose Technician Apps (the default), Self Service Apps, or All Apps.
- Optionally, in Content:, enter the text of the push. The Insert Placeholder... button inserts a placeholder.
- Enable operation is selected by default. Clear it to save the step disabled; a run skips a disabled step.
- Click OK.
The window's Object Class: header names the class the step works on. Inside a Create Object or Act on Related Object block, that is the block's class. A warning line explains how the object is created from or related to the workflow object.
OK stays unavailable until To: and Title: are filled and Current Object is chosen or Another Object has a value. OK checks the title and the content as templates, so a placeholder that cannot be parsed is refused when you save the step. With Enable operation selected, OK refuses a step whose check fails and shows the reason; selecting Enable operation on such a step shows the same reason. Cancel removes the new row again.
For a service workflow object, Current Object is unavailable and is shown without a class name.
In the operations tree, Disable Operation turns a push notification's operation off without deleting it, and Enable Operation turns it on again. To delete a push notification, remove its operation from the program.
Edit a push notification from the list
A class's Push Notifications list is built from the push notification operations in the class's programs. For each one, it holds the definition, whether it is enabled, and the item or function it is sent from. The list has no commands to create, delete, copy, enable, or disable a push notification.
- In the class's workflow manager, open Components > Push Notifications.
- Open the notification and edit its settings. To enable or disable its operation, change Enabled in this window.
- Save the notification.
Opening a push notification from the list shows a Push Notification window with:
- an Enabled check box, which enables or disables the operation that sends the push;
- the step's Notification group, with To:, Title:, Tapping on the notification will open:, Send notification to:, and Content:;
- Sent From: followed by the id and name of the item or function that sends the push, as a link that opens it.
Saving with an empty To: shows "The "To" field is mandatory, it can't be left blank." Title: is marked as mandatory, but that check does not test it. The title and the content are checked as templates when you save. Saving writes the change, including Enabled, straight to the push notification operation in its program.
When the operation runs
When the operation runs, a To: value that is an expression is calculated to find the recipient. If the recipient is the acting user and self-notification is off, no push is queued. Otherwise the title and the content are filled in, and the push is queued together with the record changes of the run, so a run that is rolled back queues no push.
Send notification to: decides which of the recipient's devices receive the push: Technician Apps the devices registered by the technician apps, Self Service Apps the devices registered by the self-service apps, and All Apps both. When the recipient has no matching device, the push counts as sent and reaches no device.
A push notification defined before Tapping on the notification will open: and Send notification to: existed is still read: it opens the current object and is sent to the technician apps.
How a push leaves the installation
Every push leaves the installation as one HTTP POST request per device, sent to the push notification URL with the connection timeout set under Push notification settings.
An installation that keeps the default push notification URL sends its push traffic to a host operated by Alloy Software outside your network, whether it runs on premises or in Alloy Navigator Cloud. The relay behind the default URL fronts Firebase Cloud Messaging. The push notification URL is not one of the push notification settings.
When the push notification URL is empty, sending pushes fails before any connection is made.
Each request carries:
| Data | Content |
|---|---|
| Title and body | the title and body written for the push |
| Device token | the notification token the device registered |
| Message number and product name | the queued message's id and the short product name, when the push has a record |
| Record and class | the record the push refers to and its class, when a record was found for it |
| Telemetry | the installation's license number and the short product name |
When the relay reports a Firebase error, the error applies to that one device. If that error has status 404, the device's registration is deleted. Any other error status is treated as affecting the whole batch.
Push notification settings
The push notification settings consist of one setting, Connection Timeout. It appears on a page in the Settings App and on a page in the Admin Center; neither page holds the push notification URL.
In the Settings App
In the Settings App, the Notifications group holds Push Notifications > Settings, a page with one setting:
| Setting | What it does | Values |
|---|---|---|
| Connection Timeout | the connection timeout of the Automation Server's push requests, in seconds | 1 to 65535; 30 by default |
When the setting is applied, it is saved and the Automation Server reloads its settings.
In the Settings App, access to the whole Notifications branch, including Push Notifications > Settings, is controlled by the same permission as the e-mail services, not by a mobile permission; see Permissions Reference. In a settings export, the setting belongs to the "Push Notification Settings" section.
In the Admin Center
In the Admin Center, go to Notifications > Push Notifications. The page has one section, Push Notifications Server, which holds only Connection Timeout:, a number of second(s) from 1 to 65535. Save and Cancel appear only once you edit the form.
The page requires the notifications permission; see Permissions Reference.