Oracle Workflow Guide

990 Pages·2001·4.637 MB·English

by  Chang S., Jaeckel C.

(cid:1)
Oracle Workflow
Guide
RELEASE 2.6.1
VOLUME 1
June 2001
(cid:1)
Oracle Workflow Guide Release 2.6.1
The part number for this volume is A90184–01. To reorder this book, please use the set part
number, A90181–01.
Copyright (cid:2) 1996, 2001, Oracle Corporation. All rights reserved.
Primary Authors: Siu Chang, Clara Jaeckel
Major Contributors: George Buzsaki, Mark Craig, Kevin Hudson, George Kellner, David
Lam, Jin Liu, Kenneth Ma, Steve Mayze, Tim Roveda, Robin Seiden, Sheryl Sheh, Susan
Stratton
The Programs (which include both the software and documentation) contain proprietary information
of Oracle Corporation; they are provided under a license agreement containing restrictions on use and
disclosure and are also protected by copyright, patent and other intellectual and industrial property
laws. 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 any
problems in the documentation, please report them to us in writing. Oracle Corporation does not
warrant 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 any
form or by any means, electronic or mechanical, for any purpose, without the express written
permission of Oracle Corporation.
If the Programs are delivered to the US Government or anyone licensing or using the Programs on
behalf of the US Government, the following notice is applicable:
RESTRICTED RIGHTS NOTICE
Programs 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 subject
to the Federal Acquisition Regulations are ’restricted computer software’ and use, duplication and
disclosure of the Programs shall be subject to the restrictions in FAR 52.227–19, Commercial Computer
Software – Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA
94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other
inherently dangerous applications. It shall be licensee’s responsibility to take all appropriate fail–safe,
back up, redundancy and other measures to ensure the safe use of such applications if the Programs
are 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, Oracle
Discoverer, 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.
Contents
VOLUME 1Volume 1 . . . . . . . . . . . . . . . . . . . . . . . . . . i
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Audience for This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
How To Use This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Finding Out What’s 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 Workflow
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Contents i
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 of
Oracle 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 Server
Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
ii Oracle Workflow Guide
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
Contents iii
System: Error Item Type and Item Attributes . . . . . . . . . . . . . 6 – 27
Default Error Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 – 28
Retry–only 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 Function
Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 – 3
Standard API for Java Procedures Called by Function
Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 – 8
Standard API for an Item Type Selector or Callback Function . . 7 – 13
Standard APIs for ”PL/SQL” and ”PL/SQL CLOB”
Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
iv Oracle Workflow Guide
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 Concurrent
Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 – 94
Workflow Directory Service APIs . . . . . . . . . . . . . . . . . . . . . . . . . . 8 – 95
GetRoleUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 – 96
Contents v
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
vi Oracle Workflow Guide
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
Contents vii
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
viii Oracle Workflow Guide