Previous	Next		Contents	Index	Glossary

1 Overview of Oracle Workflow

Overview of Oracle Workflow

Major Features and Definitions

Workflow Processes

Oracle Workflow Procedures and Functions

2 Workflow Engine APIs

Overview of the Workflow Engine

Oracle Workflow Java Interface

Additional Workflow Engine Features

Workflow Engine APIs

CreateProcess

SetItemUserKey

GetItemUserKey

GetActivityLabel

SetItemOwner

StartProcess

LaunchProcess

SuspendProcess

ResumeProcess

AbortProcess

CreateForkProcess

StartForkProcess

Background

AddItemAttribute

AddItemAttributeArray

SetItemAttribute

setItemAttrFormattedDate

SetItemAttrDocument

SetItemAttributeArray

getItemTypes

GetItemAttribute

GetItemAttrDocument

GetItemAttrClob

getItemAttributes

GetItemAttrInfo

GetActivityAttrInfo

GetActivityAttribute

GetActivityAttrClob

getActivityAttributes

BeginActivity

CompleteActivity

CompleteActivityInternalName

AssignActivity

Event

HandleError

SetItemParent

ItemStatus

getProcessStatus

Workflow Function APIs

loadItemAttributes

loadActivityAttributes

getActivityAttr

getItemAttr

setItemAttrValue

execute

Workflow Attribute APIs

WFAttribute

value

getName

getValue

getType

getFormat

getValueType

toString

compareTo

Workflow Core APIs

CLEAR

GET_ERROR

TOKEN

RAISE

CONTEXT

TRANSLATE

Workflow Purge APIs

Items

Activities

Notifications

Total

TotalPERM

Directory

Purge Obsolete Workflow Runtime Data Concurrent Program

Workflow Monitor APIs

GetAccessKey

GetDiagramURL

GetEnvelopeURL

GetAdvancedEnvelopeURL

Workflow Status Monitor APIs

GetEncryptedAccessKey

GetEncryptedAdminMode

IsMonitorAdministrator

Oracle Workflow Views

WF_ITEM_ACTIVITY_STATUSES_V

WF_NOTIFICATION_ATTR_RESP_V

WF_RUNNABLE_PROCESSES_V

WF_ITEMS_V

3 Directory Service APIs

Workflow Directory Service APIs

GetRoleUsers

GetUserRoles

GetRoleInfo

GetRoleInfo2

IsPerformer

UserActive

GetUserName

GetRoleName

GetRoleDisplayName

CreateAdHocUser

CreateAdHocRole

CreateAdHocRole2

AddUsersToAdHocRole

AddUsersToAdHocRole2

RemoveUsersFromAdHocRole

SetAdHocUserStatus

SetAdHocRoleStatus

SetAdHocUserExpiration

SetAdHocRoleExpiration

SetAdHocUserAttr

SetAdHocRoleAttr

ChangeLocalUserName

IsMLSEnabled

Workflow LDAP APIs

Synch_changes

Synch_all

Schedule_changes

Workflow Local Synchronization APIs

Propagate_User

Propagate_Role

PropagateUserRole

Workflow Role Hierarchy APIs

AddRelationship

ExpireRelationship

GetRelationships

GetAllRelationships

Workflow Preferences API

get_pref

4 Notification System APIs

Overview of the Oracle Workflow Notification System

Notification Model

Notification Document Type Definition

Notification APIs

Send

Custom Callback Function

SendGroup

Forward

Transfer

Cancel

CancelGroup

Respond

Responder

NtfSignRequirementsMet

VoteCount

OpenNotificationsExist

Close

AddAttr

SetAttribute

GetAttrInfo

GetInfo

GetText

GetShortText

GetAttribute

GetAttrDoc

GetSubject

GetBody

GetShortBody

TestContext

AccessCheck

WorkCount

getNotifications

getNotificationAttributes

WriteToClob

Denormalize_Notification

SubstituteSpecialChars

Notification Mailer Utility API

EncodeBlob

5 Business Event System APIs

Overview of the Oracle Workflow Business Event System

Business Event System Datatypes

Agent Structure

getName

getSystem

setName

setSystem

Parameter Structure

getName

getValue

setName

setValue

Parameter List Structure

Event Message Structure

Initialize

getPriority

getSendDate

getReceiveDate

getCorrelationID

getParameterList

getEventName

getEventKey

getEventData

getFromAgent

getToAgent

getErrorSubscription

getErrorMessage

getErrorStack

setPriority

setSendDate

setReceiveDate

setCorrelationID

setParameterList

setEventName

setEventKey

setEventData

setFromAgent

setToAgent

setErrorSubscription

setErrorMessage

setErrorStack

Content

Address

AddParameterToList

GetValueForParameter

Example for Using Abstract Datatypes

Mapping Between WF_EVENT_T and SYS.AQ$_JMS_TEXT_MESSAGE

Event APIs

Raise

Raise3

Send

NewAgent

Test

Enqueue

Listen

SetErrorInfo

SetDispatchMode

AddParameterToList

AddParameterToListPos

GetValueForParameter

GetValueForParameterPos

SetMaxNestedRaise

GetMaxNestedRaise

Event Subscription Rule Function APIs

Default_Rule

Log

Error

Warning

Success

Workflow_Protocol

Error_Rule

SetParametersIntoParameterList

Default_Rule2

Default_Rule3

SendNotification

Instance_Default_Rule

Event Function APIs

Parameters

SubscriptionParameters

AddCorrelation

Generate

Receive

Business Event System Replication APIs

WF_EVENTS Document Type Definition

WF_EVENTS_PKG.Generate

WF_EVENTS_PKG.Receive

WF_EVENT_GROUPS Document Type Definition

WF_EVENT_GROUPS_PKG.Generate

WF_EVENT_GROUPS_PKG.Receive

WF_SYSTEMS Document Type Definition

WF_SYSTEMS_PKG.Generate

WF_SYSTEMS_PKG.Receive

WF_AGENTS Document Type Definition

WF_AGENTS_PKG.Generate

WF_AGENTS_PKG.Receive

WF_AGENT_GROUPS Document Type Definition

WF_AGENT_GROUPS_PKG.Generate

WF_AGENT_GROUPS_PKG.Receive

WF_EVENT_SUBSCRIPTIONS Document Type Definition

WF_EVENT_SUBSCRIPTIONS_PKG.Generate

WF_EVENT_SUBSCRIPTIONS_PKG.Receive

Business Event System Cleanup API

Cleanup_Subscribers

6 Workflow Queue APIs

Workflow Queue APIs

EnqueueInbound

DequeueOutbound

DequeueEventDetail

PurgeEvent

PurgeItemType

ProcessInboundQueue

GetMessageHandle

DequeueException

DeferredQueue

InboundQueue

OutboundQueue

ClearMsgStack

CreateMsg

WriteMsg

SetMsgAttr

SetMsgResult

7 Document Management APIs

Document Management APIs

get_launch_document_url

get_launch_attach_url

get_open_dm_display_window

get_open_dm_attach_window

set_document_id_html