Managing System Status and Throughput
Copyright © Oracle Corporation, 2004. All rights reserved.
Objectives
After completing this lesson, you should be able to do the following: • Review Workflow system status information. • Monitor work items in different statuses and purge completed work items. • Run background engines. • Run Workflow control queue cleanup. • Review Business Event System queue propagation and agent activity details.
1-2
Copyright © Oracle Corporation, 2004. All rights reserved.
Workflow System Status
In the Workflow System page of Oracle Workflow Manager: • Select a feature status icon to manage that feature.
– Background Engines – Purge – Control Queue Cleanup
• Monitor system activity using the Workflow Metrics graphs.
– Work Items – Agent Activity
1-3
Copyright © Oracle Corporation, 2004. All rights reserved.
Workflow Status in Oracle Applications Manager
• In Oracle E-Business Suite, you can also use other Oracle Applications Manager features to help manage Oracle Workflow.
– Use Oracle Diagnostics to run diagnostic tests that check the setup of your Oracle Workflow installation and review debugging information. – Use Oracle Applications Logging to review Oracle Workflow logs.
1-4
Copyright © Oracle Corporation, 2004. All rights reserved.
Oracle Workflow Administration
• • • • • •
Work Items Purging Background Engines Control Queue Cleanup Queue Propagation Agent Activity
1-5
Copyright © Oracle Corporation, 2004. All rights reserved.
Work Items
• Drill down from the Work Items graph on the Workflow System Status page to review work items in these statuses:
– – – – Active Deferred Suspended Errored
• The detail pages for these statuses are similar.
1-6
Copyright © Oracle Corporation, 2004. All rights reserved.
Work Items
• Work Items
– Review the number of work items of different item types that are in the selected status. – To drill down, select an item type and choose View Details.
• Work Item Details
– Review the number of work items of the selected item type that are currently at various activity stages within the workflow process. – To drill down, select an activity stage and choose View Details.
1-7
Copyright © Oracle Corporation, 2004. All rights reserved.
Work Items
• Work Item Activity Details
– Review details about work item activities of the selected activity stage within the selected item type. – Use the administrative buttons to manage work items. Depending on the work item status, you can abort, suspend, resume, or retry work items. – Select an activity and choose Launch Workflow Monitor to review the work item in the Status Monitor.
1-8
Copyright © Oracle Corporation, 2004. All rights reserved.
Oracle Workflow Administration
• • • • • •
Work Items Purging Background Engines Control Queue Cleanup Queue Propagation Agent Activity
1-9
Copyright © Oracle Corporation, 2004. All rights reserved.
Purging Workflow Data
• Oracle Workflow tables can grow quite large with obsolete workflow runtime information that is stored for all completed workflow processes. • The size of these tables and indexes can adversely affect performance. • You should purge these tables on a regular basis, using:
– Purging in Oracle Workflow Manager – Purge APIs
1-10
Copyright © Oracle Corporation, 2004. All rights reserved.
Purging Workflow Data
• Oracle Workflow Manager lets you review completed work items to determine what data is available for purging. • To perform purging:
– Oracle E-Business Suite – Submit the Purge Obsolete Workflow Runtime Data concurrent program – Standalone Oracle Workflow – Submit a workflow purge database job
1-11
Copyright © Oracle Corporation, 2004. All rights reserved.
Purging in Oracle E-Business Suite
• In the Workflow System page, select the Work Items link in the Throughput region. • Review the next scheduled and last completed purge requests. • Review completed work items. • To submit a request for the Purge Obsolete Workflow Runtime Data concurrent program:
– Choose the Purge button. – Enter the purge parameters and other concurrent request options.
• To review purge concurrent request details, choose the View Purge Requests button.
1-12 Copyright © Oracle Corporation, 2004. All rights reserved.
Purging in Standalone Oracle Workflow
• In the Workflow System page, select the Work Items link in the Throughput region. • Review completed work items. • Choose View Purge Jobs. • Review existing purge database jobs. • Choose Submit New to submit a new database job.
– Enter the parameters and schedule for the purge. – Choose OK.
1-13
Copyright © Oracle Corporation, 2004. All rights reserved.
Completed Work Items
• Completed Work Items
– Review the number of completed work items of different item types and the number of work items available for purging. – To drill down, select an item type and choose View Details.
• Completed Work Item Details
– Review the number of work items of the selected item type that ended at various activity stages within the workflow process. – To drill down, select an activity stage and choose View Details.
1-14
Copyright © Oracle Corporation, 2004. All rights reserved.
Completed Work Items
• Completed Work Item Activity Details
– Review details about completed work items of the selected item type that ended at the selected activity stage. – Select an activity and choose Launch Workflow Monitor to review the work item in the Status Monitor.
1-15
Copyright © Oracle Corporation, 2004. All rights reserved.
Workflow Purge APIs
• Purge APIs delete obsolete runtime and design data. • The most commonly used WF_PURGE APIs include:
– Items: Purge all runtime data associated with completed items, their processes, and notifications sent by them. – Activities: Purge obsolete design versions of activities that are no longer in use by any item. – Total: Purge both runtime and design data. – Directory: Purge expired users and roles in the Workflow local tables that are not referenced in any notification.
1-16
Copyright © Oracle Corporation, 2004. All rights reserved.
Oracle Workflow Administration
• • • • • •
Work Items Purging Background Engines Control Queue Cleanup Queue Propagation Agent Activity
1-17
Copyright © Oracle Corporation, 2004. All rights reserved.
Background Engines
• Background engines handle:
– Activities deferred by the Workflow Engine – Timed out activities – Stuck processes
• To run a background engine:
– Oracle E-Business Suite – Submit the Workflow Background Process concurrent program – Standalone Oracle Workflow – Submit a background engine database job
1-18
Copyright © Oracle Corporation, 2004. All rights reserved.
Running Background Engines in Oracle E-Business Suite
• To submit a request for the Workflow Background Process concurrent program:
– Choose Background Engine from the Submit Request For pull-down menu in the Workflow System page and choose Go. – Enter the background engine parameters and other concurrent request options.
• To review Workflow Background Process concurrent requests, choose the Background Engine status icon in the Workflow System page.
1-19
Copyright © Oracle Corporation, 2004. All rights reserved.
Running Background Engines in Standalone Oracle Workflow
• In the Workflow System page, select the Background Engines status icon. • Review existing background engine database jobs. • Choose Submit New to submit a new database job.
– Enter the parameters and schedule for the background engine. – Choose OK.
1-20
Copyright © Oracle Corporation, 2004. All rights reserved.
Oracle Workflow Administration
• • • • • •
Work Items Purging Background Engines Control Queue Cleanup Queue Propagation Agent Activity
1-21
Copyright © Oracle Corporation, 2004. All rights reserved.
Control Queue Cleanup
• Oracle Workflow uses the WF_CONTROL queue for internal processing.
– When a middle tier process for Oracle Workflow starts up, it creates a subscriber to the WF_CONTROL queue. – You must periodically clean up the queue by removing inactive subscribers.
• To perform control queue cleanup:
– Oracle E-Business Suite – Submit the Workflow Control Queue Cleanup concurrent program – Standalone Oracle Workflow – Submit a control queue cleanup database job
1-22
Copyright © Oracle Corporation, 2004. All rights reserved.
Running Control Queue Cleanup in Oracle E-Business Suite
• To submit a request for the Workflow Control Queue Cleanup concurrent program:
– Choose Control Queue Cleanup from the Submit Request For pull-down menu in the Workflow System page and choose Go. – Enter the concurrent request options.
• To review Workflow Control Queue Cleanup concurrent requests, choose the Control Queue Cleanup status icon in the Workflow System page.
1-23
Copyright © Oracle Corporation, 2004. All rights reserved.
Running Control Queue Cleanup in Standalone Oracle Workflow
• In the Workflow System page, select the Control Queue Cleanup status icon. • Review existing control queue cleanup database jobs. • Choose Submit New to submit a new database job.
– Enter the schedule for the database job. – Choose OK.
1-24
Copyright © Oracle Corporation, 2004. All rights reserved.
Oracle Workflow Administration
• • • • • •
Work Items Purging Background Engines Control Queue Cleanup Queue Propagation Agent Activity
1-25
Copyright © Oracle Corporation, 2004. All rights reserved.
Queue Propagation
• Review database initialization parameters required for queue propagation. • Review the list of propagation schedules for local outbound agents. • Select a propagation schedule and choose View Details to review detailed information about that schedule.
1-26
Copyright © Oracle Corporation, 2004. All rights reserved.
Oracle Workflow Administration
• • • • • •
Work Items Purging Background Engines Control Queue Cleanup Queue Propagation Agent Activity
1-27
Copyright © Oracle Corporation, 2004. All rights reserved.
Agent Activity
• Review the distribution of event messages with different statuses on different local agents:
– – – – – Ready Waiting Processed Expired Undeliverable
• Select a link in the Agent column to review details about that agent’s queue. • Select an agent and choose the Search Agent Entry Details button to view messages on the agent.
1-28 Copyright © Oracle Corporation, 2004. All rights reserved.
Searching Messages on an Agent
• In the Search Queue page:
– – – – Enter filter criteria to locate the messages you want. Choose the Go button. Review message details. Choose the icon in the View XML column to review the event data for the message as an XML document.
• You can search queues with these payload types:
– WF_EVENT_T – SYS.AQ$_JMS_TEXT_MESSAGE
1-29
Copyright © Oracle Corporation, 2004. All rights reserved.
Summary
In this lesson, you should have learned how to: • Review Workflow system status information. • Monitor work items in different statuses and purge completed work items. • Run background engines. • Run Workflow control queue cleanup. • Review Business Event System queue propagation and agent activity details.
1-30
Copyright © Oracle Corporation, 2004. All rights reserved.