Events and Notifications Framework PeopleBook

Creating Alerts

This chapter discusses how to:

Define PeopleSoft Queries in the Alert Setup Component
Run the Alerts Process

Understanding PeopleSoft Queries Within the Alert Framework

PeopleSoft Query can be used in combination with the Events and Notifications Framework feature to generate alert messages based on data within one or more PeopleSoft tables.

Using PeopleSoft Query, you can scan one or more PeopleSoft tables and then generate an alert message for any problems or stalled transactions. The steps to set up alert notifications based on a PeopleSoft Query are:

Write the PeopleSoft Query.
Use the Notification Registry page to add the new notification. Add the Process Name and Process Category that identifies this specific query/notification. Add a description of the new notification.
Use the Alert Setup component to define the values to be included in the alert message. The message object data is defined by the PeopleSoft Query name, the Process Name, and the Process Category. The Alert Setup component contains the values used to build the notifications to the Notification Dashboard and email.
Enter the Notification Registry page again to enable overrides. You must select the override check boxes. The values used to build the notifications to the PeopleSoft Worklist and XML messages are defined at the System-Level Notifications page or the BU-Level Notifications page.
Use the System-Level Notifications page to define values used to build the notifications to the PeopleSoft Worklist and XML messages. These values determine who should be notified (user role and node) and how they should be notified (worklist and XML notification). These values are applied for the process name and process category combination to the entire PeopleSoft system. If you enter values for email notification, the entries on the Alert Setup component override these values.
Use the BU-Level Notifications page to define values used to build the notifications to the PeopleSoft Worklist and XML messages. These values determine who should be notified (user role and node) and how they should be notified (worklist and XML notification). 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. If you enter values for email notification, the entries on the Alert Setup component override these values.
For XML notifications, 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.
Setup the Alerts process run control to query the PeopleSoft tables on a regular schedule.

Defining PeopleSoft Queries in the Alert Setup Component

When using PeopleSoft Query with the alert framework feature you must setup the Alert Setup component. The values defined on the Alert Setup component are used to build the notifications sent to the Notification Dashboard and to email. The values are defined by the PeopleSoft Query name, the Process Name, and the Process Category. The values include:

The message set and message number.
User IDs and email addresses needed to route the alert message to the correct location.
Links to the PeopleSoft page where the problem can be viewed or resolved.
Consolidation of email notifications.
Frequency and content of notifications.

Pages Used to Define PeopleSoft Queries in the Alert Setup Component

Page Name	Definition Name	Navigation	Usage
Alert Setup	EOEN_ALERT_SETUP	Enterprise Components, Events and Notifications, Alerts, Alert Setup	Enter the alert framework notification methods and recipients of the alert messages when using one or more PeopleSoft Queries with the alert framework feature.
Alert Setup	EOEN_ALERT_SETUP	Select the Messages tab on the Alert Setup page.	Enter search keys for the destination page defined in the link from the alert message.
Alert Setup-Message Parameters	EOEN_ALERT_SETUP	Select the Message tab on the Alert Setup page. Click the Message Parameters link.	Enter the sequence numbers and field names (parameters) for the message set and message number included with the alert notification.

Setting Up the Query & EWN Tab of the Alert Setup Page

Access the Alert Setup-Query & EWN page (Enterprise Components, Events and Notifications, Alerts, Alert Setup).

Active

Select this check box to activate this PeopleSoft query within the notification feature.

Query Name

(required) Specify a query that is defined in the PeopleSoft Query Manager. Insert additional rows to this component to define additional queries to be used for notification.

Query Manager

Select this link to go to the PeopleSoft Query Manager where you can view a PeopleSoft query.

Process Name

(required) Enter or view the process for the notifications. The notification is sent to the user based on the setup for the Process Name and Process Category combination.

Process Category

(required) Enter or view the category for the notifications. The category is a logical partition of the Process Name.

The notification is sent to the user based on the setup for the Process Name and Process Category combination. The Process Category field is blanked out when the Process Name is changed.

Notification Framework

Select this link to access the Notification framework setup pages. If business unit-level setup exists for the Process Name and Process Category combination, then the BU-Level Notifications page is displayed; otherwise the System-Level Notifications page is displayed. If the Process Name is blank or both Process Name and Process Category fields are blank then the Notification Registry page is displayed.

See Setting Up Notifications.

Setting Up the URL Tab of the Alert Setup Page

Access the Alert Setup-URL page (Enterprise Components, Events & Notifications, Alerts, Alert Setup, select the URL tab):

Use the Alert Setup-URL page to provide a link from the notification message to the PeopleSoft page where you can resolve issue.

Query Name	Identifies the query for this notification.
Portal Object Name	Enter a portal object name to define the URL linking the notification message to the transaction page where the user can resolve the issue discovered by the query. This URL is placed on the notification message on the Notification Dashboard page as well as in the email to the user.
Search Keys	Select this link to access the Alert Setup-Search Keys page where you can enter search keys or parameters for the transaction page. An error message is displayed if the Portal Object Name field is blank when trying to launch this secondary page.

Setting Up the Message Tab of the Alert Setup Page

Access the Alert Setup- Message page (Enterprise Components, Events & Notifications, Alerts, Alert Setup, select the Message tab):

Business Unit Field

Specify which field from the query should be used to map the business unit level setup of the notifications. A warning message is issued if this field is blank and the BU-Level Notifications page for this process name/process category is populated. The prompt list for this field is the output fields of the query.

Email/User ID Field

For email notifications, specify which field from the PeopleSoft query has the email address or user ID. If a user ID is entered in this field and you have enabled email notifications, then the email address is derived from the user’s profile. The hierarchy for determining which email address to use is as follows:

The Email/User ID from the Alert Setup- Message page. If none is found, then:

The Email/User ID from the BU-Level Notifications page. If none is found, then:

The Email/User ID from the System-Level Notifications page.

Message Set Number and Message Number

For email notifications, specify which message defined in the PeopleSoft Message Catalog is used in the notification message.

Message Parameters

Select the link to access the Alert Setup-Message Parameters page where you can enter the sequence numbers and field names (parameters) for the message. If the Message Set Number field or the Message Number field is blank then you cannot access the Alert Setup-Message Parameters page and an error message is displayed.

Setting Up the Email Consolidation Tab of the Alert Setup Page

Access the Alert Setup-Email Consolidation page (Enterprise Components, Events & Notifications, Alerts, Alert Setup, select the Email Consolidation tab):

Consolidate Email

Select this check box to consolidate email notifications from this PeopleSoft query. When this check box is selected, each email address receive one consolidated email notification per query. If this check box is not selected, then each email address receives one email per transaction or problem found.

Default Context Record

Select this check box to use the default context record in the notifications. A context record holds transaction-related information. This information can be accessed in the Notification Dashboard page. You can choose to use the default context record or add a user-defined context record.

If this check box is selected the Context Record field becomes display-only and is populated with the default context record name, EOEN_AL_CTX.

If this check box is un-selected, the Context Record field becomes available for input and you can choose a user-defined context record. EOEN_LOG_KEY and EOEN_AL_CTX_SBR subrecords are required for user-defined context records. The prompt list for the Context Record field is the records that have EOEN_LOG_KEY and EOEN_AL_CTX_SBR subrecords.

Setting Up the Frequency & Product Tab of the Alert Setup Page

Access the Alert Setup- Frequency & Product page (Enterprise Components, Events & Notifications, Alerts, Alert Setup, select the Frequency & Product tab):

Notification Interval (hours)

Specify the number of hours between notifications. The Alerts process checks the time interval and the last run date/time stamp to determine whether the notification should be sent.

For example without the notification interval feature if the Alert process is run every hour using a query to check for unpaid invoices and the user cannot resolve the issue within one hour, then a repeat notification is issued for the same unpaid invoices. These repeat notifications on the same problems can crowd up a user's email account. If we add a notification interval of 4 hours and the Alert process is run every hour, then the Alert process checks the last run date/time stamp and only sends the notification if 4 hours have past since the last notification.

Product ID

Identify the PeopleSoft application of the query. This field enables the Alerts process page to run a group of queries for a particular PeopleSoft product.

Running the Alerts Process

This section discusses how to setup the Alerts process page to query the PeopleSoft tables on a regular schedule and generate any necessary alert messages.

Page Used to Run the Alerts Process

Page Name	Definition Name	Navigation	Usage
Alerts	RUN_EOEN_ALERT	Enterprise Components, Events & notifications, Alerts, Run Alerts	Enter the run control parameters for the EOEN_ALERT process. This process generates the alert messages from the PeopleSoft queries.

Setting Up the Alerts Process Page

Access the Alerts process page (Enterprise Components, Events & notifications, Alerts, Run Alerts):

Use the EOEN_ALERT process to run the PeopleSoft queries and generate the alert messages based on these queries.

Query Option	Select the PeopleSoft queries to be run. The options are: Run All Queries: Select to run all PeopleSoft queries defined for the alert notification. When you select this button, the PeopleSoft Product ID field and the Selected Queries group box are disabled. Run Queries for One Product: Select to run the PeopleSoft queries defined for one PeopleSoft application. Selecting this button, enables a PeopleSoft Product ID field to the right where you can select the PeopleSoft applications defined on the Alert Setup component on the Frequency & Product tab. Run Selected Queries: Select to run the PeopleSoft queries defined in the Selected Queries group box at the bottom of this page.
Query Name	Identifies one or more PeopleSoft queries linked to the alert notification. This column is used by the Alerts process if the Run Selected Queries button is selected.
Process Name	Enter the process defined for the PeopleSoft query on the Alert Setup component.
Process Category	Enter the category defined for the PeopleSoft query on the Alert Setup component. The category is a logical partition of the Process Name.

You can view alerts in the Notification Dashboard (select Enterprise Components, Events & Notifications, Notification Framework, Notification Dashboard)

Active	Select this check box to activate this PeopleSoft query within the notification feature.
Query Name	(required) Specify a query that is defined in the PeopleSoft Query Manager. Insert additional rows to this component to define additional queries to be used for notification.
Query Manager	Select this link to go to the PeopleSoft Query Manager where you can view a PeopleSoft query.
Process Name	(required) Enter or view the process for the notifications. The notification is sent to the user based on the setup for the Process Name and Process Category combination.
Process Category	(required) Enter or view the category for the notifications. The category is a logical partition of the Process Name. The notification is sent to the user based on the setup for the Process Name and Process Category combination. The Process Category field is blanked out when the Process Name is changed.
Notification Framework	Select this link to access the Notification framework setup pages. If business unit-level setup exists for the Process Name and Process Category combination, then the BU-Level Notifications page is displayed; otherwise the System-Level Notifications page is displayed. If the Process Name is blank or both Process Name and Process Category fields are blank then the Notification Registry page is displayed. See Setting Up Notifications.

Business Unit Field	Specify which field from the query should be used to map the business unit level setup of the notifications. A warning message is issued if this field is blank and the BU-Level Notifications page for this process name/process category is populated. The prompt list for this field is the output fields of the query.
Email/User ID Field	For email notifications, specify which field from the PeopleSoft query has the email address or user ID. If a user ID is entered in this field and you have enabled email notifications, then the email address is derived from the user’s profile. The hierarchy for determining which email address to use is as follows: The Email/User ID from the Alert Setup- Message page. If none is found, then: The Email/User ID from the BU-Level Notifications page. If none is found, then: The Email/User ID from the System-Level Notifications page.
Message Set Number and Message Number	For email notifications, specify which message defined in the PeopleSoft Message Catalog is used in the notification message.
Message Parameters	Select the link to access the Alert Setup-Message Parameters page where you can enter the sequence numbers and field names (parameters) for the message. If the Message Set Number field or the Message Number field is blank then you cannot access the Alert Setup-Message Parameters page and an error message is displayed.