Oracle

Oracle Workflow
Workflow Release
Release 2.6
2.6

Introduction
Introduction
 Agenda
Agenda

•• Overview
Overview of
of Oracle
Oracle Workflow
Workflow
•• Planning
Planning and
and Creating
Creating aa Workflow
Workflow Process
Process
•• Defining
Defining Function
Function and
and Process
Process Activities
Activities
•• Diagramming
Diagramming aa Workflow
Workflow Process
Process
•• Advanced
Advanced Features
Features
 Oracle
Oracle Workflow
Workflow
The heart of e-business
•• Oracle
Oracle Workflow
Workflow automates
automates and
and streamlines
streamlines
business
business processes
processes contained
contained within
within and
and
between
between enterprises:
enterprises:
–– Add
Add personalized
personalized trading
trading partner
partner rules
rules
–– Validate
Validate self-service
self-service transactions
transactions
–– Achieve
Achieve closed
closed loop
loop business
business intelligence
intelligence
–– Approve
Approve standard
standard business
business documents
documents
–– Step
Step through
through daily
daily transaction
transaction flows
flows
 Workflow
Workflow Architecture
Architecture
Directory Services

Users Roles
Web
Notification
Worklist

Notification Services Engine Workflow

Send Execution Builder
Web Oracle
Process Application Respond Definition
Monitor Server
or Forward Administration Workflow
WebDB Loader
Cancel Monitoring
Web
Analysis
Query Query
Tools
Workflow
Definition
Files
Mail
Notification
Applications Oracle Workflow Enabled Application
Mailer

End-User Application Workflow

Client Server Oracle Server Development
Client
 Oracle
Oracle Workflow
Workflow Features
Features and
and Definitions
Definitions

•• Oracle
Oracle Workflow
Workflow Builder
Builder
•• Workflow
Workflow Engine
Engine
•• Workflow
Workflow Definitions
Definitions Loader
Loader
•• Notification
Notification System
System
•• Notification
Notification Worklist
Worklist
•• Directory
Directory Services
Services
•• Workflow
Workflow Monitor
Monitor
 Oracle
Oracle Workflow
Workflow Builder
Builder

•• Development
Development tool
tool for
for Oracle
Oracle Workflow
Workflow
–– Used
Used to
to graphically
graphically define
define and
and customize
customize the the
workflow
workflow definitions
definitions
–– Requires
Requires aa PC PC running
running Windows
Windows 95,95, 98,
98, 2000
2000
or
or Windows
Windows NT NT
•• Workflow
Workflow definitions:
definitions: youyou can
can save
save them
them toto aa
database
database oror aa flat
flat file
file
•• There
There are
are two
two parts
parts to
to the
the Workflow
Workflow Builder:
Builder:
–– Object
Object Navigator
Navigator
–– Process
Process Diagram
Diagram
Workflow
Workflow Process
Process Definition
Definition
 Supported
Supported Process
Process Constructs
Constructs

•• Looping
Looping
•• Results-based
Results-based
branching
branching

• Parallel flows
• Rendezvous
 Supported
Supported Process
Process Constructs
Constructs

•• Voting
Voting

• Timeouts
– Escalation
– Automatic
forwarding

• Subprocesses
(unlimited
hierarchy)
 Workflow
Workflow Engine
Engine

•• Is
Is embedded
embedded in in the
the Oracle8i
Oracle8i server
server
•• Uses
Uses the
the process
process definition
definition created
created with
with Oracle
Oracle
Workflow
Workflow Builder
Builder toto coordinate
coordinate the
the routing
routing ofof
activities
activities for
for the
the process
process
•• Monitors
Monitors the
the state
state of
of each
each activity
activity in
in aa workflow
workflow
process
process
•• Signals
Signals any
any changes
changes in in the
the workflow
workflow state
state to
to the
the
engine
engine using
using calls
calls to
to PL/SQL
PL/SQL oror Java
Java API’s
API’s
•• Guarantees
Guarantees consistency
consistency between
between thethe application
application
and
and the
the workflow
workflow state
state because
because of of Oracle8i
Oracle8i
transactional
transactional integrity
integrity
 Workflow
Workflow Definitions
Definitions Loader
Loader

Workflow
Builder
Workflow Workflow
Loader Engine

Workflow
Loader

Proc
ess Oracle 8 or higher
Process
Defin
Definition
itions
 Notification
Notification System
System

Notification e.g. UNIX Sendmail

Mailer or MAPI compliant
Workflow
Mail System
Engine

Workflow
Worklist
Directory Notification
Services System

Application Oracle
Applications
Screens

Oracle 8 or higher
Notification
Notification Worklist
Worklist Web
Web Page
Page
 Directory
Directory Services
Services

•• WF_USERS
WF_USERS
–– Contains
Contains information
information on
on the
the user
user names,
names,
display
display names
names for
for the
the users,
users, their
their notification
notification
preference
preference and
and their
their e-mail
e-mail addresses
addresses
•• WF_USER_ROLES
WF_USER_ROLES
–– Contains
Contains information
information on
on the
the association
association of
of the
the
users
users to
to the
the roles
roles
•• WF_ROLES
WF_ROLES
–– Contains
Contains information
information on
on the
the roles
roles of
of which
which
users
users can
can be
be members
members
Oracle
Oracle Workflow
Workflow Monitor
Monitor
Oracle
Oracle Workflow
Workflow Monitor
Monitor
Oracle
Oracle Workflow
Workflow Monitor
Monitor
 Process
Process Components
Components
Item Type

Process

Functions Notifications Subprocesses

Lookup Messages, Functions,

... Types, Lookup Notifications, ...
Attributes, Types, Lookup
PL/SQL Attributes, Types
PL/SQL

.. ... ..
. .
 Creating
Creating aa New
New Process
Process from
from Bottom
Bottom Up
Up

1.
1. Define
Define the
the item
item type
type of
of the
the process.
process.
2.
2. Define
Define the
the item
item type
type attributes
attributes for
for the
the process.
process.
3.
3. Define
Define lookup
lookup types
types and
and lookup
lookup codes.
codes.
4.
4. Define
Define messages.
messages.
5.
5. Define
Define message
message attributes.
attributes.
6.
6. Define
Define the
the activities
activities in
in the
the process
process asas Function,
Function,
Notification,
Notification, or
or Process.
Process.
7.
7. Diagram
Diagram the
the relationship
relationship of of the
the activities.
activities.
 Creating
Creating aa New
New Process
Process from
from Top
Top Down
Down

1.
1. Use
Use the
the QuickStart
QuickStart Wizard
Wizard to
to create
create the
the process
process
framework.
framework.
2.
2. Define
Define activities
activities without
without underlying
underlying dependencies.
dependencies.
3.
3. Diagram
Diagram the
the relationship
relationship ofof the
the activities.
activities.
4.
4. Define
Define item
item type
type attributes
attributes for
for the
the process.
process.
5.
5. Define
Define lookup
lookup types
types and
and lookup
lookup codes.
codes.
6.
6. Define
Define messages.
messages.
7.
7. Define
Define message
message attributes.
attributes.
8.
8. Update
Update processes,
processes, functions,
functions, and
and notifications
notifications
with
with underlying
underlying components.
components.
Defining
Defining Item
Item Types,
Types, Item
Item Attributes,
Attributes, and
and
Lookup
Lookup Types
Types
 Create
Create aa New
New Workflow
Workflow Process
Process
Definition
Definition

To
To create
create aa new
new workflow
workflow process:
process:
•• Define
Define the
the item
item type
type of
of the
the process
process
•• Define
Define item
item type
type attributes
attributes for
for the
the process
process
•• Define
Define lookup
lookup types
types and
and lookup
lookup codes
codes
•• Define
Define messages
messages
•• Define
Define message
message attributes
attributes
•• Define
Define the
the activities
activities in
in the
the process
process asas Function,
Function,
Notification,
Notification, or
or Process
Process
•• Diagram
Diagram the
the relationship
relationship of of the
the activities
activities
Quick
Quick Start
Start Wizard
Wizard
Quick
Quick Start
Start Wizard
Wizard (Continued)
(Continued)
Define
Define an
an Item
Item Type
Type
 Define
Define Item
Item Type
Type Attributes
Attributes

•• What
What should
should be
be considered
considered an
an item
item type
type attribute?
attribute?
–– Information
Information required
required byby notification
notification messages,
messages,
such
such as
as the
the display
display format
format of of aa currency
currency value
value
–– Information
Information required
required byby function
function activities,
activities,
such
such as
as values
values that
that link
link back
back to to applications
applications
data
data like
like aa person_ID
person_ID
–– Information
Information maintained
maintained by by aa workflow
workflow activity,
activity,
such
such as
as activities
activities that
that identify
identify whowho to
to forward
forward
information
information toto and
and from
from inin aa loop
loop construct
construct
Define
Define Item
Item Type
Type Attributes
Attributes (continued)
(continued)
Form
Form Attributes
Attributes

Click on form icon to launch

Oracle Applications form
 Document
Document Attributes
Attributes
You can specify the following types of documents in
the default value field:

•• PL/SQL
PL/SQL document:
document: aa document
document representing
representing data
data
from
from the
the database,
database, generated
generated from
from aa PL/SQL
PL/SQL
procedure.
procedure.
–– Ideal
Ideal for
for use
use when
when document
document content
content varies
varies
–– For
For example,
example, purchase
purchase orders
orders with
with variable
variable
number
number of of lines
lines or
or sales
sales orders
orders with
with variable
variable
lines,
lines, discounts,
discounts, and
and shipping
shipping addresses
addresses
–– DM
DM document:
document: aa document
document managed
managed byby an
an
external
external document
document management
management system
system
URL
URL Attributes
Attributes
 URL
URL Attributes
Attributes

Click on attachment icon

to launch Web browser
Define
Define Lookup
Lookup Types
Types
Define
Define Lookup
Lookup Codes
Codes
 Practice
Practice Les
Les 1-1
1-1 Overview
Overview

This
This practice
practice covers
covers the
the following
following topics:
topics:
•• Using
Using the
the QuickStart
QuickStart Wizard
Wizard
•• Drawing
Drawing transitions
transitions
•• Saving
Saving aa Process
Process
Defining
Defining aa Notification
Notification Activity
Activity
 Workflow
Workflow Terms
Terms

•• Notification
Notification Activity
Activity
–– A
A step
step to
to communicate
communicate withwith aa human
human being.
being.
A
A notification
notification activity
activity sends
sends aa message
message toto aa
user
user containing
containing thethe information
information needed
needed to
to
complete
complete the
the work.
work. TheThe notification
notification may
may oror
may
may not
not require
require aa response
response from
from the
the recipient.
recipient.
 Create
Create aa New
New Workflow
Workflow Process
Process
Definition
Definition

To
To create
create aa new
new workflow
workflow process:
process:
•• Define
Define the
the item
item type
type of
of the
the process
process
•• Define
Define item
item type
type attributes
attributes for
for the
the process
process
•• Define
Define lookup
lookup types
types and
and lookup
lookup codes
codes
•• Define
Define messages
messages
•• Define
Define message
message attributes
attributes
•• Define
Define the
the activities
activities in
in the
the process
process asas Function,
Function,
Notification,
Notification, or
or Process
Process
•• Diagram
Diagram the
the relationship
relationship of of the
the activities
activities
Define
Define aa Message
Message
Define
Define aa Message
Message
Define
Define aa Message
Message (Continued)
(Continued)
Define
Define aa Message
Message Attribute
Attribute
Define
Define aa Respond
Respond Attribute
Attribute
Respond
Respond Attributes
Attributes in
in the
the Notifications
Notifications
Web
Web Page
Page
Define
Define aa Notification
Notification Activity
Activity
Standard
Standard Voting
Voting Activity
Activity
Define
Define aa Timeout
Timeout for
for aa Notification
Notification
Define
Define aa Performer
Performer for
for aa Notification
Notification
 Practice
Practice Les
Les 2-1
2-1 Overview
Overview

This
This practice
practice covers
covers the
the following
following topics:
topics:
•• Planning
Planning aa Notification
Notification Only
Only Process
Process
•• Designing
Designing aa Process
Process Top
Top Down
Down
•• Modifying
Modifying an
an existing
existing Workflow
Workflow Definition
Definition
•• Creating
Creating Item
Item Attributes
Attributes and
and Messages
Messages
•• Setting
Setting Node
Node Properties
Properties
(message,
(message, performer,
performer, Start/End)
Start/End)
 Practice
Practice Les
Les 2-2
2-2 Overview
Overview

This
This practice
practice covers
covers the
the following
following topics:
topics:
•• Creating
Creating an
an HTML
HTML message
message body
body
•• Modifying
Modifying aa message
message
•• Modifying
Modifying aa notification
notification
•• Modifying
Modifying aa process
process diagram
diagram
 Overview
Overview of
of the
the
Workflow
Workflow Directory
Directory Service
Service
 Terms
Terms

•• Role
Role
•• Directory
Directory Repository
Repository
 Directory
Directory Service
Service Views
Views

•• WF_USERS
WF_USERS
•• WF_ROLES
WF_ROLES
•• WF_USER_ROLES
WF_USER_ROLES
 WF_USERS
WF_USERS View
View
Columns in WF_USERS contain the following
information:
•• Name:
Name: Internal
Internal name
name of
of aa user
user
•• Display
Display Name:
Name: Display
Display name
name ofof aa user
user
•• Description:
Description: Description
Description of
of aa user
user
•• Notification
Notification Preference:
Preference: AA value
value ofof MAILTEXT,
MAILTEXT,
MAILATTH,
MAILATTH, MAILHTML,
MAILHTML, QUERY
QUERY or or SUMMARY
SUMMARY to to
indicate
indicate how
how user
user prefers
prefers to
to receive
receive notifications
notifications
•• Language:
Language: NLS_LANGUAGE
NLS_LANGUAGE initialization
initialization
parameter
parameter that
that specifies
specifies the
the default
default language-
language-
dependent
dependent behavior
behavior
•• Territory:
Territory: NLS_TERRITORY
NLS_TERRITORY initialization
initialization parameter
parameter
that
that specifies
specifies the
the default
default language-dependent
language-dependent date date
and
and numeric
numeric formatting
formatting used
used
 WF_USERS
WF_USERS View
View (continued)
(continued)

•• Email_Address:
Email_Address: Valid
Valid email
email address
address for
for the
the user
user or
or
mail
mail distribution
distribution list
list
•• Fax:
Fax: A
A fax
fax number
number for
for the
the user
user
•• Orig_System:
Orig_System: Name
Name identifying
identifying the
the base
base tables
tables of
of
this
this view
view
•• Orig_System_ID:
Orig_System_ID: Primary
Primary key
key that
that identifies
identifies this
this
user
user in
in the
the base
base tables
tables
•• Status:
Status: ACTIVE,
ACTIVE, EXTLEAVE,
EXTLEAVE, INACTIVE,
INACTIVE,
TMPLEAVE
TMPLEAVE are are the
the status
status choices
choices
•• Expiration_date:
Expiration_date: Date
Date at
at which
which the
the user
user is
is no
no
longer
longer valid
valid in
in the
the directory
directory service
service
 WF_ROLES
WF_ROLES View
View

Workflow roles can be roles, positions or

responsibilities referenced in a directory repository.
The columns in WF_ROLES are similar to those in
WF_USERS view:

•• Name
Name
•• Display
Display Name
Name
•• Description
Description
•• Notification
Notification Preference
Preference
•• Language
Language
 WF_ROLES
WF_ROLES View
View (continued)
(continued)

•• Territory
Territory
•• Email_Address
Email_Address
•• Fax
Fax
•• Orig_System
Orig_System
•• Orig_System_ID
Orig_System_ID
•• Expiration_date
Expiration_date
 WF_USER_ROLES
WF_USER_ROLES View
View

WF_USER_ROLES is an intersection of the users and

roles in WF_USER and WF_ROLES.

•• User_Name:
User_Name: Internal
Internal name
name of
of the
the user
user as
as listed
listed in
in
WF_USERS
WF_USERS view view
•• User_Orig_System:
User_Orig_System: NameName assigned
assigned toto the
the
directory
directory repository
repository that
that WF_USERS
WF_USERS is is based
based on
on
•• User_Orig_System_ID:
User_Orig_System_ID: Primary
Primary key
key that
that identifies
identifies
this
this user
user in
in the
the user
user directory
directory repository
repository
 WF_USER_ROLES
WF_USER_ROLES View
View (continued)
(continued)

•• Role_Name:
Role_Name: Internal
Internal name
name of
of the
the user
user as
as listed
listed in
in
WF_ROLES
WF_ROLES view view
•• Role_Orig_System:
Role_Orig_System: Name Name assigned
assigned toto the
the
directory
directory repository
repository that
that WF_ROLES
WF_ROLES is is based
based on
on
•• Role_Orig_System_ID:
Role_Orig_System_ID: Primary
Primary key
key that
that identifies
identifies
this
this role
role in
in the
the role
role directory
directory repository
repository
 Oracle
Oracle Workflow
Workflow Local
Local Tables
Tables

•• WF_LOCAL_USERS
WF_LOCAL_USERS
•• WF_LOCAL_ROLES
WF_LOCAL_ROLES
•• WF_LOCAL_USER_ROLES
WF_LOCAL_USER_ROLES
 Implementing
Implementing Global
Global User
User Preferences
Preferences

•• Interaction
Interaction with
with Oracle
Oracle Workflow
Workflow
•• Access
Access toto the
the Global
Global Preferences
Preferences Web
Web page
page
•• Override
Override aa default
default user
user preference
preference
User
User Preference
Preference Information
Information
 Ad
Ad Hoc
Hoc Users/Roles
Users/Roles

•• You
You can
can create
create and
and manage
manage ad
ad hoc
hoc users
users and
and
roles
roles in
in aa workflow
workflow process.
process.
•• Use
Use server
server PL/SQL
PL/SQL APIs
APIs to
to dynamically
dynamically create
create new
new
user
user and
and role
role definitions
definitions in
in the
the directory
directory service.
service.
The
The new
new APIs
APIs store
store the
the information
information in in the
the
WF_LOCAL_*
WF_LOCAL_* tables.
tables.
•• The
The WF_USERS
WF_USERS and and WF_ROLES
WF_ROLES viewsviews useuse the
the
EXPIRATION_DATE.
EXPIRATION_DATE.
•• WF_LOCAL_USER_ROLES
WF_LOCAL_USER_ROLES keeps keeps track
track of
of the
the
originating
originating system
system ofof the
the users
users and
and roles.
roles.
 Directory
Directory Service
Service for
for Oracle
Oracle Applications
Applications

•• Oracle
Oracle Workflow
Workflow ships
ships aa unified
unified directory
directory service
service
for
for Oracle
Oracle Applications—wfdirhrv.sql.
Applications—wfdirhrv.sql. The The unified
unified
directory
directory service
service maps:
maps:
–– WF_USERS
WF_USERS to to Oracle
Oracle HRMS
HRMS employees,
employees,
Oracle
Oracle Application/Oracle
Application/Oracle Self-Service
Self-Service
Application
Application users,
users, Oracle
Oracle Receivables
Receivables
customer
customer contacts
contacts and
and WF_LOCAL_USERS.
WF_LOCAL_USERS.
–– WF_ROLES
WF_ROLES to to users
users in
in WF_USERS,
WF_USERS, Oracle
Oracle
HRMS
HRMS positions,
positions, Oracle
Oracle Federal
Federal HR
HR group
group
boxes,
boxes, Oracle
Oracle Applications
Applications responsibilities,
responsibilities,
Oracle
Oracle Engineering
Engineering approval
approval lists,
lists, and
and
WF_LOCAL_ROLES.
WF_LOCAL_ROLES.
 Directory
Directory Services
Services for
for Oracle
Oracle Workflow
Workflow
Standalone
Standalone Version
Version

•• Two
Two sample
sample Directory
Directory Services
Services scripts
scripts are
are located
located
in
in the
the Oracle
Oracle Workflow
Workflow sqlsql subdirectory:
subdirectory:
–– wfdirouv.sql
wfdirouv.sql maps
maps workflow
workflow users
users and
and roles
roles to
to
the
the native
native users
users and
and roles
roles defined
defined in
in the
the
Oracle
Oracle RDBMS.
RDBMS.
–– wfdircsv.sql
wfdircsv.sql maps
maps workflow
workflow users
users and
and roles
roles to
to
the
the users
users and
and roles
roles stored
stored in
in the
the Oracle
Oracle
Workflow
Workflow local
local tables.
tables.
Defining
Defining Function
Function and
and Process
Process Activities
Activities
 Objectives
Objectives

After
After this
this lesson,
lesson, you
you should
should be
be able
able to:
to:
•• Define
Define aa function
function activity
activity
•• Define
Define anan activity
activity attribute
attribute
•• Apply
Apply the
the Workflow
Workflow Engine
Engine APIs
APIs to
to your
your function
function
activities
activities
•• Define
Define aa process
process activity
activity
 Create
Create aa New
New Workflow
Workflow Process
Process
Definition
Definition

To
To create
create aa new
new workflow
workflow process:
process:
•• Define
Define the
the item
item type
type of
of the
the process
process
•• Define
Define item
item type
type attributes
attributes for
for the
the process
process
•• Define
Define lookup
lookup types
types and
and lookup
lookup codes
codes
•• Define
Define messages
messages
•• Define
Define message
message attributes
attributes
•• Define
Define the
the activities
activities in
in the
the process
process asas Function,
Function,
Notification,
Notification, or
or Process
Process
•• Diagram
Diagram the
the relationship
relationship of of the
the activities
activities
Define
Define aa Function
Function Activity
Activity
 Assigning
Assigning aa Cost
Cost to
to aa Function
Function Activity
Activity

•• Cost
Cost is
is entered
entered in
in seconds
seconds and
and converted
converted to
to
hundredths
hundredths of of aa second
second when
when stored
stored inin the
the
database.
database.
•• Assign
Assign aa high
high cost
cost to
to function
function activities
activities that
that
require
require aa large
large amount
amount of of processing
processing to to complete.
complete.
•• IfIf the
the cost
cost of
of an
an activity
activity exceeds
exceeds the
the threshold
threshold costcost
of
of thethe Workflow
Workflow Engine,
Engine, the
the activity
activity gets
gets deferred
deferred
by
by the the Workflow
Workflow Engine.
Engine.
•• A
A background
background engine
engine set
set up
up to
to poll
poll for
for deferred
deferred
activities
activities cancan execute
execute thethe deferred
deferred activity
activity at
at aa
later
later time.
time.
 Standard
Standard PL/SQL
PL/SQL API
API for
for Calling
Calling
Functions
Functions
•• All
All PL/SQL
PL/SQL stored
stored procedures
procedures called
called by
by function
function
activities
activities in
in an
an Oracle
Oracle Workflow
Workflow process
process should
should
follow
follow the
the standard
standard API
API format
format so
so that
that the
the
Workflow
Workflow Engine
Engine can
can properly
properly execute
execute the
the activity.
activity.

procedure
procedure <procedure
<procedure name>
name>
(itemtype
(itemtype in in varchar2,
varchar2,
itemkey
itemkey in
in varchar2,
varchar2,
actid
actid in
in number,
number,
funcmode
funcmode in in varchar2,
varchar2,
resultout
resultout out
out varchar2)
varchar2)
 Defining
Defining aa Standard
Standard Function
Function

•• itemtypethe
itemtypethe internal
internal name
name for
for the
the item
item type.
type.
Defined
Defined in
in the
the Oracle
Oracle Workflow
Workflow Builder.
Builder.
•• itemkeya
itemkeya string
string that
that represents
represents aa primary
primary key
key
generated
generated byby the
the workflow-enabled
workflow-enabled application
application forfor
the
the item
item type.
type. The
The string
string uniquely
uniquely identifies
identifies the
the
item
item within
within an
an item
item type.
type.
•• actidthe
actidthe IDID number
number of of the
the activity
activity that
that this
this
procedure
procedure is is called
called from.
from.
•• funcmodedetermines
funcmodedetermines the the execution
execution mode
mode of of the
the
function
function procedure.
procedure.
•• resultouta
resultouta result
result may
may be be returned
returned depending
depending on on
the
the funcmode
funcmode used used toto call
call the
the function.
function.
 Function
Function Activity
Activity Execution
Execution Modes
Modes
•• Function
Function modes:
modes:
–– RUN
RUN
–– Activities
Activities that
that are
are executed
executed for
for the
the first
first time
time
–– Follows
Follows CANCEL
CANCEL mode
mode on
on aa loop
loop reset
reset
–– CANCEL
CANCEL
–– Activities
Activities revisited
revisited as
as part
part of
of aa loop
loop reset
reset
–– Activities
Activities that
that are
are part
part of
of aa process
process that
that has
has
been
been canceled
canceled by by aa call
call to
to
WF_ENGINE.AbortProcess
WF_ENGINE.AbortProcess
–– Activities
Activities that
that are
are part
part of
of the
the process
process
stream
stream being
being undone
undone by by aa call
call to
to
WF_ENGINE.HandleError
WF_ENGINE.HandleError
 Standard
Standard PL/SQL
PL/SQL API
API Result
Result Out
Out
•• IfIf aa Result
Result Type
Type is
is specified
specified in
in the
the Activities
Activities
property
property page
page of
of the
the Activity
Activity in
in the
the Workflow
Workflow
Builder,
Builder, this
this parameter
parameter represents
represents the
the expected
expected
result
result returned
returned when
when the
the procedure
procedure completes.
completes.
Possible
Possible Resultout
Resultout values
values are:
are:
•• COMPLETE:<result_code>
COMPLETE:<result_code>
–– WAITING
WAITING
–– DEFERRED:<date>
DEFERRED:<date>
–– NOTIFIED:<notification_id>:<assigned_user>
NOTIFIED:<notification_id>:<assigned_user>
–– ERROR:<error_code>
ERROR:<error_code>
 Notification
Notification Activities
Activities Revisited
Revisited
•• All
All PL/SQL
PL/SQL stored
stored procedures
procedures referenced
referenced by
by
notification
notification activities
activities as
as aa post-notification
post-notification
function
function in
in an
an Oracle
Oracle Workflow
Workflow process
process should
should
follow
follow the
the standard
standard API
API format
format so
so that
that the
the
Workflow
Workflow Engine
Engine can
can properly
properly execute
execute the
the activity.
activity.

procedure
procedure <procedure
<procedure name>
name>
(itemtype
(itemtype in in varchar2,
varchar2,
itemkey
itemkey in
in varchar2,
varchar2,
actid
actid in
in number,
number,
funcmode
funcmode in in varchar2,
varchar2,
resultout
resultout out
out varchar2)
varchar2)
 Post-Notification
Post-Notification Function
Function
Execution
Execution Modes
Modes

•• Function
Function modes:
modes:
–– RESPOND
RESPOND
–– FORWARD
FORWARD
–– TRANSFER
TRANSFER
–– RUN
RUN
–– TIMEOUT
TIMEOUT
 PL/SQL
PL/SQL API
API Result
Result Out
Out for
for aa
Post-Notification
Post-Notification Function
Function
•• The
The Resultout
Resultout parameter
parameter is
is ignored
ignored for
for
‘RESPOND’,
‘RESPOND’, ‘FORWARD’,
‘FORWARD’, and and ‘TRANSFER’
‘TRANSFER’
function
function modes,
modes, unless
unless itit looks
looks like
like ‘ERROR%’.
‘ERROR%’. IfIf
you
you want
want to
to fail
fail the
the Respond,
Respond, Forward,
Forward, or or Transfer
Transfer
operation
operation after
after the
the post-notification
post-notification function
function has
has
executed
executed you
you can:
can:
•• return
return Resultout
Resultout == ERROR:<error_code>
ERROR:<error_code>
–– raise
raise an
an exception
exception in
in your
your procedure
procedure
 Post-Notification
Post-Notification Function
Function
Context
Context Information
Information

•• Reference
Reference Global
Global WF_ENGINE
WF_ENGINE variables
variables in
in PL/SQL
PL/SQL
•• Global
Global Context
Context Information
Information set:
set:
–– WF_ENGINE.context_nid
WF_ENGINE.context_nid == notification_ID
notification_ID
–– WF_ENGINE.context_text
WF_ENGINE.context_text == new
new recipient_role
recipient_role
available
available in
in TRANSFER
TRANSFER or
or FORWARD
FORWARD mode mode
–– WF_ENGINE.context_text
WF_ENGINE.context_text == responder
responder
available
available in
in RESPOND
RESPOND mode
mode
 Exception
Exception Handling
Handling

Debugging Function Activities

•• Use WF_CORE APIs

Use WF_CORE APIs to
to raise
raise and
and catch
catch errors
errors in
in
your
your PL/SQL
PL/SQL procedures
procedures
•• Engine
Engine sets
sets function
function activity
activity status
status “ERROR”
“ERROR” if:
if:
–– PL/SQL
PL/SQL procedure
procedure raises
raises an
an unhandled
unhandled
exception
exception
–– PL/SQL
PL/SQL procedure
procedure returns
returns aa result
result beginning
beginning
with
with “ERROR:”
“ERROR:”
 Exception
Exception Handling
Handling Example
Example

……
exception
exception
when
when others
others then
then
WF_CORE.CONTEXT (‘<package name>‘,
WF_CORE.CONTEXT (‘<package name>‘,
‘<procedure
‘<procedure name>‘,
name>‘, <itemtype>,
<itemtype>, <itemkey>,
<itemkey>,
to_char(<actid>), <funcmode>;
to_char(<actid>), <funcmode>;
raise;
raise;
end <procedure
end <procedure name>
name>
Defining
Defining aa Function
Function Activity
Activity Attribute
Attribute
Defining
Defining aa Process
Process Activity
Activity
Defining
Defining Activity
Activity Details
Details
 Looping
Looping

•• Looping
Looping occurs
occurs when
when the
the completion
completion of
of an
an activity
activity
causes
causes aa transition
transition to
to another
another activity
activity that
that has
has
already
already been
been completed.
completed.
•• The
The first
first activity
activity detected
detected asas aa revisited
revisited activity
activity is
is
also
also called
called aa loop
loop point
point or
or pivot
pivot activity.
activity.
•• The
The Workflow
Workflow Engine
Engine can
can handle
handle aa revisited
revisited
activity
activity in
in one
one of
of three
three ways:
ways:
–– Ignore
Ignore
–– Reset
Reset
–– Loop
Loop
 Looping
Looping

•• Non-canceling
Non-canceling Loop
Loop can
can improve
improve performance
performance by
by
preventing
preventing the
the rerun
rerun of
of functions
functions in
in CANCEL
CANCEL
mode.
mode.
Ignore: is for OR-type
operations where rest of
branch is ignored.

Reset: permits resetting

status by recalling
activities
in CANCEL-mode.
Loop: performs loop
without any reset.
Recommended setting.
 Practice
Practice Les
Les 3-1
3-1 Overview
Overview

This
This practice
practice covers
covers the
the following
following topics:
topics:
•• Creating
Creating aa Function
Function Activity
Activity
Overview
Overview of
of the
the Workflow
Workflow Engine
Engine
 Objectives
Objectives

After
After this
this lesson,
lesson, you
you should
should be
be able
able to:
to:
•• Give
Give aa general
general description
description of
of how
how the
the Workflow
Workflow
Engine
Engine manages
manages aa process
process
•• Apply
Apply the
the Workflow
Workflow Engine
Engine APIs
APIs to
to your
your function
function
activities
activities
 Overview
Overview of
of the
the Workflow
Workflow Engine
Engine

The Oracle Workflow Engine:

•• Is
Is implemented
implemented in
in server-side
server-side PL/SQL.
PL/SQL.
•• Is
Is activated
activated whenever
whenever aa call
call to
to one
one of
of its
its PL/SQL
PL/SQL
procedures
procedures oror functions
functions isis made.
made.
•• Manages
Manages thethe state
state of
of activities
activities for
for each
each process
process
instance.
instance.
•• Determines
Determines the
the next
next activity
activity once
once aa prerequisite
prerequisite
activity
activity completes.
completes.
•• Executes
Executes function
function activities
activities automatically.
automatically.
•• Calls
Calls the
the Notification
Notification System
System to
to send
send notification
notification
messages.
messages.
 Overview
Overview of
of the
the Workflow
Workflow Engine
Engine
(Continued)
(Continued)

•• Supports
Supports results-based
results-based branches,
branches, parallel
parallel
branches,
branches, rendezvous,
rendezvous, loops
loops and
and subprocesses.
subprocesses.
•• Can
Can execute
execute activities
activities from
from non-savepoint
non-savepoint
environments
environments such
such asas database
database triggers
triggers and
and
distributed
distributed transactions.
transactions. ItIt automatically
automatically traps
traps
savepoint-not-allowed
savepoint-not-allowed errors.
errors.
•• Can
Can defer
defer activities
activities too
too costly
costly to
to execute
execute inin real
real
time
time to
to background
background engines
engines for
for processing.
processing.
•• Maintains
Maintains aa history
history of
of completed
completed activities.
activities.
•• Detects
Detects error
error conditions
conditions and
and executes
executes error
error
processes.
processes.
 Initiating
Initiating aa Workflow
Workflow Process
Process

To start a workflow process:

•• Your
Your application
application must
must execute
execute aa procedure
procedure that
that
calls
calls the
the following
following Workflow
Workflow Engine
Engine APIs:
APIs:
–– WF_ENGINE.CreateProcess
WF_ENGINE.CreateProcess
–– WF_ENGINE.StartProcess
WF_ENGINE.StartProcess
or
or
–– WF_ENGINE.LaunchProcess
WF_ENGINE.LaunchProcess
•• The
The procedure
procedure must
must identify
identify the
the value
value of
of the
the
process
process item
item type
type and
and item
item key
key for
for these
these APIs
APIs
 Workflow
Workflow Engine
Engine Processing
Processing

Upon
Upon starting
starting aa process,
process, the
the Workflow
Workflow Engine:
Engine:
•• Identifies
Identifies and
and executes
executes the
the Start
Start activity
activity
•• Determines
Determines the
the next
next activity
activity to
to transition
transition to
to after
after
completing
completing thethe prerequisite
prerequisite activity
activity or
or activities
activities
•• Drives
Drives through
through the
the process,
process, automatically
automatically
executing
executing all
all function
function activities,
activities, until
until itit comes
comes toto aa
notification
notification or
or blocking
blocking activity
activity
•• Calls
Calls the
the Notification
Notification System
System to to notify
notify aa recipient
recipient
•• Continues
Continues driving
driving through
through the
the process
process until
until itit
encounters
encounters an
an End
End activity,
activity, (once
(once the
the performer
performer
completes
completes the
the notification
notification or
or the
the block
block activity
activity is
is
completed)
completed)
 Activity
Activity Statuses
Statuses

Once
Once the
the Workflow
Workflow Engine
Engine executes
executes anan activity,
activity, itit
updates
updates the
the state
state of
of the
the activity
activity to
to one
one of
of the
the
following
following statuses:
statuses:
•• Active
Active
•• Complete
Complete
•• Waiting
Waiting
•• Notified
Notified
•• Deferred
Deferred
•• Error
Error
•• Suspend
Suspend
 Calling
Calling the
the Workflow
Workflow Engine
Engine

•• Engine
Engine must
must be
be informed
informed when
when an
an activity
activity
completes.
completes.
–– Process,
Process, notification,
notification, and
and function
function activities
activities
automatically
automatically call call
WF_ENGINE.CompleteActivity(
WF_ENGINE.CompleteActivity( )) when when they
they
complete.
complete.
–– IfIf aa notification
notification activity
activity requires
requires some
some action
action to
to
be
be taken
taken inin aa form
form or
or Web
Web page,
page, then
then that
that form
form
or
or Web Web page
page must
must call
call
WF_ENGINE.CompleteActivity(
WF_ENGINE.CompleteActivity( )) when when thethe user
user
completes
completes the the transaction.
transaction.
–– IfIf aa function
function activity
activity calls
calls an
an external
external program,
program,
then
then code code that
that external
external program
program toto call
call
WF_ENGINE.CompleteActivity(
WF_ENGINE.CompleteActivity( )) when when itit
completes.
completes.
 Oracle
Oracle Workflow
Workflow APIs
APIs

Oracle
Oracle Workflow
Workflow APIs
APIs are
are grouped
grouped as
as follows:
follows:
•• Engine
Engine APIs
APIs
–– Starting/running
Starting/running aa process
process
–– Communicating
Communicating attribute
attribute information
information
–– Communicating
Communicating state
state changes
changes
•• Core
Core APIs:
APIs: raising
raising and
and catching
catching errors
errors
•• Purge
Purge APIs:
APIs: purging
purging obsolete
obsolete runtime
runtime data
data
•• Directory
Directory APIs:
APIs: communicating
communicating directory
directory services
services
user
user and
and role
role information
information
 Oracle
Oracle Workflow
Workflow APIs
APIs (Continued)
(Continued)

•• Monitor
Monitor APIs:
APIs: generating
generating Workflow
Workflow Monitor
Monitor URLs
URLs
•• Notification
Notification APIs:
APIs: managing
managing notifications
notifications
•• Preference
Preference APIs:
APIs: retrieving
retrieving user
user preference
preference
information
information
•• Queue
Queue APIs:
APIs: handling
handling workflow
workflow Advanced
Advanced Queues
Queues
processing
processing
•• Document
Document Management
Management APIs:
APIs: returning
returning URLs
URLs or
or
javascript
javascript functions
functions
•• Views:
Views: providing
providing public
public views
views to
to access
access workflow
workflow
data
data
 Workflow
Workflow Engine
Engine APIs
APIs

Use
Use the
the following
following APIs
APIs to
to start
start or
or run
run aa workflow
workflow
process:
process:
•• WF_ENGINE.CreateProcess
WF_ENGINE.CreateProcess
•• WF_ENGINE.StartProcess
WF_ENGINE.StartProcess
•• WF_ENGINE.LaunchProcess
WF_ENGINE.LaunchProcess
•• WF_ENGINE.SetItemOwner
WF_ENGINE.SetItemOwner
•• WF_ENGINE.SetItemUserKey
WF_ENGINE.SetItemUserKey
•• WF_ENGINE.SetItemParent
WF_ENGINE.SetItemParent
•• WF_ENGINE.background
WF_ENGINE.background
 Workflow
Workflow Engine
Engine APIs
APIs (Continued)
(Continued)

Use
Use the
the following
following APIs
APIs to
to communicate
communicate attribute
attribute
information
information toto the
the Workflow
Workflow Engine:
Engine:
•• WF_ENGINE.SetItemAttribute
WF_ENGINE.SetItemAttribute (3) (3)
•• WF_ENGINE.SetItemAttrDocument
WF_ENGINE.SetItemAttrDocument
•• WF_ENGINE.GetItemAttribute
WF_ENGINE.GetItemAttribute (3)
(3)
•• WF_ENGINE.GetItemAttrDocument
WF_ENGINE.GetItemAttrDocument
•• WF_ENGINE.GetItemAttrInfo
WF_ENGINE.GetItemAttrInfo
 Workflow
Workflow Engine
Engine APIs
APIs (Continued)
(Continued)

•• WF_ENGINE.GetActivityAttribute
WF_ENGINE.GetActivityAttribute (3)
(3)
•• WF_ENGINE.AddItemAttr
WF_ENGINE.AddItemAttr
•• WF_ENGINE.GetItemAttrInfo
WF_ENGINE.GetItemAttrInfo
•• WF_ENGINE.GetActivityAttrInfo
WF_ENGINE.GetActivityAttrInfo
 Workflow
Workflow Engine
Engine APIs
APIs (Continued)
(Continued)

Use
Use the
the following
following APIs
APIs to
to communicate
communicate state
state changes
changes
to
to the
the Workflow
Workflow Engine:
Engine:
•• WF_ENGINE.CompleteActivity
WF_ENGINE.CompleteActivity
•• WF_ENGINE.BeginActivity
WF_ENGINE.BeginActivity
•• WF_ENGINE.AssignActivity
WF_ENGINE.AssignActivity
•• WF_ENGINE.GetActivityLabel
WF_ENGINE.GetActivityLabel
•• WF_ENGINE.AbortProcess
WF_ENGINE.AbortProcess
•• WF_ENGINE.SuspendProcess
WF_ENGINE.SuspendProcess
 Workflow
Workflow Engine
Engine APIs
APIs (Continued)
(Continued)

•• WF_ENGINE.ResumeProcess
WF_ENGINE.ResumeProcess
•• WF_ENGINE.HandleError
WF_ENGINE.HandleError
•• WF_ENGINE.ItemStatus
WF_ENGINE.ItemStatus
 Background
Background Engine
Engine

The
The Background
Background Engine
Engine isis aa PL/SQL
PL/SQL procedure.
procedure.
•• The
The Background
Background Engine
Engine checks
checks forfor and
and executes
executes
any
any deferred
deferred oror timed
timed out
out activities
activities that
that satisfy
satisfy the
the
arguments
arguments of of the
the procedure
procedure at at the
the time
time the
the
procedure
procedure is is invoked.
invoked.
•• IfIf new
new activities
activities are
are deferred
deferred or or timed
timed outout after
after the
the
initiation
initiation of
of the
the current
current Background
Background Engine,Engine, the
the
procedure
procedure willwill check
check one
one more
more time
time for
for any
any new
new
activities
activities toto execute
execute prior
prior to
to ending.
ending.
•• The
The procedure
procedure ends
ends once
once all
all matching
matching activities
activities
are
are executed.
executed.
 Background
Background Engine
Engine

Background Engine API

WF_ENGINE.BACKGROUND(
itemtype in varchar2,
minthreshold in number default null,
maxthreshold in number default null,
process_deferred in boolean default TRUE,
process_timeout in boolean default TRUE);
 Deferred
Deferred Processing
Processing

•• Set
Set the
the Workflow
Workflow Engine
Engine threshold
threshold cost
cost to
to control
control
which
which activities
activities get
get deferred.
deferred.
•• The
The default
default threshold
threshold cost
cost of
of the
the Workflow
Workflow Engine
Engine
is
is set
set to
to 50.
50.
•• The
The Workflow
Workflow Engine
Engine threshold
threshold is
is an
an externalized
externalized
constant.
constant.
•• Add
Add this
this command
command to to aa form
form or
or PL/SQL
PL/SQL procedure
procedure
to
to change
change the
the threshold:
threshold:
WF_ENGINE.THRESHOLD
WF_ENGINE.THRESHOLD := := n;
n;
 Timed
Timed Out
Out Notification
Notification Activities
Activities

•• Workflow
Workflow Engine
Engine calls
calls the
the Notification
Notification System
System to
to
deliver
deliver thethe notification
notification and
and marks
marks thethe activity
activity as
as
NOTIFIED.
NOTIFIED.
•• The
The background
background Engine
Engine configured
configured forfor timed
timed out
out
activities
activities checks
checks for
for Notified
Notified activities
activities and
and
determines
determines whether
whether thethe Notified
Notified activities
activities have
have
timeout
timeout values
values that
that have
have been
been exceeded.
exceeded.
•• IfIf the
the timeout
timeout value
value is
is exceeded,
exceeded, thethe Background
Background
Engine
Engine marksmarks the
the activity
activity as
as timed
timed out
out and
and calls
calls
the
the Workflow
Workflow Engine
Engine toto follow
follow the
the <Timeout>
<Timeout>
transition.
transition.
•• Timeout
Timeout values
values may
may be
be set
set to
to an
an item
item attribute
attribute or
or
to
to aa relative
relative time
time in
in days/hours/minutes.
days/hours/minutes.
 Error
Error Processing
Processing

IfIf an
an activity
activity error
error occurs
occurs the
the Workflow
Workflow Engine:
Engine:
•• Rolls
Rolls back
back toto the
the pre-activity
pre-activity savepoint.
savepoint.
•• Sets
Sets the
the activity
activity to
to the
the ERROR
ERROR status.
status.
•• Attempts
Attempts to
to run
run an
an Error
Error Process.
Process.
 Practice
Practice Les
Les 4-1
4-1 Overview
Overview

This
This practice
practice covers
covers the
the following
following topics:
topics:
•• Creating
Creating aa Notification
Notification Timeout
Timeout
•• Adding
Adding aa Result
Result Type
Type to
to aa process
process
•• Adding
Adding an
an Error
Error Process
Process toto aa process
process
•• Running
Running aa Background
Background Engine
Engine against
against aa process
process
Completing
Completing Workflow
Workflow Notification
Notification
Activities
Activities
Oracle
Oracle Workflow
Workflow Home
Home Page
Page
Notifications
Notifications Worklist
Worklist
Notification
Notification Details
Details
 Reassigning
Reassigning Notifications
Notifications

User
List-of-values

Delegate or
Transfer
reassign options
Launching
Launching Oracle
Oracle Application
Application Forms
Forms

Click on form icon to launch

Oracle Applications form
 E-Mail
E-Mail Notification
Notification

<Place
<Place screenshot
screenshot here>
here>

Automatic
generation
of
response
template
 E-Mail
E-Mail Notification
Notification (Continued)
(Continued)

Automatic
generation
of
response
template
Monitoring
Monitoring Workflow
Workflow Processes
Processes
Workflow
Workflow Monitor
Monitor
Find
Find Processes
Processes Web
Web Page
Page
Reviewing
Reviewing the
the Process
Process List
List
Reviewing
Reviewing the
the Notifications
Notifications List
List
Filtering
Filtering Activities
Activities in
in the
the Activities
Activities List
List
Filtering
Filtering Activities
Activities in
in the
the Activities
Activities List
List
(Continued)
(Continued)
Child/Parent
Child/Parent Instances
Instances
 Practice
Practice Les
Les 5-1
5-1 Overview
Overview

This
This practice
practice covers
covers the
the following
following topics:
topics:
•• Testing
Testing PL/SQL
PL/SQL functions
functions in
in aa Workflow
Workflow Process
Process
•• Responding
Responding toto Notifications
Notifications
•• Monitoring
Monitoring the
the results
results of
of aa Work
Work Item
Item
 Practice
Practice Les
Les 5-1
5-1 Overview
Overview (Continued)
(Continued)

Using
Using the
the Vacation
Vacation Proposal
Proposal process
process created
created in
in
practice
practice Les
Les 4-1:
4-1:
•• Initiate
Initiate aa work
work item
item
•• Monitor
Monitor the
the status
status of
of your
your work
work item
item using
using the
the
Monitor
Monitor Activities
Activities List
List and
and Diagram
Diagram
•• Timeout
Timeout the
the Vacation
Vacation Proposal
Proposal notification
notification
•• Exercise
Exercise the
the Schedule
Schedule Update
Update function
function activity
activity
logic
logic
•• Exercise
Exercise Vacation
Vacation Proposal
Proposal post-notification
post-notification
function
function logic,
logic, ifif implemented
implemented
•• Debug
Debug any
any PL/SQL
PL/SQL errors
errors encountered
encountered
 Process
Process Definition
Definition Restrictions
Restrictions

•• Limited
Limited WF_ENGINE
WF_ENGINE API
API calls:
calls:
–– CreateProcess
CreateProcess
–– StartProcess
StartProcess
–– SetItemAttribute
SetItemAttribute
–– GetItemAttribute
GetItemAttribute
–– GetActivityAttribute
GetActivityAttribute
–– CompleteActivity
CompleteActivity
Purge
Purge
 Purging
Purging Obsolete
Obsolete Workflow
Workflow Data
Data

•• Purge
Purge APIs
APIs delete
delete obsolete
obsolete runtime
runtime data
data and
and
activity
activity versions
versions no
no longer
longer in
in use.
use.
•• The
The most
most commonly
commonly used
used WF_PURGE
WF_PURGE APIs:
APIs:
–– Items
Items –– purge
purge all
all runtime
runtime data
data associated
associated with
with
completed
completed items,
items, their
their processes,
processes, and
and
notifications
notifications sent
sent by
by them.
them.
–– Activities
Activities –– purge
purge obsolete
obsolete versions
versions of
of
activities
activities that
that are
are no
no longer
longer in
in use
use by
by any
any item.
item.
–– Total
Total –– purge
purge both
both item
item data
data and
and activity
activity data.
data.
–– AdHocDirectory
AdHocDirectory -- purge
purge users
users and
and roles
roles in
in the
the
WF_LOCAL_*
WF_LOCAL_* tables
tables whose
whose expiration
expiration date
date has
has
elapsed
elapsed and
and that
that are
are not
not referenced
referenced in
in any
any
notification.
notification.
 Purging
Purging Obsolete
Obsolete Workflow
Workflow Data
Data
in
in Oracle
Oracle Applications
Applications
•• Use
Use the
the concurrent
concurrent program
program Purge
Purge Obsolete
Obsolete
Workflow
Workflow Runtime
Runtime Data,
Data, short
short name
name FNDWFPR.
FNDWFPR.
•• Systems
Systems administrator
administrator should
should add
add the
the concurrent
concurrent
program
program to
to the
the security
security group
group for
for the
the
responsibility
responsibility you
you wish
wish to
to run
run this
this program
program from.
from.
•• Navigate
Navigate to
to the
the Submit
Submit Request
Request form
form inin Oracle
Oracle
Applications.
Applications.
•• Supply
Supply the
the following
following parameters:
parameters:
–– Item
Item Type
Type
–– Item
Item Key
Key
–– Age
Age
–– Persistence
Persistence Type
Type
 Purging
Purging Obsolete
Obsolete Workflow
Workflow Data
Data
in
in Oracle
Oracle Applications
Applications (continued)
(continued)