Understanding Batch Error NotificationThis chapter discusses how to:
Create static error notification lists.
Run batch error notifications.
Understanding Batch Error NotificationAlthough you can easily use the Service Operations Monitor to scan your system for service operations, that approach requires you to launch the Service Operations Monitor on a scheduled basis to search for any issues affecting the messaging system. The Error Notification component (PT_ERR_RUNCNTL) provides access to an Application Engine batch program, PT_AMM_WF, that you can schedule to run on a recurring basis.
The PT_AMM_WF process is designed notify users to report on service operations which are in Error or Timeout status in the Service Operation Monitor.
The PT_AMM_WF process reports errors and timeout issues one time. The expectation is that after issues are reported, that they are resolved. During subsequent runs of the process, the system reports only new issues found, and does not report previous issues that may still be unresolved.
Note. You can use PT_AMM_WF to notify users of errors relating to asynchronous service operations only.
To access the program, select PeopleTools, Integration Broker, Monitor Integrations, Error Notification.
The following table describes the information for which PT_AMM_WF scans, how it notifies administrators, and what administrators should do after receiving an error notification.
|
Step |
Task |
Description |
|
1 |
Query Message Queues |
The program scans the following messaging queues in the database in search of service operation with a status of either Error or Timeout.
|
|
2 |
Trigger Workflow |
Upon encountering a service operation status of either Error or Timeout, PT_AMM_WF sends a workflow to all users assigned to the APP_MSG_ADMINISTRATOR role at runtime. The query for this role associates a service operation with a user through the service operation’s queue name property. All users that have at least read-access to the service operation queue are notified. |
|
3 |
Resolve Issue |
Administrators also receive a new worklist item reflecting the problematic service operation. To access the service operation, an administrator clicks the item in the worklist. The link leads to the Asynchronous Details component. The component is presented with the specified service operation loaded. |
Prerequisites for Using Batch Error NotificationTo enable the workflow notification functionality, you need to have the following items in place within security definitions:
Grant access to the PT_AMM_DUMMY component interface. Navigate to PeopleTools, Security, Permissions & Roles, Permission Lists, Component Interfaces.
Assign users to the APP_MSG_ADMINISTRATOR role using PeopleTools, Security, Permissions & Roles, Roles, Members.
PeopleSoft delivers the APP_MSG_ADMINISTRATOR role.
Add email addresses for users assigned to the APP_MSG_ADMINISTRATOR role to their user profiles so that they can receive the notification.
To complete this task, select PeopleTools, Security, User Profiles, User Profiles, Edit Email Addresses
Grant users read-only access (at a minimum) to the service operation queue.
In addition you must set several PeopleSoft Workflow default options using the Set Worklist Defaults page (WF_SYS_DEFAULTS). Note that after you set these options you must reboot the application server.
To set the workflow default options for using batch error notification:
Access the Set Worklist Defaults page (select PeopleTools, Workflow, Defaults & Messages, Set Worklist Defaults).
In the System Default User section, select the system User ID.
In the System Wide Route Processing section, select the Email Active box.
Click the Save button.
Restart the application server.
See Also
Setting Workflow System Defaults
Creating Static Error Notification ListsBy default, error notifications are sent to all users who can monitor the service operation queue; these are users assigned to the Query role. However, you can send error notifications to a static list of users that belong to the APP_MSG_ADMINISTRATOR role. To do so you must turn off the Use Query to Route Workflow option for the APP_MSG_ADMINISTRATOR role, and assign specific users to the role.
To view users assigned to the APP_MSGADMINISTRATOR role, run the _ROLE_APP_MSG_ADMINISTRATOR query.
To create a static error notification list:
Turn off the User Query to Route Workflow option.
Select PeopleTools, Security, Permissions & Roles, Roles.
Select and open the APP_MSG_ADMINISTRATOR role.
Click the Workflow tab.
In the Workflow Routing Options box, clear the Use Query to Route Workflow option, and click Save.
Assign specific users to the APP_MSG_ADMINISTRATOR role.
Running Batch Error NotificationsYou use the Error Notification page (PT_ERR_RUNCNTL) to run the PT_AMM_WF process. To access the page, select PeopleTools, Integration Broker, Monitor Integrations, Error Notification.
To run PT_AMM_WF:
Select PeopleTools, Integration Broker, Monitor Integrations, Error Notification.
Select an existing run control ID, or add a new one using the Add button.
The Error Notification page appears.
Select a process frequency.
Options are:
Process Once. Select to run PT_AMM_WF manually.
Process Always. Select to run PT_AMM_WF constantly.
Don't Run. Select to disable a recurring PT_AMM_WF run.
Add a request ID and description.
These attributes uniquely identify a run control. You only see the IDs when you have a list of run controls.
In the URL field, enter the PeopleSoft Pure Internet Architecture URL to provide in the email error notification. Users use the URL to link to the error.
The URL of the current web server displays in this field by default.
ClickRun.
Click OK on the Process Scheduler Request page to submit the process.