Events and Notifications Framework PeopleBook

Setting Up Notifications

This chapter provides an overview of Notification setup and discusses how to:

Set up the notification registry and notification override pages.
Set up notifications using XML messages.
Use the pre-defined notifications.
Modify PeopleSoft processes to create notifications.

Understanding Notification Setup

The Notification setup steps are:

Use the Notification Registry page to identify the notifications to be used and to enable any overrides at the system or business unit levels. In addition, the Notification Registry page can create custom actions or allow a pre-processing user exit.
Use the System-Level Notifications page to override information from the message that determines who should be notified (user, user role, email address, or node) and how they should be notified (worklist, email, or XML notification). You can also disable worklist, email, or XML notifications. These overrides are applied for the process name and process category combination to the entire PeopleSoft system.
Use the BU-Level Notifications page to override information from the message that determines who should be notified (user, user role, email address, or node) and how they should be notified (worklist, email, or XML notification). You can also disable worklist, email, or XML notifications for a specific business unit. These overrides are applied for the process name, process category, and business unit combination. Values at the business unit level override any system-level overrides.
Setup and activate the EOEN Notify Message to enable the PeopleSoft Integration Broker to send a message to a third-party system using a XML-formatted messages.

Additional steps are necessary if you are modifying a PeopleSoft process to generate new messages or are using PeopleSoft Query to monitor PeopleSoft tables.

Understanding System and Business Unit Level Overrides

A notification message includes values used to build the message, such as:

Where to log the message (any combination of the Notification Dashboard, PeopleSoft Worklist, email, and XML notification).
A message set and message number. (optional)
User roles, user IDs, email addresses, or PeopleSoft nodes needed to route the notification message to the correct location.
Links to the PeopleSoft page where the transaction can be viewed or corrected.

The values are obtained from the PeopleSoft process generating the notification or in the case of Alerts from the Alert Setup component, BU-Level Notifications page, and System-Level Notifications page.

For notifications that are not Alerts, you can override the values from the initial PeopleSoft process in order to accommodate a temporary change or permanently provide more specific values using:

System-Level Notifications page.
BU-Level Notifications page.

System-level notifications are defined by the process name and the category and enable you to override the notification for the entire system. For example, if Bob receives all of the notifications for the OM_PEGGING / RECEIPT process and he goes on an extended vacation, you can set up an override at the system level to route all of these specific messages to Steve.

Business unit-level notifications are defined by the process name, the category, and the business unit and enable you to override the notification at the business unit level. For example, if the notifications for the OM_PEGGING / RECEIPT process need to be specific to the inventory warehouse, you can set up an override at the business unit level to route all of the messages for business unit US001 to Steve and to route all of the messages for business unit US008 to Ralph.

When you set up system and business unit level notification overrides, you determine who should be notified when a notification occurs and how they should be notified. As with most default hierarchies in the PeopleSoft system, the more specific information overrides the more general information. In this case, if values are defined at both levels for the same process name and category, then the values defined at the business unit level (BU-Level Notifications page) override the values defined at the system-level (System-Level Notification page).

Setting Up the Notification Registry and Override Pages

This section discusses how to:

Setup the Notification Registry page.
Setup the System-Level Notifications Override page.
Setup the BU-Level Notifications Override page.

Pages Used to Set Up the Notification Registry and Registry Notification Pages

Page Name	Definition Name	Navigation	Usage
Notification Registry	EOEN_NTF_REGISTRY	Enterprise Components, Events & Notifications, Notifications Framework, Notifications Registry	Set up the notification registry to identify the notifications to be used and to enable any overrides at the system or business unit levels. In addition, the Notification Registry page can create custom actions or allow a pre-processing user exit.
System-Level Notifications Override	EOEN_NTF_REG_SYS	Enterprise Components, Events & Notifications, Notifications Framework, Notifications System Overrides	Set up system-level notifications, which define overrides at the system level for each process name and process category.
BU-Level Notifications Override	EOEN_NTF_REG_BU	Enterprise Components, Events & Notifications, Notifications Framework, Notifications BU Overrides	Set up business unit level notifications, which define overrides at the business unit level for each process name, process category, and business unit.

Setting Up the Notification Registry

Access the Notification Registry page (Enterprise Components, Events & Notifications, Notifications Framework, Notifications Registry).

The notification registry contains all delivered processes and categories. If you have customized your system with additional processes and categories, you must add them to the Notification Registry page.

Process Name

Enter or view the process using notifications. This field can contain an application batch or online process. For Alert notifications, a user-defined value is entered in this field.

Process Category

Enter or view the category. The category is a logical partition of the Process Name.

For PeopleSoft processes, the category names are defined when the process is developed. For example, when the Reservation process runs, multiple messages are related to item ID. All of these item ID-type messages are grouped into one category so that one user can be notified when a message occurs. For each delivered process, the PeopleSoft system has categories that are delivered with the PeopleSoft product.

Description

Enter or view the extended description for this notification message by process name and category combination.

Allow Users to Override

Select the appropriate check boxes Worklist Notifications, Email Notifications, and XML Notifications to enable overrides at the system and business unit levels for this notification message. If you do not allow overrides then the notification method and destinations contained in the notification will always be used. If there are no notification methods or destinations in the notification then the notification dashboard will be the only way to view the notification

Enable Custom Action

For PeopleSoft processes, select Enable Custom Action, to enable a customized action. Use this option if you have written your own application class for a customized action. Enter the Application Class Path and Application Class ID fields, which are extensions of the EOEN_MVC:MODEL:EOEN_PostProcessingUserExit class.

Pre-Processing User Exit

For PeopleSoft processes, enter the Application Class Path and Application Class ID fields. A preprocessing user exit tells the system to run another process before it determines who to notify. For example, a purchase order approval process is created that is based on the purchase order value. Purchase orders under 500.00 USD are approved by the department manager, and purchase orders over 500.01 USD are approved by the department director. The preprocessing user exit tells the system to run the purchase order approval process before determining who to notify. The preprocessing user exits are extensions of the EOEN_MVC:MODEL:EOEN__PreProcessingUserExit class.

Setting Up Registry Notifications at the System Level

Access the System-Level Notifications page (Enterprise Components, Events & Notifications, Notifications Framework, Notifications System Overrides).

The Override Notification sections of this page are determined by the options selected on the Notification Registry page.

Disable All Notifications	Select to disable all notifications for this message. Note. Notifications will still be posted to the Notification Dashboard.
Disable Worklist Notification	Select to disable only worklist notifications for this message.
Role and User ID	Select a role or a user ID for the worklist notification. This determines the person to notify for this message. Note. If the Worklist Notifications check box is selected on the Notification Registry page and the Role field or the User ID field are blank on the System-Level Notifications page and the BU-Level Notifications page, then the worklist notification for the original message object (either User ID or Role) is used.
Disable Email Notification	Select to disable only email notifications for this message.
Email Option	Select Address or UserID for the email notification. Depending on which option you select, the field to the right will change to Email Address or User ID. You may add multiple rows if needed. Note. If the Email Notifications check box is selected on the Notification Registry page and you do not enter an Email Address on the System-Level Notifications page or the BU-Level Notifications page, then the Email Address notification for the original message object is used.
Disable XML Notification	Select to disable only XML notifications for this message.
Node	Select the node name for the XML notification. Note. If the XML Notifications check box is selected on the Notification Registry page and you do not enter a Node on the System-Level Notifications page or the BU-Level Notifications page, then the XML notification (node) for the original message object is used.

Note. The delivered notifications contained in some PeopleSoft processes are controlled by the owner of the transaction. For example, notification messages for pegging purchase orders goes to the buyer on the purchase order. Therefore, overriding notifications at the business unit level or system level is not enabled.

Setting Up Registry Notifications at the Business Unit Level

Access the BU-Level Notifications page (Enterprise Components, Events & Notifications, Notifications Framework, Notifications BU Overrides).

The BU-Level Notifications page operates exactly like the System-Level Notifications page except that it enables you to specify a business unit as a key for notifications. Values defined at the business unit level (BU-Level Notifications page) override the same values defined at the system-level (System-Level Notification page).

Setting Up Notifications Using XML Messages

The Notify Message enables the PeopleSoft Integration Broker to send a message to a third-party system using a XML-formatted messages. The notification framework can publish an outbound message using the Notify Message (EOEN_NOTIFY_MSG) service operation to notify an external system that an error or warning has occurred in the PeopleSoft system.

Setting Up the Notify Message

PeopleSoft delivers the service operation EOEN_NOTIFY_MSG with a default status of Inactive. You must activate each service operation before attempting to send or receive data from a third-party source or another PeopleSoft system, such as CRM.

Using the Pre-Defined Notifications

Several PeopleSoft processes are delivered with the ability to produce notification messages. These notifications are displayed on the Notification Registry page.

Use the Notification Registry page, BU-Level Notifications page, and System-Level Notifications page to customize who should be notified (user, user role, email address, or node) and how they should be notified (worklist, email, XML notification, or custom action).

Some PeopleSoft applications deliver processes with pre-defined coding to generate notification messages, refer to the specific application documentation for a list of delivered processes and categories in the Notification Registry.

Modifying PeopleSoft Processes to Create Notifications

This section discusses how to modify PeopleSoft processes to generate notifications. Not all PeopleSoft processes are delivered with the ability to produce notifications. Your IT department can alter a batch and online process to generate notifications based on your needs.

Once you have added a new process name and process category to the Notification Registry page, you can customize a PeopleSoft process to send notifications.

Follow these steps to add to the notification registry:

Add your process name and category to the Notification Registry page.
1. Add the description and long text description, which describes the functionality of the message that is logged into the registry so that you can assign the appropriate user to the notification classification.
2. Disable any notification feature that your application does not allow you to override at the system and business unit levels.
  
  These notifications are handled within the object interface directly.
Create a message context record to pass all transactional data through the message framework.
1. All context records must include the EOEN_LOG_KEY subrecord.
2. Any additional transactional fields can be added to the context record.
Implement the EOEN interface object within your application process by using the EOEN_MVC:EOEN_MODEL.EOEN_INTERFACE class.