Professional Documents
Culture Documents
OM Exception Mangment
OM Exception Mangment
-1-
Table of Contents
INTRODUCTION ..................................................................................................4
SCOPE .................................................................................................................4
FEATURES ..........................................................................................................4
Visibility of the WorkFlow errors to Functional Users.....................................4
Message Status to keep track of the actions....................................................4
Ability to Retry WF activity from the Window...................................................4
Enhanced WF notification..................................................................................5
Automatic generation of the Diagnostics .........................................................5
SETUP REQUIREMENTS ....................................................................................5
PROFILE OPTION................................................................................................5
EXCEPTION MANAGEMENT FLOW DIAGRAM.................................................6
SIMPLE BUSINESS SCENARIOS .......................................................................6
Flow #1: View Open Messages (Context based) for an Order .......................................6
Flow #2: Find Orders Using Message Status.....................................................................10
Flow #3: Retry the WF Activity in Error From Window..............................................12
Flow #4: Retry WF activity in Error from Notification.........................................14
Flow #5: Review the Diagnostics: OM Order Information .................................20
Flow #6: Adding New Message Statuses .......................................................................23
Flow #7: Adding the OMERROR Flow to the Customized Activity..................24
Flow #8: View Transaction Details from WF Notification ..................................25
TROUBLESHOOTING .......................................................................................27
Diagnostics: OM Order Information is not generated .........................................27
Not able to find Diagnostics: OM Order Information for Order.....................27
Not able to open the message window ........................................................................27
Not able to see the option for Retry Activities in Error.......................................28
Not able to access OMERROR WF for the Flow in Error......................................28
TECHNICAL CONSIDERATIONS......................................................................29
-2-
-3-
INTRODUCTION
With Exception Management feature, you can view and take action on the errors occurring in a particular
workflow (WF) activity. You can use Sales Orders, Order Organizer, Quick Sales Orders and the Quick
Order Organizer for this feature. You can view the errors related to the Order header or Order Line by
using the new action View Open Messages, available from both the right mouse click and Action
button. You can open the Message window and check the status of the Message for that order
header/line. You can take action on these messages and close them. After taking the action for the
messages, you can use the Retry Activities in Error function available in mentioned order windows
(available via the right mouse click and the Action button) as well as workflow notifications to retry the
activity.
SCOPE
This document provides you with details of the major features, the setup required and the dataflow
diagram. Later sections provide troubleshooting steps.
FEATURES
Visibility of the WorkFlow errors to Functional Users
You can use the order windows to query and view the errors that occurred in a particular workflow
activity. These messages are contextual; meaning if you are on a particular order line View Open
Messages will show the open messages for that line only. You can use the following windows to view
open messages
Sales Orders window
Order Organizer
Quick Sales Orders window
Quick Order Organizer
You can use the right mouse click or Action button to access View Open Messages function.
-4-
After correction of the issues recorded in the Message Framework, you can Retry the WF activity. Retry
is also available in Sales Orders window/Organizer and Quick Sales Orders window/Organizer. Retry
action closes all the previous open messages for the activity. This is a protected function, please contact
you system administrator for access.
Enhanced WF notification
You can see the following functional information related to a sales order in WF notification..
Order Number
Order Type
Line Number
Shipment Number
Sales Rep
Operating Unit
Version Number
Flow Status
You can use this information to identify the order or line flow in error. You will also have the link to the
Transaction Detail of the Order Information Portal.
SETUP REQUIREMENTS
You should be on release 11.5.9 of the application or OM family Pack I.
Apply Patch 3731146 to obtain Exception Management functionality.
You should get the privilege to access Retry Activities in Error. Contact your system administrator
for the privilege.
PROFILE OPTION
OM: Generate Diagnostics for Error Activities
This new OM Profile Option OM: Generate Diagnostics for Error Activities is introduced to control
the automatic generation of Diagnostics: OM Order Information concurrent request whenever the
activity is in error. The system administrator should set it at the site level.
It has two settings.
1.
2.
-5-
This existing OM Profile Option OM: Show Process Messages Flag is used to indicate if the system
should display the Open Message checkbox or not. Set the profile value to Yes, to use the indicator
message_exists_flag . The checked value of this field indicates that at least one message exists for the
order.
Is WF
activity in
Error?
Correct Errors
(Functional/System
Errors)
YES
NO
Retry Activity from
Sales Orders
window or WF
notification.
Cool! Proceed
Further.
Query the Order for which you want to see the Open Messages.
2.
3.
Select View Open Messages. It will open the Messages window if there are open messages
associated with that context e.g. if you are on the Line tab and your cursor is at Line# 1, it will show
you messages associated with that line only. If there is no message, in that case a note is shown to
indicate that there is no message associated instead of Message window
Query an
Existing Order
Go to Line Tab
Mouse/Click Right Mouse
or Action button
-6-
Select View
Open Messages
-7-
-8-
-9-
2.
3.
Specify other query criteria (not providing other conditions will cause the query to take a long time
depending upon the data in your system).
4.
Click Find, this will bring all the orders with at least one message in the selected message status in
step 2.
5.
Select message
status for query
Provide other
query criteria.
Press Find.
If you have added new codes for the message status, you can use them in query too. Please check the flow
for Adding New Message Status for more details.
- 10 -
Figure 4: Select Open message status to query the orders with open messages
- 11 -
2.
Select the Header or Line for which you want to retry the activity.
3.
Click the right mouse button or Action button. Select the Retry Activities in Error option.
4.
5.
If activity completes successfully you will get the message for the success otherwise, you will see
the error messages. You should fix those errors and repeat all these steps.
Open Sale
Order/Quick
Sales Order UI
Click Right
Mouse/ Action
button
- 12 -
Select the
Activity to Retry
Figure 6: Use right mouse button and select Retry Activities in Error
- 13 -
2.
3.
4.
A successful retry will close the notification and complete the activity (Check the WF user guide for
the default timeout information for notification).
Using Find
notification, find
the notification
Open the
notification
Confirm the
Order, Line and
Shipment no.
- 14 -
- 15 -
- 16 -
Figure 10: Query on notification of type OM Error. You can use the Order Number in the subject with percent sign(%) as it is
part of the subject.
- 17 -
- 18 -
Figure 12: View the transaction details in notification. Use the Retry button to retry the WF activity.
- 19 -
Make sure that you have profile OM: Generate Diagnostics for Error Activities set to Yes
otherwise this report will not be generated automatically.
2.
Using Flow #1
a.
b. Find the message, which has information of the concurrent request ID.
c.
Use the request ID to query the request using View -> Request menu option.
Open the
Message window
Find the
Concurrent
Request ID
- 20 -
3.
Using Flow #4, you can obtain the request ID of the Diagnostics report.
- 21 -
Figure 14: Notification contains the request ID for the Diagnostics report.
- 22 -
2.
3.
4.
5.
Open Order
Management
QuickCodes
Query
ONT_MESSAG
E_STATUS type
Add new
message Status
- 23 -
Initialize Error => This procedure checks to see if the error flow has the item attribute
WF_ADMINISTRATOR and a value assigned to it. If it does, then it uses
that value to send out a notification. If not then it uses the default value of
SYSADMIN.
2.
Set Entity Descriptor => Sets the values for the message attributes needed for the default
notification.
3.
Submit Concurrent Program => Submits Diagnostics: OM Order Information concurrent request
4.
Update Process Messages => Adds the concurrent request ID to the message stack.
5.
Check if Error Still Active => Check to see if Error is still active
6.
Retry Error Activity => If the activity is still in error, it retries the activity.
- 24 -
To modify the activity to use this error flow, then open the activity in the WF builder and put
OMERROR as the Error Item Type. Save the workflow. The workflow that started after the changed WF
is loaded will use this error flow.
Query the Open Notification for the order (use Flow#4 to find the notification).
2.
3.
- 25 -
Open WF
notification
Click on
Transaction
Detail URL
Figure 19: Notification contains the request ID for the Diagnostics report.
- 26 -
TROUBLESHOOTING
Diagnostics: OM Order Information is not generated
Check the value of the Profile OM: Generate Diagnostics for Error Activities it should be
set to Yes.
- 27 -
- 28 -
TECHNICAL CONSIDERATIONS
Data Purge Issues
Message Purge concurrent program has a new parameter Message Status to restrict the purge
based on the status of the message. If you do not provide any value for message status parameter, it will
purge all the message statuses.
Performance Issues
- 29 -
CONCLUSION
The Oracle Order Management Exception Management feature provides context based message handling
and WF retry capability. Using this feature, you can query, review and take action to resolve the error
associated with the order header and line. You can retry the error activity from window and notification
after the correction of the errors. The ability to automatically launch the Diagnostics: OM Order
Information report; gives you the flexibility to get order information as soon as an error happens. You can
later review this report and send it to support if requested during a TAR resolution.
- 30 -
DEFINITIONS
WF
Workflow
Flow
A Flow is what the application starts for an order or line. A flow starts using a specific
workflow process.
Workflow Process
Workflow SubProcess
A Workflow sub-process is made of workflow activities and/or more workflow subprocesses. A workflow sub-process is not runnable, which means that you cannot
start a flow using it.
The Retry Activities in Error action is different from the existing Progress Order
action. The existing Order Management workflow processes contain eligible states for
most activities (e.g. Schedule Eligible, Invoice Interface Eligible). If such an
activity fails due to an expected error, the workflow goes to the eligible state and the
user can manually select the Progress Order action after taking corrective steps.
However, the new Retry Activities in Error allows the user to retry a particular activity
when the workflow itself is in an error state due to an unexpected error. In other
words, Progress Order applies to activities in the eligible state whereas Retry Activities
in Error refers to activities that are in an error state.
- 31 -
APPENDIX
Appendix 1:
- 32 -
- 33 -