chang s., jaeckel c. - oracle workflow guide (release 2.6.1) (2001)

7/29/2019 Chang S., Jaeckel C. - Oracle Workflow Guide (Release 2.6.1) (2001)

1/988

Oracle

r

WorkflowGuideRELEASE 2.6.1VOLUME 1

June 2001


2/988

Oracler Workflow Guide Release 2.6.1

The part number for this volume is A9018401. To reorder this book, please use the set part

number, A9018101.

Copyright E 1996, 2001, Oracle Corporation. All rights reserved.

Primary Authors: Siu Chang, Clara Jaeckel

Major Contributors: George Buzsaki, Mark Craig, Kevin Hudson, George Kellner, DavidLam, Jin Liu, Kenneth Ma, Steve Mayze, Tim Roveda, Robin Seiden, Sheryl Sheh, Susan

StrattonThe Programs (which include both the software and documentation) contain proprietary informationof Oracle Corporation; they are provided under a license agreement containing restrictions on use anddisclosure and are also protected by copyright, patent and other intellectual and industrial propertylaws. Reverse engineering, disassembly or decompilation of the Programs is prohibited.

The information contained in this document is subject to change without notice. If you find anyproblems in the documentation, please report them to us in writing. Oracle Corporation does notwarrant that this document is error free. Except as may be expressly permitted in your license

agreement for these Programs, no part of these Programs may be reproduced or transmitted in anyform or by any means, electronic or mechanical, for any purpose, without the express writtenpermission of Oracle Corporation.

If the Programs are delivered to the US Government or anyone licensing or using the Programs onbehalf of the US Government, the following notice is applicable:

RESTRICTED RIGHTS NOTICEPrograms delivered subject to the DOD FAR Supplement are commercial computer software and use,duplication and disclosure of the Programs including documentation, shall be subject to the licensing

restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subjectto the Federal Acquisition Regulations are restricted computer software and use, duplication anddisclosure of the Programs shall be subject to the restrictions in FAR 52.22719, Commercial ComputerSoftware Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or otherinherently dangerous applications. It shall be licensees responsibility to take all appropriate failsafe,

back up, redundancy and other measures to ensure the safe use of such applications if the Programsare used for such purposes, and Oracle Corporation disclaims liability for any damages caused by

such use of the Programs.Oracle is a registered trademark and ConText, Enabling the Information Age, Oracle8, Oracle8i,Oracle9i, Oracle9i Application Server, Oracle Access, Oracle Application Object Library, OracleDiscoverer, Oracle Financials, Oracle HTTP Server (powered by Apache), Oracle Net, Oracle Workflow,Oracle Work in Process, PL/SQL, Pro*C, SmartClient, SQL*, SQL*Forms, SQL*Loader, SQL*Menu,SQL*Net, SQL*Plus, and SQL*Report are trademarks or registered trademarks of Oracle Corporation.Other names may be trademarks of their respective owners.


3/988

iContents

Contents

VOLUME 1Volume 1 i. . . . . . . . . . . . . . . . . . . . . . . . . .

Preface xv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Audience for This Guide xvi. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

How To Use This Guide xvi. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Finding Out Whats New xvii. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Other Information Sources xviii. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Online Documentation xviii. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Related User Guides xix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

User Guides Related to All Products xix. . . . . . . . . . . . . . . . . . . .User Guides Related to This Product xx. . . . . . . . . . . . . . . . . . . .

Installation and System Administration Guides xxi. . . . . . . . . .

Training and Support xxiii. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Documentation Accessibility xxiv. . . . . . . . . . . . . . . . . . . . . . . . . . .

Do Not Use Database Tools to Modify Oracle WorkflowData xxiv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

About Oracle xxv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Your Feedback xxv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 1 Overview of Oracle Workflow 1 1. . . . . . . . . . . . . . . . . . . . . . . . . . . .

Introduction to Oracle Workflow 1 2. . . . . . . . . . . . . . . . . . . . . . . . . . .

Major Features and Definitions 1 3. . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Processes 1 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


4/988

ii Oracle Workflow Guide

Chapter 2 Setting Up Oracle Workflow 2 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Oracle Workflow Hardware and Software Requirements 2 2. . . . . .

Overview of Setting Up 2 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Overview of Required Set Up Steps for the Standalone

Version of Oracle Workflow 2 5. . . . . . . . . . . . . . . . . . . . . . . . . . . .Overview of Required Set Up Steps for the Version ofOracle Workflow Embedded in Oracle Applications 2 6. . . . . .

Optional Set Up Steps 2 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Other Workflow Features 2 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Identifying the Version of Your Oracle Workflow Server 2 8. . .

Setup Flowchart 2 9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Setup Checklist 2 10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Setup Steps 2 11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Overview of Oracle Workflow Access Protection 2 85. . . . . . . . . . . . .

Setting Up a Default Access Level 2 89. . . . . . . . . . . . . . . . . . . . . .

Using the Workflow Definitions Loader 2 91. . . . . . . . . . . . . . . . . . . . .

Using the Workflow XML Loader 2 96. . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 3 Defining a Workflow Process 3 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . .Overview of Oracle Workflow Builder 3 2. . . . . . . . . . . . . . . . . . . . . .

The Navigator Tree Structure 3 3. . . . . . . . . . . . . . . . . . . . . . . . . .

Viewing the Navigator Tree 3 4. . . . . . . . . . . . . . . . . . . . . . . . . . . .

Creating Process Definitions in Oracle Workflow Builder 3 7. . . . . .

Opening and Saving Item Types 3 12. . . . . . . . . . . . . . . . . . . . . . . .

Quick Start Wizard Overview 3 18. . . . . . . . . . . . . . . . . . . . . . . . . .

Using Oracle Workflow Builder with Different ServerVersions 3 21. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Item Type Definition Web Page 3 24. . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 4 Defining Workflow Process Components 4 1. . . . . . . . . . . . . . . . . .

Workflow Process Components 4 2. . . . . . . . . . . . . . . . . . . . . . . . . . . .

Item Types 4 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Allowing Access to an Object 4 17. . . . . . . . . . . . . . . . . . . . . . . . . .Lookup Types 4 19. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Messages 4 23. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Activities 4 40. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Voting Activity 4 58. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Deleting Objects in Oracle Workflow Builder 4 65. . . . . . . . . . . . . . . .

Modifying Objects in Oracle Workflow Builder 4 66. . . . . . . . . . . . . .

Workflow Objects That Support Versioning 4 67. . . . . . . . . . . . . .


5/988

iiiContents

Workflow Objects That Do Not Support Versioning 4 68. . . . . . .

Chapter 5 Defining a Workflow Process Diagram 5 1. . . . . . . . . . . . . . . . . . . .

Process Window 5 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Modifying Fonts in Oracle Workflow Builder 5 21. . . . . . . . . . . .

Creating a Shortcut Icon for a Workflow Process 5 22. . . . . . . . . .

Roles 5 24. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 6 Predefined Workflow Activities 6 1. . . . . . . . . . . . . . . . . . . . . . . . . . .

Standard Activities 6 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

And/Or Activities 6 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Comparison Activities 6 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Compare Execution Time Activity 6 3. . . . . . . . . . . . . . . . . . . . . .

Wait Activity 6 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Block Activity 6 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Defer Thread Activity 6 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Launch Process Activity 6 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Noop Activity 6 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Loop Counter Activity 6 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Start Activity 6 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

End Activity 6 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Role Resolution Activity 6 9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Notify Activity 6 9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Vote Yes/No Activity 6 10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Master/Detail Coordination Activities 6 11. . . . . . . . . . . . . . . . . .

Wait for Flow Activity 6 12. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Continue Flow Activity 6 12. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Assign Activity 6 14. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Get Monitor URL Activity 6 14. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Get Event Property Activity 6 15. . . . . . . . . . . . . . . . . . . . . . . . . . .

Set Event Property Activity 6 15. . . . . . . . . . . . . . . . . . . . . . . . . . . .

Compare Event Property Activity 6 16. . . . . . . . . . . . . . . . . . . . . .

XML Get Tag Value Activity 6 18. . . . . . . . . . . . . . . . . . . . . . . . . . .XML Compare Tag Value Activities 6 19. . . . . . . . . . . . . . . . . . . . .

XML Transform Activity 6 20. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Concurrent Manager Standard Activities 6 22. . . . . . . . . . . . . . . . . . . .

Execute Concurrent Program Activity 6 22. . . . . . . . . . . . . . . . . . .

Submit Concurrent Program Activity 6 23. . . . . . . . . . . . . . . . . . .

Wait for Concurrent Program Activity 6 24. . . . . . . . . . . . . . . . . . .

Default Error Process 6 26. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


6/988

iv Oracle Workflow Guide

System: Error Item Type and Item Attributes 6 27. . . . . . . . . . . . .

Default Error Process 6 28. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Retryonly Process 6 32. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Default Event Error Process 6 34. . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 7 Defining Procedures and Functions for Oracle Workflow 7 1. . . .

Defining Procedures and Functions for Oracle Workflow 7 2. . . . . .

Standard API for PL/SQL Procedures Called by FunctionActivities 7 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Standard API for Java Procedures Called by FunctionActivities 7 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Standard API for an Item Type Selector or Callback Function 7 13. .Standard APIs for PL/SQL and PL/SQL CLOBDocuments 7 17. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

PL/SQL Documents 7 17. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

PL/SQL CLOB Documents 7 19. . . . . . . . . . . . . . . . . . . . . . . . . .

Standard API for an Event Data Generate Function 7 21. . . . . . . . . . .

Standard APIs for a Queue Handler 7 22. . . . . . . . . . . . . . . . . . . . . . . .

Enqueue 7 22. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Dequeue 7 23. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Standard API for an Event Subscription Rule Function 7 24. . . . . . . .

Chapter 8 Oracle Workflow APIs 8 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Oracle Workflow Procedures and Functions 8 2. . . . . . . . . . . . . . . . .

Overview of the Workflow Engine 8 3. . . . . . . . . . . . . . . . . . . . . . . . .

Oracle Workflow Java Interface 8 4. . . . . . . . . . . . . . . . . . . . . . . .

Additional Workflow Engine Features 8 6. . . . . . . . . . . . . . . . . .

Workflow Engine APIs 8 16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CreateProcess 8 18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetItemUserKey 8 20. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetItemUserKey 8 21. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetActivityLabel 8 22. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetItemOwner 8 23. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .StartProcess 8 24. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

LaunchProcess 8 26. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SuspendProcess 8 28. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ResumeProcess 8 29. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AbortProcess 8 30. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CreateForkProcess 8 32. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

StartForkProcess 8 34. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


7/988

vContents

Background 8 35. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AddItemAttribute 8 37. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AddItemAttributeArray 8 40. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetItemAttribute 8 42. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetItemAttrDocument 8 45. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .SetItemAttributeArray 8 47. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getItemTypes 8 50. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetItemAttribute 8 51. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetItemAttrDocument 8 53. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetItemAttrClob 8 54. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getItemAttributes 8 55. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetItemAttrInfo 8 56. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetActivityAttrInfo 8 57. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .GetActivityAttribute 8 58. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetActivityAttrClob 8 60. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

BeginActivity 8 61. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CompleteActivity 8 63. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CompleteActivityInternalName 8 66. . . . . . . . . . . . . . . . . . . . . . . .

AssignActivity 8 68. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Event 8 69. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .HandleError 8 71. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetItemParent 8 73. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ItemStatus 8 74. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getProcessStatus 8 75. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Core APIs 8 76. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CLEAR 8 77. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GET_ERROR 8 78. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .TOKEN 8 79. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

RAISE 8 80. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CONTEXT 8 83. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TRANSLATE 8 85. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Purge APIs 8 86. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Items 8 88. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Activities 8 89. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Notifications 8 90. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Total 8 91. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TotalPERM 8 92. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AdHocDirectory 8 93. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Purge Obsolete Workflow Runtime Data ConcurrentProgram 8 94. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Directory Service APIs 8 95. . . . . . . . . . . . . . . . . . . . . . . . . .

GetRoleUsers 8 96. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


8/988

vi Oracle Workflow Guide

GetUserRoles 8 97. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetRoleInfo 8 98. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetRoleInfo2 8 99. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

IsPerformer 8 100. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

UserActive 8 101. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .GetUserName 8 102. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetRoleName 8 103. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetRoleDisplayName 8 104. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetAdHocUserStatus 8 105. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetAdHocRoleStatus 8 106. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CreateAdHocUser 8 107. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CreateAdHocRole 8 109. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AddUsersToAdHocRole 8 111. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .SetAdHocUserExpiration 8 112. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetAdHocRoleExpiration 8 113. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetAdHocUserAttr 8 114. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetAdHocRoleAttr 8 115. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

RemoveUsersFromAdHocRole 8 116. . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Preferences API 8 117. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

get_pref 8 117. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Workflow Monitor APIs 8 118. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetAccessKey 8 119. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetDiagramURL 8 120. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetEnvelopeURL 8 122. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetAdvancedEnvelopeURL 8 124. . . . . . . . . . . . . . . . . . . . . . . . . . .

Oracle Workflow Views 8 126. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

WF_ITEM_ACTIVITY_STATUSES_V 8 126. . . . . . . . . . . . . . . . . . .WF_NOTIFICATION_ATTR_RESP_V 8 128. . . . . . . . . . . . . . . . . . .

WF_RUNNABLE_PROCESSES_V 8 129. . . . . . . . . . . . . . . . . . . . . .

WF_ITEMS_V 8 130. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Queue APIs 8 131. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

EnqueueInbound 8 134. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

DequeueOutbound 8 136. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

DequeueEventDetail 8 139. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

PurgeEvent 8 141. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

PurgeItemType 8 142. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ProcessInboundQueue 8 143. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetMessageHandle 8 144. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

DequeueException 8 145. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

DeferredQueue 8 146. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

InboundQueue 8 147. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


9/988

viiContents

OutboundQueue 8 148. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ClearMsgStack 8 149. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CreateMsg 8 150. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

WriteMsg 8 151. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetMsgAttr 8 152. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .SetMsgResult 8 153. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Document Management APIs 8 154. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

get_launch_document_url 8 155. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

get_launch_attach_url 8 156. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

get_open_dm_display_window 8 157. . . . . . . . . . . . . . . . . . . . . . . .

get_open_dm_attach_window 8 158. . . . . . . . . . . . . . . . . . . . . . . . .

set_document_id_html 8 159. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Overview of the Oracle Workflow Notification System 8 161. . . . . . . .

Notification Model 8 161. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Notification APIs 8 166. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Send 8 168. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Custom Callback Function 8 169. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SendGroup 8 172. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Forward 8 174. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Transfer 8 175. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Cancel 8 176. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CancelGroup 8 177. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Respond 8 178. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Responder 8 179. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

VoteCount 8 180. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

OpenNotificationsExist 8 181. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Close 8 182. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .AddAttr 8 183. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SetAttribute 8 184. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetAttrInfo 8 186. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetInfo 8 187. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetText 8 188. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetShortText 8 189. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetAttribute 8 190. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetAttrDoc 8 191. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetSubject 8 192. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetBody 8 193. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetShortBody 8 194. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TestContext 8 195. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AccessCheck 8 196. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

WorkCount 8 197. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetNotifications 8 198. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


10/988

viii Oracle Workflow Guide

GetNotificationAttributes 8 199. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

WriteToClob 8 200. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Overview of the Oracle Workflow Business Event System 8 201. . . . .

Business Event System Datatypes 8 202. . . . . . . . . . . . . . . . . . . . . . . . . .

Agent Structure 8 203. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getName 8 203. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getSystem 8 203. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setName 8 204. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setSystem 8 204. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Parameter Structure 8 205. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getName 8 205. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getValue 8 205. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setName 8 206. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setValue 8 206. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Parameter List Structure 8 207. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Event Message Structure 8 208. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Initialize 8 211. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getPriority 8 211. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getSendDate 8 211. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getReceiveDate 8 211. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getCorrelationID 8 212. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getParameterList 8 212. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getEventName 8 212. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getEventKey 8 212. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getEventData 8 213. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getFromAgent 8 213. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getToAgent 8 213. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .getErrorSubscription 8 213. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getErrorMessage 8 213. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

getErrorStack 8 214. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setPriority 8 214. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setSendDate 8 214. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setReceiveDate 8 215. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setCorrelationID 8 215. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setParameterList 8 215. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .setEventName 8 216. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setEventKey 8 216. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setEventData 8 216. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setFromAgent 8 216. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setToAgent 8 217. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setErrorSubscription 8 217. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

setErrorMessage 8 217. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


11/988

ixContents

setErrorStack 8 218. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Content 8 218. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Address 8 218. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AddParameterToList 8 219. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

GetValueForParameter 8 219. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Example for Using Abstract Datatypes 8 221. . . . . . . . . . . . . . . . . .

Mapping Between WF_EVENT_T andOMBAQ_TEXT_MSG 8 223. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Event APIs 8 226. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Raise 8 227. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Send 8 230. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

NewAgent 8 231. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Test 8 232. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Enqueue 8 233. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Listen 8 234. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Listen Process Concurrent Program 8 235. . . . . . . . . . .

SetErrorInfo 8 236. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Event Subscription Rule Function APIs 8 237. . . . . . . . . . . . . . . . . . . . .

Default_Rule 8 238. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Log 8 240. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Error 8 241. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Warning 8 242. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Success 8 243. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow_Protocol 8 244. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Error_Rule 8 245. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Event Function APIs 8 246. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Parameters 8 247. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

SubscriptionParameters 8 249. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

AddCorrelation 8 250. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Generate 8 252. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Receive 8 254. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Business Event System Replication APIs 8 256. . . . . . . . . . . . . . . . . . . .

WF_EVENTS Document Type Definition 8 258. . . . . . . . . . . . . . . .

WF_EVENTS_PKG.Generate 8 259. . . . . . . . . . . . . . . . . . . . . . . . . .

WF_EVENTS_PKG.Receive 8 260. . . . . . . . . . . . . . . . . . . . . . . . . . . .WF_EVENT_GROUPS Document Type Definition 8 261. . . . . . . .

WF_EVENT_GROUPS_PKG.Generate 8 262. . . . . . . . . . . . . . . . . .

WF_EVENT_GROUPS_PKG.Receive 8 263. . . . . . . . . . . . . . . . . . .

WF_SYSTEMS Document Type Definition 8 264. . . . . . . . . . . . . . .

WF_SYSTEMS_PKG.Generate 8 265. . . . . . . . . . . . . . . . . . . . . . . . . .

WF_SYSTEMS_PKG.Receive 8 266. . . . . . . . . . . . . . . . . . . . . . . . . . .

WF_AGENTS Document Type Definition 8 267. . . . . . . . . . . . . . . .


12/988

x Oracle Workflow Guide

WF_AGENTS_PKG.Generate 8 268. . . . . . . . . . . . . . . . . . . . . . . . . .

WF_AGENTS_PKG.Receive 8 269. . . . . . . . . . . . . . . . . . . . . . . . . . .

WF_EVENT_SUBSCRIPTIONS Document Type Definition 8 270

WF_EVENT_SUBSCRIPTIONS_PKG.Generate 8 271. . . . . . . . . . .

WF_EVENT_SUBSCRIPTIONS_PKG.Receive 8 272. . . . . . . . . . . .

Index

VOLUME 2Volume 2 i. . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 9 Oracle Workflow Home Page 9 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Accessing the Oracle Workflow Home Page 9 2. . . . . . . . . . . . . . . . .

Setting User Preferences 9 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 10 Viewing Notifications and Processing Responses 10 1. . . . . . . . . . .

Overview of Notification Handling 10 2. . . . . . . . . . . . . . . . . . . . . . . . .

Reviewing Notifications via Electronic Mail 10 2. . . . . . . . . . . . . .Viewing Notifications from a Web Browser 10 13. . . . . . . . . . . . . .

Reviewing a Summary of Your Notifications viaElectronic Mail 10 23. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Defining Rules for Automatic Notification Processing 10 25. . . . .

Document Management Integration in Notifications 10 32. . . . . . . . . .

Chapter 11 Monitoring Workflow Processes 11 1. . . . . . . . . . . . . . . . . . . . . . . . . .

Overview of Workflow Monitoring 11 2. . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Monitor 11 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Monitor Access 11 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 12 Testing a Workflow Definition 12 1. . . . . . . . . . . . . . . . . . . . . . . . . . . .

Testing Workflow Definitions 12 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 13 Managing Business Events 13 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Managing Business Events 13 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Events 13 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Systems 13 17. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Agents 13 22. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


13/988

xiContents

Event Subscriptions 13 33. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Setting Up Message Propagation 13 45. . . . . . . . . . . . . . . . . . . . . . .

Raising Events 13 57. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Signing Up Systems 13 59. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Synchronizing Systems 13 61. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Reviewing Local Queues 13 64. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Agent Ping/Acknowledge 13 67. . . . . . . . . . . . . . . . . . . . . . .

The Workflow Agent Ping/Acknowledge Item Type 13 68. . . . . .

Summary of the Master Ping Process 13 69. . . . . . . . . . . . . . . . . . . .

Master Ping Process Activities 13 70. . . . . . . . . . . . . . . . . . . . . . . . .

Summary of the Detail Ping Process 13 71. . . . . . . . . . . . . . . . . . . .

Detail Ping Process Activities 13 72. . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 14 Predefined Workflow Events 14 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Predefined Workflow Events 14 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Event Definition Events 14 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Event Group Definition Events 14 3. . . . . . . . . . . . . . . . . . . . . . . . .

System Definition Events 14 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Agent Definition Events 14 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Event Subscription Definition Events 14 5. . . . . . . . . . . . . . . . . . .

Synchronize Event Systems Event 14 5. . . . . . . . . . . . . . . . . . . . . .

Seed Event Group 14 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Ping Agent Events 14 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

System Signup Event 14 9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Any Event 14 10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Unexpected Event 14 12. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Workflow Send Protocol 14 16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

The Workflow Send Protocol Item Type 14 17. . . . . . . . . . . . . . . . .

Summary of the Workflow Event Protocol Process 14 19. . . . . . . .

Workflow Event Protocol Process Activities 14 20. . . . . . . . . . . . . .

Workflow Send Protocol Events 14 23. . . . . . . . . . . . . . . . . . . . . . . .

Chapter 15 Demonstration Workflow Processes 15 1. . . . . . . . . . . . . . . . . . . . . . .Sample Workflow Processes 15 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Displaying the Process Diagram of a Sample Workflow 15 3. . . .

Requisition Process 15 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Installing the Requisition Data Model 15 6. . . . . . . . . . . . . . . . . . .

Initiating the Requisition Workflow 15 8. . . . . . . . . . . . . . . . . . . . .

The Requisition Item Type 15 12. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Summary of the Requisition Approval Process 15 13. . . . . . . . . . .


14/988

xii Oracle Workflow Guide

Requisition Process Activities 15 15. . . . . . . . . . . . . . . . . . . . . . . . . .

Summary of the Notify Approver Subprocess 15 19. . . . . . . . . . . .

Notify Approver Subprocess Activities 15 21. . . . . . . . . . . . . . . . . .

Sample StartProcess Function 15 23. . . . . . . . . . . . . . . . . . . . . . . . . .

Example Function Activities 15 26. . . . . . . . . . . . . . . . . . . . . . . . . . .

Example: Select Approver 15 26. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Example: Verify Authority 15 29. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Example Notification Activity 15 31. . . . . . . . . . . . . . . . . . . . . . . . . .

Example: Notify Requisition Approval Required 15 31. . . . . . . . .

Product Survey Process 15 34. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Installing the Product Survey Data Model 15 35. . . . . . . . . . . . . . .

Initiating the Product Survey Workflow 15 36. . . . . . . . . . . . . . . . .

The Product Survey Item Type 15 38. . . . . . . . . . . . . . . . . . . . . . . . .Summary of the Survey Single Process 15 39. . . . . . . . . . . . . . . . .

Survey Single Process Activities 15 41. . . . . . . . . . . . . . . . . . . . . .

Summary of the Survey Master/Detail Process 15 42. . . . . . . . .

Survey Master/Detail Process Activities 15 44. . . . . . . . . . . . . . .

Summary of the Detail Survey Process 15 46. . . . . . . . . . . . . . . . . .

Detail Survey Process Activities 15 47. . . . . . . . . . . . . . . . . . . . . . . .

Document Review Process 15 49. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .The Document Management Item Type 15 49. . . . . . . . . . . . . . . . . .

Summary of the Document Review Process 15 50. . . . . . . . . . . . . .

Document Review Process Activities 15 51. . . . . . . . . . . . . . . . . . . .

Error Check Process 15 54. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

The Periodic Alert Item Type 15 54. . . . . . . . . . . . . . . . . . . . . . . . . . .

Summary of the Error Check Process 15 56. . . . . . . . . . . . . . . . . . . .

Error Check Process Activities 15 57. . . . . . . . . . . . . . . . . . . . . . . . .Summary of the User Defined Alert Action Process 15 60. . . . . . .

User Defined Alert Action Process Activities 15 61. . . . . . . . . . . . .

Event System Demonstration 15 63. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Installing the Event System Demonstration Data Model 15 64. . .

Initiating the Event System Demonstration Workflow 15 66. . . . .

The Event System Demonstration Item Type 15 71. . . . . . . . . . . . .

Summary of the Buyer: Top Level PO Process 15 73. . . . . . . . . . . .

Buyer: Top Level PO Process Activities 15 75. . . . . . . . . . . . . . . . . .Summary of the Buyer: Send PO to Supplier Subprocess 15 78. . .

Buyer: Send PO to Supplier Subprocess Activities 15 78. . . . . . . .

Summary of the Buyer: Receive Supplier POAcknowledgement Subprocess 15 80. . . . . . . . . . . . . . . . . . . . . . . . .

Buyer: Receive Supplier PO AcknowledgementSubprocess Activities 15 81. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


15/988

xiiiContents

Summary of the Buyer: Advanced Shipment NoticeSubprocess 15 83. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Buyer: Advanced Shipment Notice Subprocess Activities 15 84. .

Summary of the Buyer: Receive Supplier InvoicingSubprocess 15 85. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Buyer: Receive Supplier Invoicing Subprocess Activities 15 86. . .Summary of the Supplier: Top Level Order Process 15 87. . . . . . .

Supplier: Top Level Order Process Activities 15 88. . . . . . . . . . . . .

Summary of the Supplier: Get Order Details Subprocess 15 91. . .

Supplier: Get Order Details Subprocess Activities 15 92. . . . . . . . .

Summary of the Supplier: Credit Check Subprocess 15 94. . . . . . .

Supplier: Credit Check Subprocess Activities 15 95. . . . . . . . . . . . .

Summary of the Supplier: Stock Check Subprocess 15 96. . . . . . . .Supplier: Stock Check Subprocess Activities 15 97. . . . . . . . . . . . .

Summary of the Supplier: Advanced Shipment NoticeSubprocess 15 98. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Supplier: Advanced Shipment Notice SubprocessActivities 15 99. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Summary of the Supplier: Send Supplier InvoiceSubprocess 15 100. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Supplier: Send Supplier Invoice Subprocess Activities 15 101. . . . .B2B Purchase Order Event 15 102. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B2B Purchase Order Acknowledgement Event 15 105. . . . . . . . . . .

B2B Advanced Shipment Notice Event 15 106. . . . . . . . . . . . . . . . . .

B2B Invoice Event 15 107. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 16 Workflow Administration Scripts 16 1. . . . . . . . . . . . . . . . . . . . . . . . .

Miscellaneous SQL Scripts 16 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .FNDWFLST 16 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

FNDWFPR 16 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

WFNLADD.sql 16 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfagtlst.sql 16 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfbkg.sql 16 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfbkgchk.sql 16 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfchact.sql 16 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Wfchacta.sql 16 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfchita.sql 16 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfchitt.sql 16 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfchluc.sql 16 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfchlut.sql 16 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfchmsg.sql 16 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfchmsga.sql 16 9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


16/988

xiv Oracle Workflow Guide

Wfdirchk.sql 16 9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfevtenq.sql 16 10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfjvstop.sql 16 11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfnlena.sql 16 11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfntfsh.sql 16 11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfprot.sql 16 11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfqclean.sql 16 12. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfrefchk.sql 16 12. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfretry.sql 16 13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfrmall.sql 16 13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfrmita.sql 16 13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfrmitms.sql 16 14. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfrmitt.sql 16 14. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Wfrmtype.sql 16 14. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfrun.sql 16 15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfstat.sql 16 15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfstatus.sql 16 15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfstdchk.sql 16 15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfver.sql 16 16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Wfverchk.sql 16 16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Wfverupd.sql 16 16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Appendix A Oracle Workflow Builder Menus and Toolbars A 1. . . . . . . . . . . . .

Oracle Workflow Builder Menus A 2. . . . . . . . . . . . . . . . . . . . . . . . . . .

Oracle Workflow Builder Toolbars A 7. . . . . . . . . . . . . . . . . . . . . . . . .

Appendix B Oracle Applications Embedded Workflows B 1. . . . . . . . . . . . . . . .

Predefined Workflows Embedded in Oracle Applications andOracle SelfService Web Applications B 2. . . . . . . . . . . . . . . . . . . . . . .

Oracle Support Policy for Predefined Workflows B 17. . . . . . . . . . . . .

Customization Guidelines B 17. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Resolving Customization Issues B 17. . . . . . . . . . . . . . . . . . . . . . . .

What Is NOT Supported B 18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .What Is Supported B 18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Glossary

Index


17/988

xvPreface

Preface


18/988

xvi Oracle Workflow Guide

Audience for This Guide

Welcome to the Oracle Workflow Guide.

This guide assumes you have a working knowledge of the following:

The principles and customary practices of your business area. Oracle Workflow.

If you have never used Oracle Workflow, we suggest you attendone or more of the Oracle Workflow training classes availablethrough Oracle University.

See Other Information Sources for more information about OracleApplications product information.

The Oracle Workflow Guide also assumes you have a basicunderstanding of operating system concepts and familiarity withOracle database server, PL/SQL, and Oracle9i Application Servertechnology. If you have not yet been introduced to any of thesesystems, we suggest you attend one or more of the training classesavailable through Oracle University.

How To Use This Guide

This guide contains the information you need to understand and useOracle Workflow to automate business processes to fit your needs.

This preface explains how this guide is organized and introduces othersources of information that can help you. This guide contains thefollowing chapters:

Chapter 1 provides an overview of Oracle Workflow.

Chapter 2 describes how to implement Oracle Workflow for yoursite.

Chapter 3 describes how to begin defining a workflow process.

Chapter 4 describes how to define the components necessary tobuild a workflow process.

Chapter 5 describes how to draw and define a workflow processdiagram.

Chapter 6 describes the standard activities provided with OracleWorkflow.


19/988

xviiPreface

Chapter 7 describes the standard APIs for the PL/SQL functionsthat can be called by Oracle Workflow.

Chapter 8 provides detailed information about OracleWorkflows APIs.

Chapter 9 describes the Oracle Workflow home page, whereusers and administrators can centrally access all the webbasedfeatures of Oracle Workflow.

Chapter 10 discusses how a user can view and act on a workflownotification.

Chapter 11 describes how to use the Workflow Monitor toadminister or view the status of a workflow process.

Chapter 12 describes how to launch a workflow process fortesting purposes.

Chapter 13 describes how to manage business events.

Chapter 14 describes the standard events provided with OracleWorkflow.

Chapter 15 describes the demonstration workflow processes

included with Oracle Workflow.

Chapter 16 describes the miscellaneous administrative SQLscripts included with Oracle Workflow.

Appendix A describes the Oracle Workflow Builder menus andtoolbar.

Appendix B lists the predefined workflow processes that are

included with the Oracle Applicationsembedded version ofOracle Workflow. This appendix also includes the OracleWorkflow support policy.

At the end of this guide, we include a glossary of Oracle Workflowterms.

Finding Out Whats New

If you are using the version of Oracle Workflow embedded in OracleApplications, choose the section that describes new features or whatsnew from the expandable menu in the HTML help window for OracleWorkflow. If you are using the standalone version of Oracle Workflow,choose the section that describes new features from the contents pageof the HTML help.


20/988

xviii Oracle Workflow Guide

This section describes:

New features in this release. This information is updated foreach new release of Oracle Workflow.

Information about any features that were not yet available when

this guide was printed. For example, if your systemadministrator has installed software from a mini pack as anupgrade, this document describes the new features.

Other Information Sources

You can choose from many sources of information, including onlinedocumentation, training, and support services, to increase yourknowledge and understanding of Oracle Workflow.

If this guide refers you to other Oracle Applications documentation,use only the Release 11i versions of those guides unless we specifyotherwise.

Online Documentation

If you are using the version of Oracle Workflow embedded in OracleApplications, note that all Oracle Applications documentation isavailable online (HTML and PDF). The technical reference manuals areavailable in paper format only. The HTML documentation is translatedinto over twenty languages.

The HTML version of this guide is optimized for onscreen reading, andyou can use it to follow hypertext links for easy access to other HTMLguides in the library. When you have an HTML window open, you canuse the features on the left side of the window to navigate freelythroughout all Oracle Applications documentation.

You can use the Search feature to search by words or phrases.

You can use the expandable menu to search for topics in themenu structure we provide. The Library option on the menuexpands to show all Oracle Applications HTML documentation.

You can view HTML help in the following ways:

From an application window, use the help icon or the help menuto open a new Web browser and display help about that window.

Use the documentation CD.

Use a URL provided by your system administrator.


21/988

xixPreface

Your HTML help may contain information that was not available whenthis guide was printed.

Portions of this guide are also available online in Windows Helpformat. The Windows Help version is optimized for onscreen reading

and lets you follow hypertext links to various topics. The WindowsHelp is available from the Oracle Workflow Builder Help menu.

If you are using the standalone version of Oracle Workflow, note thatthis guide is available online in HTML format, and portions of theguide are available in Windows Help format as well. The WindowsHelp is available from the Oracle Workflow Builder Help menu. TheHTML documentation is available from a URL provided by yoursystem administrator or from the help icon in the Oracle Workflow web

pages.

Related User Guides

Oracle Workflow is used by other Oracle Applications products toprovide embedded workflows. Therefore, if you are using the versionof Oracle Workflow embedded in Oracle Applications, you may want

to refer to other user guides to learn more about the embeddedworkflows.

You can read the guides online by choosing Library from theexpandable menu on your HTML help window, by reading from theOracle Applications Documentation Library CD included in yourmedia pack, or by using a Web browser with a URL that your systemadministrator provides.

If you require printed guides, you can purchase them from the Oraclestore at http://oraclestore.oracle.com.

User Guides Related to All Products

Oracle Applications Users Guide

This guide explains how to navigate the system, enter data, and queryinformation, and introduces other basic features of the GUI availablewith this release of the Oracle Applicationsembedded version ofOracle Workflow (and any other Oracle Applications product).

You can also access this guide online by choosing Getting Started andUsing Oracle Applications from the Oracle Applications help system.


22/988


23/988


24/988


25/988

consultants and support specialists with expertise in your business


26/988

xxiv Oracle Workflow Guide

consultants and support specialists with expertise in your businessarea, managing an Oracle server, and your hardware and softwareenvironment.

Documentation Accessibility

Oracles goal is to make our products, services, and supportingdocumentation accessible to the disabled community with goodusability. To that end, our documentation includes features that makeinformation available to users of assistive technology. Thisdocumentation is available in HTML format, and contains markup to

facilitate access by the disabled community. Standards will continue toevolve over time, and Oracle is actively engaged with othermarketleading technology vendors to address technical obstacles sothat our documentation can be accessible to all of our customers. Foradditional information, visit the Oracle Accessibility Program web siteat http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read thecode examples in this document. The conventions for writing coderequire that closing braces should appear on an otherwise empty line;however, JAWS may not always read a line of text that consists solelyof a bracket or brace.

Do Not Use Database Tools to Modify Oracle Workflow Data

We STRONGLY RECOMMEND that you never use SQL*Plus, OracleData Browser, database triggers, or any other tool to modify OracleWorkflow tables, unless we tell you to do so in our guides.

Oracle provides powerful tools you can use to create, store, change,retrieve, and maintain information in an Oracle database. But if youuse Oracle tools such as SQL*Plus to modify Oracle Workflow data,you risk destroying the integrity of your data and you lose the ability toaudit changes to your data.

Because Oracle Workflow tables are interrelated, any change you makeusing an Oracle Workflow user interface or API can update manytables at once. But when you modify Oracle Workflow data usinganything other than an Oracle Workflow user interface or API, you

might change a row in one table without making corresponding


27/988

xxvPreface

might change a row in one table without making correspondingchanges in related tables. If your tables get out of synchronization witheach other, you risk retrieving erroneous information and you riskunpredictable results throughout Oracle Workflow.

When you use Oracle Workflow user interfaces or APIs to modify yourdata, Oracle Workflow automatically checks that your changes arevalid. But, if you enter information into database tables using databasetools, you may store invalid information.

About Oracle

Oracle Corporation develops and markets an integrated line ofsoftware products for database management, applicationsdevelopment, decision support and office automation, as well as OracleApplications. Oracle Applications provides the Ebusiness Suite, afully integrated suite of more than 70 software modules for financialmanagement, Internet procurement, business intelligence, supply chainmanagement, manufacturing, project systems, human resources andsales and service management.

Oracle products are available for mainframes, minicomputers, personalcomputers, network computers, and personal digital assistants,enabling organizations to integrate different computers, differentoperating systems, different networks, and even different databasemanagement systems, into a single, unified computing and informationresource.

Oracle is the worlds leading supplier of software for informationmanagement, and the worlds second largest software company. Oracleoffers its database, tools, and application products, along with relatedconsulting, education and support services, in over 145 countriesaround the world.

Your FeedbackThank you for using Oracle Workflow and this guide.

We value your comments and feedback. This guide contains aReaders Comment Form which you can use to explain what you like


28/988


29/988


30/988

Integrating Systems


31/988

1 3Overview of Oracle Workflow

Oracle Workflow lets you set up subscriptions to business events whichcan launch workflows or enable messages to be propagated from onesystem to another when business events occur. You can communicateevents among systems within your own enterprise and with externalsystems as well. In this way, you can implement pointtopointmessaging integration or use Oracle Workflow as a messaging hub formore complex system integration scenarios. You can model businessprocesses that include complex routing and processing rules to handleevents powerfully and flexibly.

Major Features and Definitions

Oracle Workflow Builder

Oracle Workflow Builder lets you create, view, or modify a businessprocess with simple drag and drop operations. Using the WorkflowBuilder, you can create and modify all workflow objects, including

activities, item types, and messages. See: Workflow Processes: page1 6.

At any time you can add, remove, or change workflow activities, or setup new prerequisite relationships among activities. You can easily workwith a summarylevel model of your workflow, expanding activitieswithin the workflow as needed to greater levels of detail. And, you canoperate Oracle Workflow Builder from a desktop PC or from adisconnected laptop PC.

Workflow Engine

The Workflow Engine embedded in the Oracle database server monitorsworkflow states and coordinates the routing of activities for a process.Changes in workflow state, such as the completion of workflowactivities, are signaled to the engine via a PL/SQL API or a Java API.Based on flexiblydefined workflow rules, the engine determines whichactivities are eligible to run, and then runs them. The Workflow Enginesupports sophisticated workflow rules, including looping, branching,parallel flows, and subflows.

Business Event System

The Business Event System is an application service that uses the OracleAdvanced Queuing (AQ) infrastructure to communicate business events

between systems. The Business Event System consists of the EventM hi h l t i t b i ti t i ifi t t d


32/988

1 4 Oracle Workflow Guide

Manager, which lets you register subscriptions to significant events, andevent activities, which let you model business events within workflowprocesses.

When a local event occurs, the subscribing code is executed in the sametransaction as the code that raised the event. Subscription processing caninclude executing custom code on the event information, sending eventinformation to a workflow process, and sending event information toother queues or systems.

Workflow Definitions Loader

The Workflow Definitions Loader is a utility program that movesworkflow definitions between database and corresponding flat filerepresentations. You can use it to move workflow definitions from adevelopment to a production database, or to apply upgrades to existingdefinitions. In addition to being a standalone server program, theWorkflow Definitions Loader is also integrated into Oracle WorkflowBuilder, allowing you to open and save workflow definitions in both adatabase and file.

Complete Programmatic Extensibility

Oracle Workflow lets you include your own PL/SQL procedures orexternal functions as activities in your workflows. Without modifyingyour application code, you can have your own program run wheneverthe Workflow Engine detects that your programs prerequisites aresatisfied.

Electronic Notifications

Oracle Workflow lets you include users in your workflows to handleactivities that cannot be automated, such as approvals for requisitions orsales orders. Electronic notifications are routed to a role, which can bean individual user or a group of users. Any user associated with thatrole can act on the notification.

Each notification includes a message that contains all the information auser needs to make a decision. The information may be embedded inthe message body or attached as a separate document. Oracle Workflowinterprets each notification activity response to decide how to move onto the next workflow activity.

Electronic Mail Integration


33/988


Electronic mail (email) users can receive notifications of outstandingwork items and can respond to those notifications using their emailapplication of choice. An email notification can include an attachmentthat provides another means of responding to the notification.

InternetEnabled Workflow

Any user with access to a standard Web browser can be included in aworkflow. Web users can access a Notification Web page to see theiroutstanding work items, then navigate to additional pages to see moredetails or provide a response.

Monitoring and Administration

Workflow administrators and users can view the progress of a workitem in a workflow process by connecting to the Workflow Monitorusing a standard Web browser that supports Java. The WorkflowMonitor displays an annotated view of the process diagram for aparticular instance of a workflow process, so that users can get agraphical depiction of their work item status. The Workflow Monitoralso displays a separate status summary for the work item, the process,and each activity in the process.

If you are using the version of Oracle Workflow embedded in OracleApplications, you can also use Oracle Applications Manager as anadditional administration tool for Oracle Workflow. Oracle ApplicationsManager is a tool that provides administrative and diagnosticcapabilities for concurrent processing in Oracle Applications. For more

information, please refer to the Oracle Applications Manager onlinehelp.


34/988


35/988


We refer to the whole drawing as a process or process diagram. Theicons represent activities, and the arrows represent the transitions

between the activities. In the above example, new items are created forthe process when a user creates and submits a requisition in theappropriate application.

This process contains several workflow activities implemented asPL/SQL stored procedures, including:

Select Approverto select, according to your business rules, whoshould approve the requisition.

Verify Authorityto verify that a selected approver has thespending authority to approve the requisition.


36/988



37/988


38/988


39/988

appropriate UNIX gateway product to communicate with youremail application of choice.


40/988


To send and respond to email notifications with HTMLattachments, your email application should support HTMLattachments and you should have a Web browser application

that supports JavaScript and Frames to view the attachment.

The Web notifications and Workflow Monitor componentsrequire the Oracle HTTP Server (powered by Apache) andmod_plsql components of Oracle9i Application Server version1.0.1 or higher to be installed on a server machine.

To view notifications you need a Web browser application thatsupports JavaScript and Frames. To view the Workflow Monitor

you need a Web browser that supports Java Development Kit(JDK), Version 1.1.8 or higher and Abstract Windowing Toolkit(AWT), such as Netscape Communicator version 4.73 or a higherversion of 4.7x, or Microsoft Internet Explorer version 5.0x or 5.5.

To run external Java function activities and to use the WorkflowXML Loader, you must have Java Runtime Environment (JRE)version 1.1.8, or a higher 1.1.x version, installed.

To extract the HTML help for the standalone version of OracleWorkflow, you need an unzip utility.


41/988


42/988


43/988


44/988

Setup Flowchart

The following flowchart shows the Oracle Workflow setup steps. Somef th t i d d ti l Y d t f


45/988

2 9Setting Up Oracle Workflow

of the steps are required and some are optional. You need to performoptional steps only if you plan to use the related feature or completecertain business functions.


46/988

Step 1

Setup Steps

Partitioning Workflow Tables


47/988


If you are using the version of Oracle Workflow embedded in OracleApplications, you can optionally run a script called wfupartb.sql to

partition certain Workflow tables. This step is highly recommended forperformance gain.

The script partitions four Workflow tables and recreates the associatedindexes. The following table shows the Workflow tables and indexes onwhich the script runs.

Table Index

WF_ITEM_ACTIVITY_STATUSES WF_ITEM_ACTIVITY_STATUSES_PK

WF_ITEM_ACTIVITY_STATUSES_N1

WF_ITEM_ACTIVITY_STATUSES_N2

WF_ITEM_ACTIVITY_STATUSES_H WF_ITEM_ACTIVITY_STATUSES_H_N1

WF_ITEM_ACTIVITY_STATUSES_H_N2

WF_ITEM_ATTRIBUTE_VALUES WF_ITEM_ATTRIBUTE_VALUES_PK

WF_ITEMS WF_ITEMS_PK

WF_ITEMS_N1

WF_ITEMS_N2

WF_ITEMS_N3

Table 2 1 (Page 1 of 1)

Before running wfupartb.sql, you should back up these four tables sothat you can restore them in case the script fails.

To run the script, you must have sufficient free space on the table andindex tablespaces. During the creation of the partitioned tables, thescript requires slightly more diskspace than the underlying tables, inthe same tablespace where the underlying tables are located. Similarly,sufficient free space is required for the index tablespace.

Additionally, you should allow sufficient time for the script to run. Theamount of time needed depends on the amount of data in the tables.When the tables already contain existing data, such as after an upgradefrom a previous release, the script requires more time than it doeswhen the tables are empty, such as after a fresh installation of Oracle

Workflow. To minimize the time required, run the script as early aspossible in your setup process.

Attention: If you are running wfupartb.sql through SQL*Net,


48/988


y g p q gthen you must set the TWO_TASK variable before you begin.

The script is located in the admin/sql subdirectory under $FND_TOP.Use the script as follows:

sqlplus / @wfupartb

For example:

sqlplus apps/apps @wfupartb applsys apps apps apps

If the script fails, you must perform any necessary cleanup manually.

Since the scripts operations are DDL operations running in nologgingmode, rollback is not possible.

Context: You need to perform this step only once.


49/988


50/988


2. The Global Preferences web page displays a summary of yourcurrent global preferences. Choose Update to modify thesepreferences.


51/988


3. In the Workflow Administrator field, use the list of values to selectthe role to which you want to assign workflow administratorprivileges. Any user associated with this role can run the OracleWorkflow Find Processes web page, which provides full access toOracle Workflows administration features. In addition, any userin the administration role can view any other user s notifications.

If you want all users and roles to have workflow administrationprivileges, such as in a development environment, enter an asterisk

(*) in the Workflow Administrator field. See: Setting Up an OracleWorkflow Directory Service: page 2 19.

4. In the Workflow Web Agent field, enter the base URL of the Oracleweb agent you defined for Oracle Workflow in Oracle9iApplication Server.

Caution: The list of values fields that are implemented inmany of Oracle Workflows web pages will not function


52/988


53/988

12. Click OK once you are satisfied with your changes.

Note: These global language, territory, document home node,and notification preferences are saved to the Oracle WorkflowPreferences table for a special user name called


54/988


pWF_DEFAULTS. The workflow administrator role,

workflow web agent, and local system information is saved tothe Workflow Resources table.


55/988


56/988

Preferences web page. Individual users may override thatdefault value by changing their language in the UserPreferences web page. See: Global Preferences: page 2 13,User Preferences: page 9 5 and get_pref: page 8 117.

N t Y th L l th O l


57/988


Note: You can map the Language column over the Oracle

Workflow preferences table using the statement below. Thebenefit of this is that you can then globally set the defaultLanguage for all users in your enterprise using the GlobalPreferences web page and let individual users override thatdefault value by changing their Language in the UserPreferences web page. See: Global Preferences: page 2 13 andUser Preferences: page 9 5.

NVL(wf_pref.get_pref(USR.USER_NAME,LANGUAGE),

FNDL.NLS_LANGUAGE)

Attention: Make sure that the email templates used by theNotification Mailer to send notifications has been translated byOracle to the language you wish to set. The email templatesare delivered in a file called wfmail.wft under the subdirectory$ORACLE_HOME/wf/res/. You can check theappropriate language subdirectory to verify if the templateshave been translated to the language you wish to set. See:Modifying Your Message Templates: page 2 60.

TerritoryThe value of the database NLS_TERRITORYinitialization parameter that specifies the defaultterritorydependant formatting used in the user s notificationsession. Refer to your Oracle Database users guide orinstallation manual for the list of supported territoryconventions.

Note: You can map the Territory column over the OracleWorkflow preferences table using the statement below. The

benefit of this is that you can then globally set the defaultTerritory for all users in your enterprise using the GlobalPreferences web page and let individual users override thatdefault value by changing their Territory in the UserPreferences web page. See: Global Preferences: page 2 13,User Preferences: page 9 5 and get_pref: page 8 117.

NVL(wf_pref.get_pref(USR.USER_NAME,TERRITORY),

FNDL.NLS_TERRITORY)

Email_AddressA valid electronic mail address for this user ora mail distribution list defined by your electronic mail system.

FaxA Fax number for the user.


58/988

column to be : so that OracleWorkflow can reference the original base table where roles arestored and a unique role in that table. For example,PER_POSITION:009 represents a position whose ID is 009 andis stored in the personnel table called PER_POSITION.


59/988


p

*Display_Name Description

Notification_Preference

Language

Territory

Email_Addressif the email address is null for a given role, the

Notification Mailer sends an individual email to each userwithin the role.

Fax

Orig_System

Orig_System_ID

Expiration_Date

WF_USER_ROLES

TheWF_USER_ROLES view is an intersection of the users and roles inWF_USERS andWF_ROLES. Create this view, making sure it contains

the following columns:

User_NameThe internal name of the user as listed in the view

WF_USERS. User_Orig_SystemA code that you assign to the user directory

repository as listed in the viewWF_USERS.

User_Orig_System_IDThe primary key that identifies the userin the user directory repository as listed in the viewWF_USERS.

Role_NameThe internal name of the role as listed in the viewWF_ROLES.

Role_Orig_SystemA code that you assign to the role directoryrepository as listed in the viewWF_ROLES.

Role_Orig_System_IDThe primary key that identifies the rolein the role directory repository as listed in the viewWF_ROLES.

Attention: To take advantage of unique indexes whenquerying users, make sure you initially enter the usernames in


60/988

The unified environment maps over Oracle Human Resources tables,Oracle Application Object Library tables, various Oracle Applicationstables, and the WF_LOCAL tables.

Oracle Workflow provides a sql script that defines the WF_USERS,WF ROLES, and WF USER ROLES views that map to this unified


61/988


WF_ROLES, and WF_USER_ROLES views that map to this unified

environment. When you install Oracle Applications, you automaticallyinstall this script to create the unified environment. However, if youshould need to edit and rerun this script for whatever reason, the scriptis called wfdirhrv.sql and is located on your server in the admin/sqlsubdirectory under $FND_TOP.

Aside from the users and roles stored in WF_LOCAL_USERS andWF_LOCAL_ROLES, the default notification preference for allworkflow users and roles in the unified environment is set toMAILHTML.

" Integrating Oracle Workflow Directory Services with Native Oracle

Users

If you plan to use the standalone version of Oracle Workflow, you canmap your directory service to the native users and roles in the OracleRDBMS. You base your views on the tables DBA_USERS,

WF_LOCAL_USERS, DBA_ROLES, and WF_LOCAL_ROLES.

Oracle Workflow provides a script you can use to setup the views. Usethe wfdirouv.sql script in the Oracle Workflow sql subdirectory on yourserver. This script creates three views.

TheWF_USERS view creates a workflow user for each DBA user andany users stored inWF_LOCAL_USERS. For each DBA user, theoriginating system is called ORACLE, and the originating system ID isthe USERNAME column in DBA_USERS. The default notificationpreference for each DBA user is MAILHTML.

TheWF_ROLES view includes all users in theWF_USERS view, all rolesdefined in theWF_LOCAL_ROLES table, and all roles in DBA_ROLES,where role_name begins withWF. For each DBA role, the originatingsystem is ORACLE and the originating system ID is the ROLE column inDBA_ROLES. The default notification prefe