Event notifications are based on changes to order milestones or a task states. The type of the event notification determines where you configure the notification, whether it can be sent to a work group, or whether it will be automatically consumed by an automation plug-in. There are three types of event notifications:
Task status-based event notifications are triggered by rules that evaluate when a task transitions to a specific status or exception path within a process. You define task status event notifications using the Properties Events tab in the Process editor. See "Creating Task Status-Based Event Notifications" for more information.
Order milestone and task state automation event notifications are triggered when an order transitions to a specific milestone or when a task transitions to a specific state. When you configure a milestone-based or state-based event notification for an order in the Order editor or for a task in the Task editor, the notification triggers automatically upon reaching the specified order milestone or task state, and the notification is consumed by an automation plug-in that performs the work. When you configure a task state-based event notification for a specific task in the Process editor, you can also include an additional rule that must evaluate to true before OSM triggers the notification, and you can elect to send the notification to a work group.
See "Creating Order Milestone and Task State Automation Event Notifications" and "Creating Process-specific Task Event Notifications" for more information.
order data changed notifications are triggered by changes made to the order data. You can configure order data changed notifications to update external systems (such as CRM) with status updates when a specific data node in the order data is updated with a new value. You configure order data changed notifications in the Order editor Notifications tab. See "Creating Order Data Changed Notifications" for more information.
Note:
Order data changed notifications are not available when using releases prior to OSM 7.0.Working with Jeopardy and Event Notifications
You create order milestone and task state automation event notifications at the order or task level. You select the order milestone (in the Order editor Events tab) or the task state (in the Task editor Events tab) that triggers the automation, and then configure the automation plug-in that will perform the work.
For example, when a task reaches the Assigned state, you can automate an external lookup before allowing the workflow to continue.
To create an order milestone or task state automation event notification:
Determine the level at which to create the event notification.
For example, if you want the notification to trigger when the order reaches the completion milestone, define the notification at the order level. To create an event at the order level, navigate to the Order editor Events tab. To create an event at the task level, navigate to the Task editor Events tab.
From the Order editor or the Task editor Events tab, click Add in the Milestone or State column, respectively.
A Selection dialog box opens, which lists all of the milestones or states that have been defined for this order or task.
Select a milestone or task from the list of options.
For order events, the milestones include Completion, Creation, Deletion, Exception. For task events, all of the states that you have defined on the Task editor States/Statuses tab appear in the list of options.
Click OK.
In the order event Milestones column or the task event States column, select the milestone or state for which you want to add an automation plug-in.
In the Automation column, click Add.
The Add Automation dialog box is displayed, which enables you to create the automation plug-in.
Enter a name for the automation plug-in, select the appropriate action from the available list, and click OK.
The newly created plug-in is displayed in the Automation column.
Select the automation plug-in.
When you select the automation plug-in, Design Studio displays its Properties tab. Use the subtabs to configure the plug-in. The tabs will vary depending on the type of plug-in selected.
See "Configuring Automation Plug-In Properties" for more information.
For Order Events, if the automation plug-in has an OSM user in the automation plug-in Run As property field with more than one role, click Select from the View field to choose a query task view to use for the automation plug-in. If only one default query task exists in the Order editor Permissions tab, then Design Studio automatically associates it with new automations.
You can configure task state-based event notifications for all instances of task in a specific process or for a single instance of a task in the process. When you configure a state-based event notification for a specific task in the Process editor, you can include rules which must evaluate to true before the notification is triggered. When the task reaches the specified state, OSM evaluates the rule to determine whether the event notification is triggered.
To create process-specific task event notifications:
From the Process editor, select the task to which the event applies.
The Properties tab for the selected task opens.
Click the Events tab.
Click Add.
The Event wizard is displayed.
In the Name field, enter the mnemonic for the task event.
The name must unique among the notification types within the same namespace.
In the Display Name field, enter the name of the task event that should be displayed to users.
In the Rule field, select the rule that must evaluate to true before OSM can trigger this event notification.
The null_rule is the default value for this field. If you do not change the default value, the OSM server will always trigger this notification when the corresponding task reaches the specific state. See "Defining Order Rules" for information about setting up new rules.
In the Priority field, select a priority for the notification.
1 is the highest priority. For notifications that are sent to external systems, this field represents the JMS queue priority.
Select Enabled.
Deselect this option if you intend to implement the task event notification at a later time.
Specify whether to send the notification to specific email accounts.
By default, notifications appear in the Notifications page of the Task web client. However, you can specify that notifications be sent to a user's email account by selecting the Email check box. You associate users with email accounts in Administrator. See OSM Order Management Web Client User's Guide for information about configuring email notification properties for user roles. See OSM Installation Guide for information about configuring the outgoing email server.
In the State field, specify the state that the task must be in before OSM evaluates the rule associated with the event.
The three mandatory states (accepted, completed, received) and all custom states that you defined on the Task editor States/Statuses tab appear as values.
Click Next.
Select the roles to be notified when the event is triggered.
See "Working with Roles" for more information.
Click Finish.
The event notification is added to the event table.
Select the event.
When you select the event, Design Studio activates the Event subtabs. You can add any undefined elements at any time by using these subtabs. See the following topics for defining the values in the Events subtabs:
Working with Event Notifications
Use the Properties Events Details tab to name task state-based and task status-based event notifications, specify the rule that triggers the event, set the priority level, enable or disable the event, and specify whether to send the notification by email.
| Field | Use |
|---|---|
| Name | Enter the mnemonic for the notification. |
| Display Name | Enter the name to be displayed to the user. |
| Rule | Select the rule the system should evaluate before generating this notification. This field defaults to the system-based null_rule.
If you do not change the default value, OSM will always trigger this notification when the task reaches the specified state or when the task transitions to the specified status. See "Defining Order Rules" for more information about setting up new rules. |
| Priority | Enter a priority from 1 to 255 (1 is the highest priority). The notification with the highest priority is evaluated first. |
| Enabled | Select to enable this notification, or deselect the option if you intend to implement the notification at a later time. |
| Select to send email notifications to all users in the workgroup associated with the specified role.
By default, notifications appear in the Notifications page of the Task web client. However, you can specify that notifications be sent by email by selecting the Email check box. When you assign users to a workgroup in the OSM Administration area of the Order Management web client, you can set up OSM to notify users by email. When a notification occurs, the system sends a notification ID number through email. See OSM Order Management Web Client User's Guide for information about configuring email notification properties for user roles. |
|
| State | Appears for task entities only. Select the state to which the task must be in before OSM evaluates the rule associated with the event.
The three mandatory states (accepted, completed, received) and all custom states that you defined on the Task editor States/Statuses tab appear as values. |
Creating Task Status-Based Event Notifications
Use the Properties Events Notify Roles tab to select the roles to be notified when the event occurs.
Select a predefined notification from the list in the left column to activate a list of available roles. See "Working with Roles" for information about defining roles. Using the directional arrow buttons, move the roles (those groups to whom you want the notification sent) into the Selected Column.
If the notification message will be consumed by an automation plug-in, ensure that you include the role whose credentials are used when running the automation plug-in. See "Working with Automated Tasks" for more information.
Creating Task Status-Based Event Notifications
Use the Properties Events Automation tab to configure an automation plug-in that performs the work or sends data to an external system when the notification is triggered.
| Field | Use |
|---|---|
| Add | Click to open the Add Automation dialog box opens. |
| Name | Enter a name for the automation entry. |
| Action | Select the automation plug-in type from the available list.
Click OK to add the automation entry to the Automation table. |
| Properties | Select any entry in the table and click to define the automation properties.
See "Configuring Automation Plug-In Properties" for information about defining automation properties on the Properties tab. |
Creating Task Status-Based Event Notifications
Use the Event Properties Notes tab to denote the intended use of the event, or any additional information that you want to append to the event configuration.
Creating Task Status-Based Event Notifications
Task status-based event notifications are triggered by rules that evaluate when a task moves to a specific status or exception within a process. For example, you might define a failure status that prompts an evaluation against a rule that, when evaluating to true, generates a notification to your fallout specialist. See "Defining Order Fallout" for more information.
You can define task status-based event notifications using the Properties Events tab in the Process editor. When you create a task status-based event notification, the notification applies to a single task flow or exception path.
To create a task status-based event notification:
From the Process editor, select the flow or exception path to which the event applies.
The Properties tab for the selected transition opens.
Click the Events tab.
Click Add.
The Event wizard is displayed.
In the Name field, enter a name for the task status-based event.
Ensure that the name is unique among the notification entity types. Two notifications cannot share the same name.
In the Rule field, select the rule that must evaluate to true before OSM can trigger this event notification.
The null_rule is the default value for this field. If you do not change the default value, the OSM server will always trigger this notification when the task transitions to the specified status or exception path. See "Defining Order Rules" for more information about setting up new rules.
In the Priority field, select a priority for the notification.
1 is the highest priority. For notifications that are sent to external systems, this field represents the JMS queue priority.
Select Enabled.
Deselect this option if you intend to implement the task status-based event notification at a later time.
Specify whether to send the notification to specific email accounts.
By default, notifications appear in the Notifications page of the Task web client. However, you can specify that notifications be sent to a user's email account by selecting the Email check box. You associate users with email accounts in the Administration area of the Order Management web client. See OSM Order Management Web Client User's Guide for information about configuring email notification properties for user roles.
Click Next.
Select the roles to be notified when the event is triggered.
See "Working with Roles" for more information.
Click Finish.
The event notification is added to the event table.
Select the event.
When you select the event, Design Studio activates the Event subtabs. You can add any undefined elements at any time by using these subtabs. See the following topics for defining the values in the Events subtabs:
Order data changed notifications are triggered by changes to the order data. You can configure order data changed notifications to update external systems (such as CRM) with status updates when a specific data node in the order data is updated with a new value.
Note:
This feature is not available when using releases prior to OSM 7.0.You can create order data changed notifications at the order level from the Order editor Notifications tab.
To create order data changed notifications:
In the Order editor, click the Notifications tab.
Under the Event Notifications column, click Add.
The Event wizard is displayed, where you can select conditions for the notification and the roles to be notified. You can define this information in the wizard, or later by using the Notifications subtabs.
In the Name field, enter a name for the notification.
Ensure that the name is unique among the notification entity types. Two notifications cannot share the same name.
In the Priority field, select a priority for the notification.
1 is the highest priority. For notifications that are sent to external systems, this field represents the JMS queue priority.
Select Enabled.
Deselect this option if you intend to implement the notification at a later time.
Specify whether to send the notification to specific email accounts.
You can specify that notifications be sent to a user's email account by selecting the Email check box. You associate users with email accounts in the Administration area of the OSM Order Management web client application. See OSM Order Management Web Client User's Guide for information about configuring email notification properties for user roles.
Note:
Order data changed notifications are intended to update external systems with status updates when a specific data node in the order data is updated with a new value. The OSM server does not send order data changed event notifications to Task web client Notifications pages. When notifying users, the server sends these notifications to email addresses only.Click Next.
Select the roles to be notified when the notification is triggered.
See "Working with Roles" for more information.
Click Finish.
The notification is added to the order.
You can edit or add any notification attributes at any time by navigating to the Notifications subtabs.
In the Automation column, click Add.
The Add Automation dialog box is displayed, which enables you to create the automation plug-in.
Enter a name for the automation plug-in, select the appropriate Automation Type from the available list, and click OK.
The newly created plug-in is displayed in the Automation column.
Select the automation plug-in.
When you select the automation plug-in, Design Studio displays its Properties tab. Use the subtabs to configure the plug-in. The tabs will vary depending on the type of plug-in selected.
See "Configuring Automation Plug-In Properties" for more information.
For Order data change notifications, if the automation plug-in has an OSM user in the automation plug-in Run As property field with more than one role, click Select from the View field to choose a query task view to use for the automation plug-in. If only one default query task exists in the Order editor Permissions tab, then Design Studio automatically associates it with new automations.
Click the Data Changed subtab.
Click the Add.
The Order Template Node Selection dialog box is displayed.
Select a data node that, when updated with a new value, will trigger the notification.
Click OK.
The data node is added to the Nodes table
Click Save.