11i/2.6 Implement Oracle Workflow: D13939GC30 Edition 3.0 December 2004 D4013 4

Download as pdf or txt
Download as pdf or txt
You are on page 1of 20

11i/2.

6 Implement Oracle
Workflow
Student Guide

D13939GC30
Edition 3.0
December 2004
D40134

Copyright Oracle Corporation, 2004. All rights reserved.


This documentation contains proprietary information of Oracle Corporation. It is provided under a license agreement containing
restrictions on use and disclosure and is also protected by copyright law. Reverse engineering of the software is prohibited. If this
documentation is delivered to a U.S. Government Agency of the Department of Defense, then it is delivered with Restricted Rights
and the following legend is applicable:
Restricted Rights Legend
Use, duplication or disclosure by the Government is subject to restrictions for commercial computer software and shall be deemed
to be Restricted Rights software under Federal law, as set forth in subparagraph (c)(1)(ii) of DFARS 252.227-7013, Rights in
Technical Data and Computer Software (October 1988).
This material or any portion of it may not be copied in any form or by any means without the express prior written permission of the
Education Products group of Oracle Corporation. Any other copying is a violation of copyright law and may result in civil and/or
criminal penalties.
If this documentation is delivered to a U.S. Government Agency not within the Department of Defense, then it is delivered with
Restricted Rights, as defined in FAR 52.227-14, Rights in Data-General, including Alternate III (June 1987).
The information in this document is subject to change without notice. If you find any problems in the documentation, please report
them in writing to Worldwide Education Services, Oracle Corporation, 500 Oracle Parkway, Box SB-6, Redwood Shores, CA 94065.
Oracle Corporation does not warrant that this document is error-free.
Oracle and all references to Oracle Products are trademarks or registered trademarks of Oracle Corporation.
All other products or company names are used for identification purposes only, and may be trademarks of their respective owners.

Author
Clara Jaeckel
Technical Contributors and Reviewers
Mark Craig, Leta Davis, Vasudeva Murthy, Rajesh Raheja, Varadarajan Rajaram, Bill Sawyer,
Vincent Thevenet, Robert Wunderlich
This book was published using:

oracletutor

Table of Contents
Introduction to Oracle Workflow ..................................................................................................................1-1
Introduction to Oracle Workflow ..................................................................................................................1-2
Objectives ......................................................................................................................................................1-3
Enabling E-Business......................................................................................................................................1-4
Inter-Enterprise Business Processes ..............................................................................................................1-5
Traditional Workflow ....................................................................................................................................1-6
Workflow-Driven Business Processes...........................................................................................................1-7
Sample Workflow Process.............................................................................................................................1-9
Event-Based Workflow .................................................................................................................................1-10
Subscription-Based Processing......................................................................................................................1-11
System Integration with Oracle Workflow ....................................................................................................1-12
Business Process-Based Integration ..............................................................................................................1-13
Supported System Integration Types.............................................................................................................1-14
Designing Applications for Change...............................................................................................................1-15
Designing Applications for Integration .........................................................................................................1-18
Oracle Workflow Availability .......................................................................................................................1-20
Summary........................................................................................................................................................1-21
Oracle Workflow Components.......................................................................................................................2-1
Oracle Workflow Components ......................................................................................................................2-2
Objectives ......................................................................................................................................................2-3
Oracle Workflow Architecture ......................................................................................................................2-4
Oracle Workflow Components ......................................................................................................................2-8
Workflow Engine ..........................................................................................................................................2-9
Workflow Processes ......................................................................................................................................2-10
Supported Process Constructs........................................................................................................................2-12
Oracle Workflow Builder ..............................................................................................................................2-16
Business Event System Architecture .............................................................................................................2-17
Business Event System Components.............................................................................................................2-18
Guided Demonstration - Business Event System Web Pages....................................................................2-19
OracleAS Communication Alternatives ........................................................................................................2-20
Advanced Queuing, an Enabling Technology ...............................................................................................2-21
Oracle Database Communication Alternatives..............................................................................................2-22
Accessing Oracle Workflow Web Pages .......................................................................................................2-24
Oracle Workflow Home Pages ......................................................................................................................2-25
Notification System .......................................................................................................................................2-26
Worklist Web Pages ......................................................................................................................................2-27
E-Mail Notifications ......................................................................................................................................2-28
Directory Services .........................................................................................................................................2-29
Workflow Monitor Web Pages......................................................................................................................2-30
Workflow Definitions Loader........................................................................................................................2-31
Workflow XML Loader.................................................................................................................................2-32
Workflow Manager........................................................................................................................................2-33
Service Components ......................................................................................................................................2-34
Guided Demonstration - Loading and Running a Workflow Process........................................................2-35
Oracle Workflow Documentation..................................................................................................................2-37
Review Questions ..........................................................................................................................................2-39
Summary........................................................................................................................................................2-41
Planning a Workflow Process.........................................................................................................................3-1
Planning a Workflow Process........................................................................................................................3-2
Objectives ......................................................................................................................................................3-3
Workflow Process Components ....................................................................................................................3-4
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


i

Oracle Workflow Builder ..............................................................................................................................3-6


Standard Activities ........................................................................................................................................3-7
Planning a Workflow Process........................................................................................................................3-9
Activity Results and Lookup Types...............................................................................................................3-11
Practice - Planning a Workflow Process....................................................................................................3-13
Solution - Planning a Workflow Process ...................................................................................................3-14
Summary........................................................................................................................................................3-15
Diagramming a Workflow Process ................................................................................................................4-1
Diagramming a Workflow Process................................................................................................................4-2
Objectives ......................................................................................................................................................4-3
Creating a New Workflow Process................................................................................................................4-4
Creating a New Process from Top Down ......................................................................................................4-5
Creating a New Process from Bottom Up .....................................................................................................4-6
Diagramming a Process .................................................................................................................................4-7
Quick Start Wizard ........................................................................................................................................4-8
Defining an Item Type...................................................................................................................................4-11
Defining a Process Activity ...........................................................................................................................4-13
Diagramming a Process .................................................................................................................................4-15
Top-Down Design .........................................................................................................................................4-16
Diagramming a Process .................................................................................................................................4-17
<Default> Transition .....................................................................................................................................4-18
<Any> Transition ..........................................................................................................................................4-19
Editing a Transition .......................................................................................................................................4-20
Self-Looping Transitions ...............................................................................................................................4-22
Customizing an Activity Node ......................................................................................................................4-23
Show Label in Designer Menu Options.........................................................................................................4-25
Display Modes...............................................................................................................................................4-26
Verifying a Process Definition ......................................................................................................................4-27
Validation Performed by the Verify Command.............................................................................................4-28
Saving Process Definitions ............................................................................................................................4-30
Reviewing Process Definitions in Standalone Oracle Workflow ..................................................................4-31
Practice - Creating a Workflow Process ....................................................................................................4-33
Solution - Creating a Workflow Process ...................................................................................................4-34
Summary........................................................................................................................................................4-36
Defining Item Type Attributes and Lookup Types.......................................................................................5-1
Defining Item Type Attributes and Lookup Types........................................................................................5-2
Objectives ......................................................................................................................................................5-3
Defining Item Type Attributes.......................................................................................................................5-4
Attribute Data Types .....................................................................................................................................5-6
Defining Item Type Attributes.......................................................................................................................5-8
URL Attributes ..............................................................................................................................................5-9
Form Attributes .............................................................................................................................................5-13
Document Attributes......................................................................................................................................5-16
Deleting Item Attributes ................................................................................................................................5-19
Defining Lookup Types.................................................................................................................................5-20
Defining Lookup Codes.................................................................................................................................5-21
Practice - Defining Item Type Attributes...................................................................................................5-22
Solution - Defining Item Type Attributes..................................................................................................5-23
Summary........................................................................................................................................................5-26
Defining Messages and Notification Activities ..............................................................................................6-1
Defining Messages and Notification Activities .............................................................................................6-2
Objectives ......................................................................................................................................................6-3
Notification Activities ...................................................................................................................................6-4
Defining a Message .......................................................................................................................................6-5
Defining a Message Attribute........................................................................................................................6-8
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


ii

Defining a Respond Attribute........................................................................................................................6-10


Notification Details Web Page ......................................................................................................................6-11
HTML E-mail Notifications ..........................................................................................................................6-12
Plain Text E-mail Notifications Using Templated Response ........................................................................6-13
Plain Text E-mail Notifications Using Direct Response ...............................................................................6-14
Practice - Defining Messages ....................................................................................................................6-15
Solution - Defining Messages....................................................................................................................6-16
Defining a Notification Activity....................................................................................................................6-18
Standard Voting Activity...............................................................................................................................6-20
Defining a Notification Activity Node ..........................................................................................................6-21
Defining a Timeout for a Notification ...........................................................................................................6-22
Defining a Dynamic Priority for a Notification.............................................................................................6-23
Defining a Performer for a Notification ........................................................................................................6-24
Embedding Oracle Applications Framework Regions in Notifications.........................................................6-25
Special Message Function .............................................................................................................................6-27
Action History ...............................................................................................................................................6-29
Special Message Attributes............................................................................................................................6-30
Practice - Defining Notification Activities ................................................................................................6-39
Solution - Defining Notification Activities................................................................................................6-40
Summary........................................................................................................................................................6-42
Testing and Monitoring Workflow Processes ...............................................................................................7-1
Testing and Monitoring Workflow Processes................................................................................................7-2
Objectives ......................................................................................................................................................7-3
Testing Workflow Processes .........................................................................................................................7-4
Testing Processes in Oracle E-Business Suite ...............................................................................................7-5
Testing Processes in Standalone Oracle Workflow .......................................................................................7-7
Administrator Monitor in Oracle E-Business Suite .......................................................................................7-8
Viewing Workflows in the Administrator Monitor .......................................................................................7-9
Viewing Activity History in the Administrator Monitor ...............................................................................7-11
Viewing a Status Diagram in the Administrator Monitor..............................................................................7-12
Viewing Participant Responses in the Administrator Monitor ......................................................................7-14
Viewing Workflow Details in the Administrator Monitor.............................................................................7-15
Viewing Error Information in the Administrator Monitor.............................................................................7-16
Viewing Child Workflows in the Administrator Monitor .............................................................................7-17
Self-Service Monitor in Oracle E-Business Suite..........................................................................................7-18
Viewing Workflows in the Self-Service Monitor..........................................................................................7-19
Viewing Notification History in the Self-Service Monitor............................................................................7-21
Viewing a Status Diagram in the Self-Service Monitor ................................................................................7-22
Viewing Participant Responses in the Self-Service Monitor.........................................................................7-24
Viewing Error Information in the Self-Service Monitor ...............................................................................7-25
Workflow Monitor in Standalone Oracle Workflow .....................................................................................7-26
Accessing Processes in the Workflow Monitor .............................................................................................7-27
Reviewing the Process List............................................................................................................................7-29
Reviewing the Notifications List ...................................................................................................................7-30
Filtering Activities in the Activities List .......................................................................................................7-31
Workflow Monitor Process Diagram.............................................................................................................7-33
Workflow Monitor Detail Tabs .....................................................................................................................7-35
Workflow Monitor Administration Buttons ..................................................................................................7-36
Summary........................................................................................................................................................7-37
Viewing and Responding to Notifications......................................................................................................8-1
Viewing and Responding to Notifications.....................................................................................................8-2
Objectives ......................................................................................................................................................8-3
Viewing Notifications from a Web Browser .................................................................................................8-4
Worklist Pages in Oracle E-Business Suite ...................................................................................................8-5
Advanced Worklist in Oracle E-Business Suite ............................................................................................8-6
Notification Details in Oracle E-Business Suite ............................................................................................8-8
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


iii

Reassigning Notifications in Oracle E-Business Suite ..................................................................................8-11


Requesting More Information in Oracle E-Business Suite............................................................................8-13
Certificate-Based Digital Signatures in Oracle E-Business Suite..................................................................8-14
Granting Worklist Access in Oracle E-Business Suite ..................................................................................8-16
Administrator Search for Notifications in Oracle E-Business Suite..............................................................8-19
Personal Worklist in Oracle E-Business Suite...............................................................................................8-21
Simple Search for Notifications in Oracle E-Business Suite .........................................................................8-23
Advanced Search for Notifications in Oracle E-Business Suite ....................................................................8-24
Creating a Personal Worklist View in Oracle E-Business Suite....................................................................8-26
Notifications Worklist in Standalone Oracle Workflow................................................................................8-28
Finding Notifications in Standalone Oracle Workflow .................................................................................8-29
Notification Details in Standalone Oracle Workflow ....................................................................................8-30
Reassigning Notifications in Standalone Oracle Workflow ..........................................................................8-31
Practice - Running a Workflow Process ....................................................................................................8-32
Solution - Running a Workflow Process ...................................................................................................8-34
Viewing Notifications through E-mail ..........................................................................................................8-36
E-mail Response Methods .............................................................................................................................8-38
HTML-Formatted E-mail Notifications.........................................................................................................8-39
Plain Text E-mail Notifications Using Templated Response ........................................................................8-41
Plain Text E-mail Notifications Using Direct Response ...............................................................................8-42
Viewing an E-mail Summary of Notifications ..............................................................................................8-43
Automatic Notification Processing................................................................................................................8-44
Maintaining Vacation Rules in Oracle E-Business Suite...............................................................................8-45
Defining Vacation Rules in Oracle E-Business Suite....................................................................................8-46
Maintaining Notification Rules in Standalone Oracle Workflow..................................................................8-49
Defining Notification Rules in Standalone Oracle Workflow .......................................................................8-50
Practice - Modifying a Workflow Process.................................................................................................8-52
Solution - Modifying a Workflow Process ................................................................................................8-54
Summary........................................................................................................................................................8-57
Oracle Workflow Directory Service...............................................................................................................9-1
Oracle Workflow Directory Service ..............................................................................................................9-2
Objectives ......................................................................................................................................................9-3
Oracle Workflow Directory Service ..............................................................................................................9-4
Predefined Directory Services .......................................................................................................................9-5
Directory Service Views................................................................................................................................9-6
WF_USERS View .........................................................................................................................................9-7
WF_ROLES View.........................................................................................................................................9-10
WF_USER_ROLES View.............................................................................................................................9-12
WF_USER_ROLE_ASSIGNMENTS_V View ............................................................................................9-15
Local Directory Service Tables .....................................................................................................................9-17
Local Directory Service Tables in Oracle E-Business Suite..........................................................................9-18
Local Directory Service Tables in Standalone Oracle Workflow..................................................................9-19
Ad Hoc Users and Roles................................................................................................................................9-20
Validating a Directory Service Data Model...................................................................................................9-21
Setting Workflow Preferences.......................................................................................................................9-22
Loading Roles................................................................................................................................................9-23
Summary........................................................................................................................................................9-24
Defining Function Activities ...........................................................................................................................10-1
Defining Function Activities .........................................................................................................................10-2
Objectives ......................................................................................................................................................10-3
Function Activities ........................................................................................................................................10-4
Defining a Function Activity .........................................................................................................................10-5
Practice - Defining a Function Activity .....................................................................................................10-7
Solution - Defining a Function Activity ....................................................................................................10-9
External Function Activities ..........................................................................................................................10-12
External Java Function Activities ..................................................................................................................10-14
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


iv

Assigning a Cost to a Function Activity........................................................................................................10-15


Practice - Branching on a Function Activity Result ..................................................................................10-16
Solution - Branching on a Function Activity Result..................................................................................10-18
Defining Activity Details...............................................................................................................................10-21
Looping .........................................................................................................................................................10-23
Error Handling...............................................................................................................................................10-24
Defining an Activity Attribute.......................................................................................................................10-25
Setting Activity Attribute Values ..................................................................................................................10-26
Practice - Using the Standard Assign Activity...........................................................................................10-27
Solution - Using the Standard Assign Activity..........................................................................................10-29
Summary........................................................................................................................................................10-35
Business Events ................................................................................................................................................11-1
Business Events .............................................................................................................................................11-2
Objectives ......................................................................................................................................................11-3
Business Events .............................................................................................................................................11-4
Event Properties.............................................................................................................................................11-5
Generate Functions ........................................................................................................................................11-7
License Status for Events ..............................................................................................................................11-9
Defining an Event in Oracle E-Business Suite ..............................................................................................11-10
Defining an Event in Standalone Oracle Workflow ......................................................................................11-11
Event Groups .................................................................................................................................................11-12
Defining an Event Group in Oracle E-Business Suite ...................................................................................11-13
Defining an Event Group in Standalone Oracle Workflow ...........................................................................11-14
Maintaining Events in Oracle E-Business Suite ............................................................................................11-15
Maintaining Events in Standalone Oracle Workflow ....................................................................................11-17
Practice - Defining an Event......................................................................................................................11-19
Solution - Defining an Event .....................................................................................................................11-20
Raising Events ...............................................................................................................................................11-22
Event Message Structure ...............................................................................................................................11-24
Raising an Event Manually in Oracle E-Business Suite ................................................................................11-25
Raising an Event Manually in Standalone Oracle Workflow ........................................................................11-26
Practice - Raising an Event........................................................................................................................11-27
Solution - Raising an Event .......................................................................................................................11-28
Predefined Events ..........................................................................................................................................11-30
Summary........................................................................................................................................................11-31
Event Subscriptions.........................................................................................................................................12-1
Event Subscriptions .......................................................................................................................................12-2
Objectives ......................................................................................................................................................12-3
Event Subscriptions .......................................................................................................................................12-4
Event Manager Subscription Processing .......................................................................................................12-5
Local Event Subscription Processing ............................................................................................................12-6
External Event Subscription Processing ........................................................................................................12-8
Subscription Properties..................................................................................................................................12-9
Subscription Actions......................................................................................................................................12-13
Subscription Actions: Sending an Event to a Workflow Process ..................................................................12-14
Subscription Actions: Sending an Event to an Agent....................................................................................12-16
Subscription Actions: Sending a Notification................................................................................................12-18
Subscription Actions: Sending and Receiving Oracle XML Gateway Messages..........................................12-20
Subscription Actions: Running a Custom Rule Function ..............................................................................12-21
Subscription Properties..................................................................................................................................12-24
License Status for Subscriptions....................................................................................................................12-25
Deferred Subscription Processing..................................................................................................................12-26
PL/SQL and Java Subscription Processing....................................................................................................12-28
Defining a Subscription in Oracle E-Business Suite .....................................................................................12-30
Defining a Subscription in Standalone Oracle Workflow .............................................................................12-32
Maintaining Subscriptions in Oracle E-Business Suite .................................................................................12-34
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


v

Maintaining Subscriptions in Standalone Oracle Workflow .........................................................................12-35


Predefined Subscriptions ...............................................................................................................................12-37
Practice - Defining a Subscription .............................................................................................................12-38
Solution - Defining a Subscription ............................................................................................................12-40
Summary........................................................................................................................................................12-44
Systems and Agents .........................................................................................................................................13-1
Systems and Agents.......................................................................................................................................13-2
Objectives ......................................................................................................................................................13-3
Systems..........................................................................................................................................................13-4
System Properties ..........................................................................................................................................13-5
Local System .................................................................................................................................................13-6
External Systems ...........................................................................................................................................13-7
Defining a System in Oracle E-Business Suite..............................................................................................13-8
Defining a System in Standalone Oracle Workflow......................................................................................13-9
Maintaining Systems in Oracle E-Business Suite..........................................................................................13-10
Maintaining Systems in Standalone Oracle Workflow..................................................................................13-12
Agents............................................................................................................................................................13-14
Standard Agents.............................................................................................................................................13-16
Agent Properties ............................................................................................................................................13-18
Custom Queue Handlers ................................................................................................................................13-23
Agents on External Systems ..........................................................................................................................13-24
Defining an Agent in Oracle E-Business Suite..............................................................................................13-26
Defining an Agent in Standalone Oracle Workflow......................................................................................13-28
Agent Groups.................................................................................................................................................13-30
Defining an Agent Group in Oracle E-Business Suite...................................................................................13-31
Maintaining Agents in Oracle E-Business Suite............................................................................................13-32
Maintaining Agents in Standalone Oracle Workflow....................................................................................13-33
External System Registration ........................................................................................................................13-34
Retrieving System Identifier Information......................................................................................................13-36
Retrieving System Identifier Information in Oracle E-Business Suite ..........................................................13-37
Retrieving System Identifier Information in Standalone Oracle Workflow ..................................................13-38
Registering Systems ......................................................................................................................................13-39
Registering Systems in Oracle E-Business Suite...........................................................................................13-40
Registering Systems in Standalone Oracle Workflow...................................................................................13-42
Practice - Sending an Event to an Agent ...................................................................................................13-43
Solution - Sending an Event to an Agent...................................................................................................13-45
Review Questions ..........................................................................................................................................13-48
Summary........................................................................................................................................................13-51
Defining Event Activities.................................................................................................................................14-1
Defining Event Activities ..............................................................................................................................14-2
Objectives ......................................................................................................................................................14-3
Event Activities .............................................................................................................................................14-4
Event-Based Workflow Processes .................................................................................................................14-5
Event Activity Actions ..................................................................................................................................14-6
Receive Event Activities ...............................................................................................................................14-7
Receive Event Activities Event Filter.........................................................................................................14-8
Receive Event Activities Sending an Event to One Process.......................................................................14-9
Receive Event Activities Sending an Event to Multiple Processes ............................................................14-11
Receive Event Activities Receiving an Event ............................................................................................14-13
Raise Event Activities ...................................................................................................................................14-15
Send Event Activities ....................................................................................................................................14-16
Defining an Event Activity............................................................................................................................14-17
Event Details .................................................................................................................................................14-19
Defining Event Details: Receive ...................................................................................................................14-20
Defining Event Details: Raise .......................................................................................................................14-21
Defining Event Details: Send ........................................................................................................................14-23
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


vi

Example: Order Processing ...........................................................................................................................14-25


Standard Activities ........................................................................................................................................14-26
Practice - Defining Event Activities ..........................................................................................................14-28
Solution - Defining Event Activities .........................................................................................................14-30
Summary........................................................................................................................................................14-39
Workflow Engine.............................................................................................................................................15-1
Workflow Engine ..........................................................................................................................................15-2
Objectives ......................................................................................................................................................15-3
Overview of the Workflow Engine................................................................................................................15-4
Initiating a Workflow Process .......................................................................................................................15-6
Workflow Engine Processing ........................................................................................................................15-8
Activity Statuses ............................................................................................................................................15-10
Calling the Workflow Engine........................................................................................................................15-11
Oracle Workflow APIs ..................................................................................................................................15-12
Background Engines......................................................................................................................................15-14
Stuck Processes .............................................................................................................................................15-15
Timed Out Activities .....................................................................................................................................15-16
Practice - Implementing Timeout Processing ............................................................................................15-17
Solution - Implementing Timeout Processing ...........................................................................................15-19
Deferred Processing.......................................................................................................................................15-26
Practice - Implementing Deferred Processing ...........................................................................................15-28
Solution - Implementing Deferred Processing...........................................................................................15-30
Summary........................................................................................................................................................15-33
Workflow Process APIs...................................................................................................................................16-1
Workflow Process APIs.................................................................................................................................16-2
Objectives ......................................................................................................................................................16-3
PL/SQL Procedures for Function Activities ..................................................................................................16-4
Standard API for PL/SQL Procedures Called by Function Activities ...........................................................16-5
Standard API Parameters...............................................................................................................................16-7
Function Activity Execution Modes ..............................................................................................................16-8
Standard API Resultout Parameter ................................................................................................................16-10
Practice - Defining PL/SQL Procedures for Function Activities...............................................................16-11
Solution - Defining PL/SQL Procedures for Function Activities ..............................................................16-13
PL/SQL Procedures for Notification Activities.............................................................................................16-18
Standard API for PL/SQL Procedures Called by Notification Activities ......................................................16-19
Post-Notification Function Execution Modes................................................................................................16-21
Standard API Resultout Parameter for a Post-Notification Function ............................................................16-23
Post-Notification Function Context Information ...........................................................................................16-24
Practice - Defining a Post-Notification Function.......................................................................................16-25
Solution - Defining a Post-Notification Function ......................................................................................16-27
Exception Handling .......................................................................................................................................16-31
Exception Handling Example ........................................................................................................................16-32
Java Procedures for External Java Function Activities..................................................................................16-33
Workflow Engine APIs .................................................................................................................................16-36
Summary........................................................................................................................................................16-43
Business Event System APIs ...........................................................................................................................17-1
Business Event System APIs .........................................................................................................................17-2
Objectives ......................................................................................................................................................17-3
Business Event System Datatypes .................................................................................................................17-4
Event Message Structure ...............................................................................................................................17-5
Agent Structure..............................................................................................................................................17-9
Parameter List Structure ................................................................................................................................17-11
Parameter Structure .......................................................................................................................................17-12
Raising Events Programmatically..................................................................................................................17-14
Event Data Generate Functions .....................................................................................................................17-20
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


vii

Standard API for PL/SQL Event Data Generate Functions...........................................................................17-21


Standard API for Java Event Data Generate Functions .................................................................................17-22
Queue Handlers .............................................................................................................................................17-25
Standard APIs for PL/SQL Queue Handlers .................................................................................................17-26
Standard APIs for Java Queue Handlers........................................................................................................17-27
Subscription Rule Functions..........................................................................................................................17-29
Standard API for PL/SQL Subscription Rule Functions ...............................................................................17-31
Standard API for Java Subscription Rule Functions......................................................................................17-33
Predefined Subscription Rule Functions........................................................................................................17-35
Event APIs.....................................................................................................................................................17-37
Event Function APIs......................................................................................................................................17-39
Adding a Correlation ID to an Event Message ..............................................................................................17-40
Business Event System Cleanup API ............................................................................................................17-42
Summary........................................................................................................................................................17-43
Error Handling ................................................................................................................................................18-1
Error Handling...............................................................................................................................................18-2
Objectives ......................................................................................................................................................18-3
Error Handling for Subscription Processing ..................................................................................................18-4
Standard Error Agents ...................................................................................................................................18-6
Error Handling Subscriptions ........................................................................................................................18-7
Unexpected Events ........................................................................................................................................18-8
Default Event Error Process ..........................................................................................................................18-9
Event Warnings .............................................................................................................................................18-10
External Event Errors ....................................................................................................................................18-11
Local Event Errors.........................................................................................................................................18-12
Error Handling for Workflow Processes .......................................................................................................18-13
Default Error Process.....................................................................................................................................18-15
Retry-only Process.........................................................................................................................................18-16
Guided Demonstration - Error Handling ...................................................................................................18-17
Summary........................................................................................................................................................18-18
PL/SQL Documents.........................................................................................................................................19-1
PL/SQL Documents.......................................................................................................................................19-2
Objectives ......................................................................................................................................................19-3
PL/SQL Documents.......................................................................................................................................19-4
Integrating PL/SQL Documents into Workflow Processes ...........................................................................19-5
Including PL/SQL Documents in Messages ..................................................................................................19-7
Standard API for a PL/SQL Document .........................................................................................................19-8
Standard API for a PL/SQL CLOB Document..............................................................................................19-10
Standard API for a PL/SQL BLOB Document..............................................................................................19-13
Practice - Using a PL/SQL Document Attribute........................................................................................19-15
Solution - Using a PL/SQL Document Attribute .......................................................................................19-17
Summary........................................................................................................................................................19-22
Forced Synchronous Processing .....................................................................................................................20-1
Forced Synchronous Processing ....................................................................................................................20-2
Objectives ......................................................................................................................................................20-3
Forced Synchronous Processes......................................................................................................................20-4
Process Definition Restrictions......................................................................................................................20-5
Summary........................................................................................................................................................20-8
Selector/Callback Functions ...........................................................................................................................21-1
Selector/Callback Functions ..........................................................................................................................21-2
Objectives ......................................................................................................................................................21-3
Item Type Selector/Callback Functions.........................................................................................................21-4
Defining a Selector/Callback Function for an Item Type ..............................................................................21-5
Standard API for a Selector/Callback Function.............................................................................................21-6
Calling a Selector/Callback Function ............................................................................................................21-10
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


viii

Practice - Defining a Selector Function .....................................................................................................21-12


Solution - Defining a Selector Function ....................................................................................................21-14
Summary........................................................................................................................................................21-19
Master/Detail Coordination Activities ...........................................................................................................22-1
Master/Detail Coordination Activities...........................................................................................................22-2
Objectives ......................................................................................................................................................22-3
Master/Detail Coordination Activities...........................................................................................................22-4
Master Process Example................................................................................................................................22-9
Detail Process Example .................................................................................................................................22-10
Continue Flow Processing .............................................................................................................................22-11
Summary........................................................................................................................................................22-12
Customizing Workflow Processes ..................................................................................................................23-1
Customizing Workflow Processes .................................................................................................................23-2
Objectives ......................................................................................................................................................23-3
Customizing Workflow Processes .................................................................................................................23-4
Access Protection ..........................................................................................................................................23-6
Access Levels ................................................................................................................................................23-7
Setting the Access Level................................................................................................................................23-9
Setting Protection and Customization Levels ................................................................................................23-10
Example of Access Protection .......................................................................................................................23-12
Unsupported Customizations.........................................................................................................................23-14
Workflow Definitions Loader........................................................................................................................23-15
Preserving Customizations ............................................................................................................................23-16
Summary........................................................................................................................................................23-17
Workflow Loaders...........................................................................................................................................24-1
Workflow Loaders.........................................................................................................................................24-2
Objectives ......................................................................................................................................................24-3
Workflow Definitions Loader........................................................................................................................24-4
Transferring Workflow Definitions in Oracle E-Business Suite ...................................................................24-5
Transferring Workflow Definitions in Standalone Oracle Workflow ...........................................................24-6
Workflow XML Loader.................................................................................................................................24-8
Summary........................................................................................................................................................24-12
Setting Up Oracle Workflow ..........................................................................................................................25-1
Setting Up Oracle Workflow .........................................................................................................................25-2
Objectives ......................................................................................................................................................25-3
Required Setup Steps.....................................................................................................................................25-4
Step 1 Setting Global Workflow Preferences ................................................................................................25-5
Step 2 Setting Up an Oracle Workflow Directory Service ............................................................................25-11
Step 3 Setting the WF_RESOURCES Environment Variable.......................................................................25-16
Step 4 Running Background Engines ............................................................................................................25-17
Step 5 Configuring the Business Event System.............................................................................................25-20
Step 5 Event Message Communication .........................................................................................................25-21
Step 5 Setting Up Database Links and Queues..............................................................................................25-22
Step 5 Checking Database Parameters...........................................................................................................25-23
Step 5 Scheduling Agent Listeners................................................................................................................25-24
Step 5 Scheduling Propagation......................................................................................................................25-27
Guided Demonstration - Scheduling Agent Listeners and Propagation ....................................................25-31
Step 5 Synchronizing License Statuses in Oracle E-Business Suite..............................................................25-34
Step 5 Cleaning Up the WF_CONTROL Queue...........................................................................................25-35
Optional Setup Steps .....................................................................................................................................25-37
Optional Step 1 Partitioning Workflow Tables .............................................................................................25-39
Optional Step 2 Synchronizing with Oracle Internet Directory.....................................................................25-41
Optional Step 3 Setting Up Additional Languages........................................................................................25-43
Optional Step 4 Implementing Notification Mailers .....................................................................................25-46
Optional Step 5 Customizing Message Templates ........................................................................................25-49
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


ix

Optional Step 6 Adding Worklist Functions to User Responsibilities...........................................................25-52


Optional Step 7 Setting the Notification Reassign Mode ..............................................................................25-53
Optional Step 8 Setting Up Vacation Rule Options.......................................................................................25-54
Optional Step 9 Setting Up for Electronic Signatures ...................................................................................25-56
Optional Step 10 Customizing the Workflow Web Page Logo .....................................................................25-58
Optional Step 11 Adding Custom Icons ........................................................................................................25-59
Optional Step 12 Starting the Java Function Activity Agent.........................................................................25-60
Version Compatibility ...................................................................................................................................25-62
Review Questions ..........................................................................................................................................25-63
Summary........................................................................................................................................................25-66
Managing Service Components ......................................................................................................................26-1
Managing Service Components.....................................................................................................................26-2
Objectives ......................................................................................................................................................26-3
Oracle Workflow Manager ............................................................................................................................26-4
Service Components ......................................................................................................................................26-5
Service Component Containers .....................................................................................................................26-6
Service Component Types.............................................................................................................................26-7
Accessing Service Components in Oracle Workflow Manager.....................................................................26-8
Managing Service Components.....................................................................................................................26-9
Service Component Container Logs ..............................................................................................................26-11
Service Component Startup Modes ...............................................................................................................26-13
Agent Listeners..............................................................................................................................................26-14
Agent Listener Configuration Wizards..........................................................................................................26-17
Notification Mailers.......................................................................................................................................26-20
Notification Mailers Outbound Processing.................................................................................................26-22
Notification Mailers Inbound Processing ...................................................................................................26-24
Notification Mailer Setup ..............................................................................................................................26-26
Notification Mailer Parameters......................................................................................................................26-28
Notification Mailer Configuration Wizard ....................................................................................................26-29
Notification Mailer Throughput ....................................................................................................................26-35
Guided Demonstration - Service Components ..........................................................................................26-36
Summary........................................................................................................................................................26-38
Managing System Status and Throughput ....................................................................................................27-1
Managing System Status and Throughput .....................................................................................................27-2
Objectives ......................................................................................................................................................27-3
Workflow System Status ...............................................................................................................................27-4
Workflow Status in Oracle Applications Manager ........................................................................................27-6
Oracle Workflow Administration ..................................................................................................................27-8
Work Items ....................................................................................................................................................27-9
Oracle Workflow Administration ..................................................................................................................27-14
Purging Workflow Data.................................................................................................................................27-15
Purging in Oracle E-Business Suite...............................................................................................................27-17
Purging in Standalone Oracle Workflow.......................................................................................................27-19
Completed Work Items..................................................................................................................................27-21
Workflow Purge APIs ...................................................................................................................................27-24
Oracle Workflow Administration ..................................................................................................................27-25
Background Engines......................................................................................................................................27-26
Running Background Engines in Oracle E-Business Suite ...........................................................................27-27
Running Background Engines in Standalone Oracle Workflow....................................................................27-29
Oracle Workflow Administration ..................................................................................................................27-31
Control Queue Cleanup .................................................................................................................................27-32
Running Control Queue Cleanup in Oracle E-Business Suite .......................................................................27-33
Running Control Queue Cleanup in Standalone Oracle Workflow ...............................................................27-34
Oracle Workflow Administration ..................................................................................................................27-35
Queue Propagation ........................................................................................................................................27-36
Oracle Workflow Administration ..................................................................................................................27-37
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


x

Agent Activity ...............................................................................................................................................27-38


Searching Messages on an Agent ..................................................................................................................27-39
Guided Demonstration - System Status and Throughput...........................................................................27-40
Summary........................................................................................................................................................27-44
Sample Solutions..............................................................................................................................................28-1
Sample Solutions ...........................................................................................................................................28-2
Overview .......................................................................................................................................................28-3
Vacation Proposal Process Sketch.................................................................................................................28-4
wfvacxx.html .................................................................................................................................................28-5
wfvacxxc.sql..................................................................................................................................................28-6
wfvacxxs.sql ..................................................................................................................................................28-8
wfvacxxb.sql..................................................................................................................................................28-13
wfvacxxd.sql..................................................................................................................................................28-26
wfslctxx.sql....................................................................................................................................................28-28

Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


xi

Preface
Profile
Before You Begin This Course
Before you begin this course, you should have the following qualifications:

Thorough knowledge of Oracle Database and Oracle Application Server technology

If you plan to use Oracle Workflow with Oracle E-Business Suite, thorough knowledge
of Oracle E-Business Suite

Working experience with XML

Prerequisites

Introduction to Oracle9i: SQL

Oracle9i: Program with PL/SQL

How This Course Is Organized


11i/2.6 Implement Oracle Workflow is an instructor-led course featuring lecture and hands-on
exercises. Online demonstrations and written practice sessions reinforce the concepts and skills
introduced.

Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


xiii

Related Publications
Oracle Publications
Title

Part Number

Oracle Workflow Administrator's Guide, Release 2.6.3.5

B12160

Oracle Workflow Developer's Guide, Release 2.6.3.5

B12161

Oracle Workflow User's Guide, Release 2.6.3.5

B12162

Oracle Workflow API Reference, Release 2.6.3.5

B12163

Additional Publications

System release bulletins

Installation and users guides

Read-me files

International Oracle Users Group (IOUG) articles

Oracle Magazine

Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


xiv

Typographic Conventions
Typographic Conventions in Text
Convention
Bold italic
Caps and
lowercase
Courier new,
case sensitive
(default is
lowercase)

Initial cap

Element
Glossary term (if
there is a glossary)
Buttons,
check boxes,
triggers,
windows
Code output,
directory names,
filenames,
passwords,
pathnames,
URLs,
user input,
usernames

Arrow
Brackets
Commas

Graphics labels
(unless the term is a
proper noun)
Emphasized words
and phrases,
titles of books and
courses,
variables
Interface elements
with long names
that have only
initial caps;
lesson and chapter
titles in crossreferences
SQL column
names, commands,
functions, schemas,
table names
Menu paths
Key names
Key sequences

Plus signs

Key combinations

Italic

Quotation
marks

Uppercase

Example
The algorithm inserts the new key.
Click the Executable button.
Select the Cant Delete Card check box.
Assign a When-Validate-Item trigger to the ORD block.
Open the Master Schedule window.
Code output: debug.set (I, 300);
Directory: bin (DOS), $FMHOME (UNIX)
Filename: Locate the init.ora file.
Password: User tiger as your password.
Pathname: Open c:\my_docs\projects
URL: Go to http://www.oracle.com
User input: Enter 300
Username: Log on as scott
Customer address (but Oracle Payables)
Do not save changes to the database.
For further information, see Oracle7 Server SQL Language
Reference Manual.
Enter [email protected], where user_id is the
name of the user.
Select Include a reusable module component and click Finish.
This subject is covered in Unit II, Lesson 3, Working with
Objects.

Use the SELECT command to view information stored in the


LAST_NAME
column of the EMP table.
Select File > Save.
Press [Enter].
Press and release keys one at a time:
[Alternate], [F], [D]
Press and hold these keys simultaneously: [Ctrl]+[Alt]+[Del]

Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


xv

Typographic Conventions in Code


Convention
Caps and
lowercase
Lowercase

Element
Oracle Forms
triggers
Column names,
table names

Example
When-Validate-Item

Passwords

DROP USER scott


IDENTIFIED BY tiger;
OG_ACTIVATE_LAYER
(OG_GET_LAYER (prod_pie_layer))

SELECT last_name
FROM s_emp;

PL/SQL objects

Lowercase
italic
Uppercase

Syntax variables

CREATE ROLE role

SQL commands and SELECT userid


FROM emp;
functions

Typographic Conventions in Oracle Application Navigation Paths


This course uses simplified navigation paths, such as the following example, to direct you
through Oracle Applications.
(N) Invoice > Entry > Invoice Batches Summary (M) Query > Find (B) Approve
This simplified path translates to the following:

1.

(N) From the Navigator window, select Invoice then Entry then Invoice Batches
Summary.

2.

(M) From the menu, select Query then Find.

3.

(B) Click the Approve button.

Notations:
(N) = Navigator
(M) = Menu
(T) = Tab
(B) = Button
(I) = Icon
(H) = Hyperlink
(ST) = Sub Tab
Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


xvi

Typographical Conventions in Oracle Application Help System Paths


This course uses a navigation path convention to represent actions you perform to find
pertinent information in the Oracle Applications Help System.
The following help navigation path, for example
(Help) General Ledger > Journals > Enter Journals
represents the following sequence of actions:
1.

In the navigation frame of the help system window, expand the General Ledger entry.

2.

Under the General Ledger entry, expand Journals.

3.

Under Journals, select Enter Journals.

4.

Review the Enter Journals topic that appears in the document frame of the help system
window.

Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


xvii

Copyright Oracle Corporation, 2004. All rights reserved.

11i/2.6 Implement Oracle Workflow Table of Contents


xviii

You might also like