The Notify step allows you to create custom execution logs and send tailored notification messages to your subscribed email alerts or RSS feed. Notifications can be static or include dynamic content by leveraging input parameters. Email subscriptions are managed per user in the Settings page under the Email Alerts tab.
When you add a Notify step to a process, it generates one or more notifications per process execution at the document level. This means you won’t receive a separate notification for every document processed. If the notification includes dynamic document-level content, that data is aggregated into a single message and sent to the user’s email or RSS feed after the process completes.
The Notify step is designed to be used inline within a process. It does not modify your data; instead, it reads relevant document fields or properties and then passes the document to the next step unchanged.
Adding a Notify Step
Use the Notify step in a process to create custom execution logs and/or send personalized notification messages to your subscribed email alerts or RSS feed.
Steps:
- Add the Notify step: Insert the Notify step into the process. The Notify Step dialog will open.
- Enter a display name: Provide a descriptive name for the step. If left blank, the default name “Notify” will appear.
- Set the notification title: This title will appear in all enabled events and logs.
- Choose the message level: Select the type of notification: Information, Warning, or Error.
- Enter the message text.
- Enter any input parameters in the Variables field that you would like to appear in your message. Provide one or more values to insert into placeholders defined in the notification.
- {1},{2},{3}, etc., where the numeric value corresponds to the order in which the parameter was added. For example: Order: {1} Completed Successfully.
- Generate Platform Event: Sends the notification as an email alert to subscribers. If selected, the notification is sent as an email alert to subscribers. The event type is USER.NOTIFICATION. This check box is cleared by default.
- Write to Local Runtime User Log: log the notification in the base logs folder of the Runtime. This option is applied only when the process executes on a local Runtime. If selected, the notification is logged in the base logs folder of the local Runtime (<atom_installation_directory/logs>/<Process Name>.yyyy_MM_dd.log ) These user logs are available only on local Runtimes. You cannot access them when your process is running on the Runtime cloud. This check box is cleared by default.
- Write Once Per Execution: aggregate notifications such that for a given document, only one notification is generated. If selected, individual log entries or event messages that are generated per document that reaches the Notify step are aggregated and written only once. This check box is cleared by default.
- Click OK
- In the Notes tab:
- Enter a Title for the note.
- Enter the Note content.
- Click OK to save or Cancel to discard.