Creating Standard Notifications

Prerequisites:

  • The Notification Server must be configured and running. On-premise customers can do this in SBM Configurator. The Notification Server is configured automatically for on-demand customers.
  • To receive e-mail notifications, users must have a valid e-mail address included in their user profile.
  • Users can only receive e-mail notifications for items they have privileges to view.

Standard notifications are generated when conditions specified in the When rule become true.

To add or edit a standard notification:

  1. Do one of the following:
    • To manage notifications for applications, select the process app for which you want to manage notifications from the Process Apps/Applications list.
    • To manage notifications for auxiliary tables, select Auxiliary Tables.
  2. Select the workflow or auxiliary table to which the notification is related.
  3. Click one of the following options:
    • Add - Click to add a notification.
    • Details - Select a notification for a workflow or auxiliary table, and then click to edit it.
  4. Provide a unique name for the notification, using the guidelines in Best Practices for Notifications and Escalations.
  5. Provide an optional description.
  6. Select a Link Type. The link type that you select is appended to the item URL that appears in the notification as described in General Notification Settings.
  7. Select one of the following actions for the notification, and then apply settings based on that action:
    • No Action

      Select this option to disable actions for the notification or escalation.

    • Send Broadcast Channel

      Select this option to send e-mail messages using one or more broadcast channels (which are not bound to a specific user). For example, after you create a broadcast channel in the Channels view, you can select the new channel in the notification, and specify a user account that limits the message details according to the user's privileges. For details, refer to Broadcast Channel Action Options.

    • Send E-mail/User Channel

      Select this option to send messages to users by e-mail and optionally, one or more user channels. This action sends an e-mail message to subscribed users, and enables you to specify the fields that should appear in e-mail messages. To send messages to users via a user channel as well, you must add one or more channels to the notification. For details about sending e-mail messages, refer to E-mail and User Channel Action Options and E-mail Field Settings. For details about sending messages via a user channel, see E-mail and User Channel Action Options.

    • Add Items to Folders

      Select this option to add item links to folders. For example, you can add item links to a team's folder when a member of the team becomes the owner of an item. For details, refer to Folder Action Options.

    • Remove Items From Folders

      Select this option to remove item links from folders. For example, if you use a notification to add item links to a team's folder when a member of the team becomes the owner of an item, you can use another notification to remove links from the folder when the team member is no longer responsible for the item. For details, refer to Folder Action Options.

    • Raise Event

      Select this option to execute an event as a specific user in connection with the item that triggered the notification. For example, you can have the system send an event to the Orchestration Engine, which can then execute an orchestration workflow when a notification rule becomes true. The change history will show that the changes were invoked by the user that you specified. For details, refer to Raise Event.

    • Run Script

      (On-premise only.) Select this option to run a script. Run a script imported into SBM Composer and deployed to this environment when a notification rule becomes true. The script is executed once for each user subscribed to the notification. Each time the script is executed, Shell.User is set to the user name. If no users are subscribed to the notification, the script is executed only once and Shell.User will be blank. For details, refer to Script Action Options.

    • Run Transition

      Select this option to perform a transition as a specific user against the item that triggered the notification. For example, when the item reaches a certain state, you can have the system perform a transition against the item when a notification rule becomes true. The change history will show that the transition was executed by the user that you specified. For details, refer to Run Transition.

    • Run Web Service

      Select this option to call a Web service function. You must first import a Web service definition or WSDL, into SBM Composer, and deploy the associated application to this environment. For details, refer to Web Service Action Options.

    • Run ChatOps Command

      Select this option to execute a ChatOps command such as Archive Item Channel. For example, if an item is sent to the Resolved state during a chat session, a notification can fire that saves the chat to the Notes section of the work item automatically instead of requiring a user in the chat to issue the archive command manually. For details on the ChatOps integration, refer to ChatOps Integration.

      Note: You must subscribe at least one user to any notification that uses the Run ChatOps Command action.
  8. Select a When rule that causes the notification to be sent. You can also click the plus (+) sign to create a new rule. For details, refer to About Rules and Conditions.
  9. Select the Enable inline images option to include images from Rich Text fields that have been added to the notification. This option may not appear if it is not enabled on the Notification Server tab in SBM Configurator (on-premise only).
  10. Save your changes.
  11. Subscribe users to the notification. For details, refer to Notification Subscriptions.
  12. For notifications that send e-mail, specify which fields should appear in the e-mail message. The $FIELDS() tag must be included in the template used by the notification. For details, refer to $FIELDS().
  13. Save your changes.