ORACLE WORKFLOW GUIDE
CONTENTS CHAPTER OVERVIEW OF ORACLE WORKFLOW 1 – INTRODUCTION TO ORACLE WORKFLOW 1 – MAJOR FEATURES AND DEFINITIONS 1 – WORKFLOW PROCESSES 1 – CHAPTER SETTING UP ORACLE WORKFLOW 2 – ORACLE WORKFLOW HARDWARE AND SOFTWARE REQUIREMENTS 2 – OVERVIEW OF SETTING UP 2 – OVERVIEW OF REQUIRED SET UP STEPS FOR THE STANDALONE VERSION OF ORACLE WORKFLOW 2 – OVERVIEW OF REQUIRED SET UP STEPS FOR THE VERSION OF ORACLE WORKFLOW EMBEDDED IN ORACLE APPLICATIONS 2 – OPTIONAL SET UP STEPS 2 – OTHER WORKFLOW FEATURES 2 – IDENTIFYING THE VERSION OF YOUR ORACLE WORKFLOW SERVER 2 – SETUP FLOWCHART 2 – SETUP CHECKLIST 2 – SETUP STEPS 2 – OVERVIEW OF ORACLE WORKFLOW ACCESS PROTECTION 2 – SETTING UP A DEFAULT ACCESS LEVEL 2 – USING THE WORKFLOW DEFINITIONS LOADER 2 – USING THE WORKFLOW XML LOADER 2 – DEFINING A WORKFLOW PROCESS 3 – OVERVIEW OF ORACLE WORKFLOW BUILDER 3 – THE NAVIGATOR TREE STRUCTURE 3 – VIEWING THE NAVIGATOR TREE 3 – CREATING PROCESS DEFINITIONS IN ORACLE WORKFLOW BUILDER 3 – OPENING AND SAVING ITEM TYPES 3 – QUICK START WIZARD OVERVIEW 3 – USING ORACLE WORKFLOW BUILDER WITH DIFFERENT SERVER VERSIONS 3 – ITEM TYPE DEFINITION WEB PAGE 3 – DEFINING WORKFLOW PROCESS COMPONENTS 4 – WORKFLOW PROCESS COMPONENTS 4 – ITEM TYPES 4 – ALLOWING ACCESS TO AN OBJECT 4 – LOOKUP TYPES 4 – MESSAGES 4 – ACTIVITIES 4 – VOTING ACTIVITY 4 – DELETING OBJECTS IN ORACLE WORKFLOW BUILDER 4 – MODIFYING OBJECTS IN ORACLE WORKFLOW BUILDER 4 – WORKFLOW OBJECTS THAT SUPPORT VERSIONING 4 – WORKFLOW OBJECTS THAT DO NOT SUPPORT VERSIONING 4 – DEFINING A WORKFLOW PROCESS DIAGRAM 5 – PROCESS WINDOW 5 – MODIFYING FONTS IN ORACLE WORKFLOW BUILDER 5 – CREATING A SHORTCUT ICON FOR A WORKFLOW PROCESS 5 – ROLES 5 – PREDEFINED WORKFLOW ACTIVITIES 6 – STANDARD ACTIVITIES 6 – AND/OR ACTIVITIES 6 – COMPARISON ACTIVITIES 6 – COMPARE EXECUTION TIME ACTIVITY 6 – WAIT ACTIVITY 6 – BLOCK ACTIVITY 6 – DEFER THREAD ACTIVITY 6 – LAUNCH PROCESS ACTIVITY 6 – NOOP ACTIVITY 6 – LOOP COUNTER ACTIVITY 6 – START ACTIVITY 6 – END ACTIVITY 6 – ROLE RESOLUTION ACTIVITY 6 – NOTIFY ACTIVITY 6 – VOTE YES/NO ACTIVITY 6 – MASTER/DETAIL COORDINATION ACTIVITIES 6 – WAIT FOR FLOW ACTIVITY 6 – CONTINUE FLOW ACTIVITY 6 – ASSIGN ACTIVITY 6 – GET MONITOR URL ACTIVITY 6 – GET EVENT PROPERTY ACTIVITY 6 – SET EVENT PROPERTY ACTIVITY 6 – COMPARE EVENT PROPERTY ACTIVITY 6 – XML GET TAG VALUE ACTIVITY 6 – XML COMPARE TAG VALUE ACTIVITIES 6 – XML TRANSFORM ACTIVITY 6 – CONCURRENT MANAGER STANDARD ACTIVITIES 6 – EXECUTE CONCURRENT PROGRAM ACTIVITY 6 – SUBMIT CONCURRENT PROGRAM ACTIVITY 6 – WAIT FOR CONCURRENT PROGRAM ACTIVITY 6 – DEFAULT ERROR PROCESS 6 – SYSTEM: ERROR ITEM TYPE AND ITEM ATTRIBUTES 6 – RETRY–ONLY PROCESS 6 – DEFAULT EVENT ERROR PROCESS 6 – DEFINING PROCEDURES AND FUNCTIONS FOR ORACLE WORKFLOW 7 – STANDARD API FOR PL/SQL PROCEDURES CALLED BY FUNCTION ACTIVITIES 7 – STANDARD API FOR JAVA PROCEDURES CALLED BY FUNCTION ACTIVITIES 7 – STANDARD API FOR AN ITEM TYPE SELECTOR OR CALLBACK FUNCTION 7 – STANDARD APIS FOR ”PL/SQL” AND ”PL/SQL CLOB” DOCUMENTS 7 – ”PL/SQL” DOCUMENTS 7 – ”PL/SQL CLOB” DOCUMENTS 7 – STANDARD API FOR AN EVENT DATA GENERATE FUNCTION 7 – STANDARD APIS FOR A QUEUE HANDLER 7 – ENQUEUE 7 – DEQUEUE 7 – STANDARD API FOR AN EVENT SUBSCRIPTION RULE FUNCTION 7 – ORACLE WORKFLOW APIS 8 – ORACLE WORKFLOW PROCEDURES AND FUNCTIONS 8 – OVERVIEW OF THE WORKFLOW ENGINE 8 – ORACLE WORKFLOW JAVA INTERFACE 8 – ADDITIONAL WORKFLOW ENGINE FEATURES 8 – WORKFLOW ENGINE APIS 8 – CREATEPROCESS 8 – SETITEMUSERKEY 8 – GETITEMUSERKEY 8 – GETACTIVITYLABEL 8 – SETITEMOWNER 8 – STARTPROCESS 8 – LAUNCHPROCESS 8 – SUSPENDPROCESS 8 – RESUMEPROCESS 8 – ABORTPROCESS 8 – CREATEFORKPROCESS 8 – STARTFORKPROCESS 8 – BACKGROUND 8 – ADDITEMATTRIBUTE 8 – ADDITEMATTRIBUTEARRAY 8 – SETITEMATTRIBUTE 8 – SETITEMATTRDOCUMENT 8 – SETITEMATTRIBUTEARRAY 8 – GETITEMTYPES 8 – GETITEMATTRIBUTE 8 – GETITEMATTRDOCUMENT 8 – GETITEMATTRCLOB 8 – GETITEMATTRIBUTES 8 – GETITEMATTRINFO 8 – GETACTIVITYATTRINFO 8 – GETACTIVITYATTRIBUTE 8 – GETACTIVITYATTRCLOB 8 – BEGINACTIVITY 8 – COMPLETEACTIVITY 8 – COMPLETEACTIVITYINTERNALNAME 8 – ASSIGNACTIVITY 8 – EVENT 8 – HANDLEERROR 8 – SETITEMPARENT 8 – ITEMSTATUS 8 – GETPROCESSSTATUS 8 – WORKFLOW CORE APIS 8 – CLEAR 8 – GET_ERROR 8 – TOKEN 8 – RAISE 8 – CONTEXT 8 – TRANSLATE 8 – WORKFLOW PURGE APIS 8 – ITEMS 8 – ACTIVITIES 8 – NOTIFICATIONS 8 – TOTAL 8 – TOTALPERM 8 – ADHOCDIRECTORY 8 – PURGE OBSOLETE WORKFLOW RUNTIME DATA CONCURRENT PROGRAM 8 – WORKFLOW DIRECTORY SERVICE APIS 8 – GETROLEUSERS 8 – GETUSERROLES 8 – GETROLEINFO 8 – 8 – ISPERFORMER 8 – USERACTIVE 8 – GETUSERNAME 8 – GETROLENAME 8 – GETROLEDISPLAYNAME 8 – SETADHOCUSERSTATUS 8 – SETADHOCROLESTATUS 8 – CREATEADHOCUSER 8 – CREATEADHOCROLE 8 – ADDUSERSTOADHOCROLE 8 – SETADHOCUSEREXPIRATION 8 – SETADHOCROLEEXPIRATION 8 – SETADHOCUSERATTR 8 – SETADHOCROLEATTR 8 – REMOVEUSERSFROMADHOCROLE 8 – WORKFLOW PREFERENCES API 8 – GET_PREF 8 – WORKFLOW MONITOR APIS 8 – GETACCESSKEY 8 – GETDIAGRAMURL 8 – GETENVELOPEURL 8 – GETADVANCEDENVELOPEURL 8 – ORACLE WORKFLOW VIEWS 8 – WF_ITEM_ACTIVITY_STATUSES_V 8 – WF_NOTIFICATION_ATTR_RESP_V 8 – WF_RUNNABLE_PROCESSES_V 8 – WF_ITEMS_V 8 – WORKFLOW QUEUE APIS 8 – ENQUEUEINBOUND 8 – DEQUEUEOUTBOUND 8 – DEQUEUEEVENTDETAIL 8 – PURGEEVENT 8 – PURGEITEMTYPE 8 – PROCESSINBOUNDQUEUE 8 – GETMESSAGEHANDLE 8 – DEQUEUEEXCEPTION 8 – DEFERREDQUEUE 8 – INBOUNDQUEUE 8 – OUTBOUNDQUEUE 8 – CLEARMSGSTACK 8 – CREATEMSG 8 – WRITEMSG 8 – SETMSGATTR 8 – SETMSGRESULT 8 – DOCUMENT MANAGEMENT APIS 8 – GET_LAUNCH_DOCUMENT_URL 8 – GET_LAUNCH_ATTACH_URL 8 – GET_OPEN_DM_DISPLAY_WINDOW 8 – GET_OPEN_DM_ATTACH_WINDOW 8 – SET_DOCUMENT_ID_HTML 8 – OVERVIEW OF THE ORACLE WORKFLOW NOTIFICATION SYSTEM 8 – NOTIFICATION MODEL 8 – NOTIFICATION APIS 8 – SEND 8 – CUSTOM CALLBACK FUNCTION 8 – SENDGROUP 8 – FORWARD 8 – TRANSFER 8 – CANCEL 8 – CANCELGROUP 8 – RESPOND 8 – RESPONDER 8 – VOTECOUNT 8 – OPENNOTIFICATIONSEXIST 8 – CLOSE 8 – ADDATTR 8 – SETATTRIBUTE 8 – GETATTRINFO 8 – GETINFO 8 – GETTEXT 8 – GETSHORTTEXT 8 – GETATTRIBUTE 8 – GETATTRDOC 8 – GETSUBJECT 8 – GETBODY 8 – GETSHORTBODY 8 – TESTCONTEXT 8 – ACCESSCHECK 8 – WORKCOUNT 8 – GETNOTIFICATIONS 8 – GETNOTIFICATIONATTRIBUTES 8 – WRITETOCLOB 8 – OVERVIEW OF THE ORACLE WORKFLOW BUSINESS EVENT SYSTEM 8 – BUSINESS EVENT SYSTEM DATATYPES 8 – AGENT STRUCTURE 8 – GETNAME 8 – GETSYSTEM 8 – SETNAME 8 – SETSYSTEM 8 – PARAMETER STRUCTURE 8 – GETVALUE 8 – SETVALUE 8 – PARAMETER LIST STRUCTURE 8 – EVENT MESSAGE STRUCTURE 8 – INITIALIZE 8 – GETPRIORITY 8 – GETSENDDATE 8 – GETRECEIVEDATE 8 – GETCORRELATIONID 8 – GETPARAMETERLIST 8 – GETEVENTNAME 8 – GETEVENTKEY 8 – GETEVENTDATA 8 – GETFROMAGENT 8 – GETTOAGENT 8 – GETERRORSUBSCRIPTION 8 – GETERRORMESSAGE 8 – GETERRORSTACK 8 – SETPRIORITY 8 – SETSENDDATE 8 – SETRECEIVEDATE 8 – SETCORRELATIONID 8 – SETPARAMETERLIST 8 – SETEVENTNAME 8 – SETEVENTKEY 8 – SETEVENTDATA 8 – SETFROMAGENT 8 – SETTOAGENT 8 – SETERRORSUBSCRIPTION 8 – SETERRORMESSAGE 8 – SETERRORSTACK 8 – CONTENT 8 – ADDRESS 8 – ADDPARAMETERTOLIST 8 – GETVALUEFORPARAMETER 8 – EXAMPLE FOR USING ABSTRACT DATATYPES 8 – MAPPING BETWEEN WF_EVENT_T AND OMBAQ_TEXT_MSG 8 – EVENT APIS 8 – RAISE 8 – NEWAGENT 8 – TEST 8 – ENQUEUE 8 – LISTEN 8 – WORKFLOW LISTEN PROCESS CONCURRENT PROGRAM 8 – SETERRORINFO 8 – EVENT SUBSCRIPTION RULE FUNCTION APIS 8 – DEFAULT_RULE 8 – LOG 8 – ERROR 8 – WARNING 8 – SUCCESS 8 – WORKFLOW_PROTOCOL 8 – ERROR_RULE 8 – EVENT FUNCTION APIS 8 – PARAMETERS 8 – SUBSCRIPTIONPARAMETERS 8 – ADDCORRELATION 8 – GENERATE 8 – RECEIVE 8 – BUSINESS EVENT SYSTEM REPLICATION APIS 8 – WF_EVENTS DOCUMENT TYPE DEFINITION 8 – WF_EVENTS_PKG GENERATE 8 – WF_EVENTS_PKG RECEIVE 8 – WF_EVENT_GROUPS DOCUMENT TYPE DEFINITION 8 – WF_EVENT_GROUPS_PKG GENERATE 8 – WF_EVENT_GROUPS_PKG RECEIVE 8 – WF_SYSTEMS DOCUMENT TYPE DEFINITION 8 – WF_SYSTEMS_PKG GENERATE 8 – WF_SYSTEMS_PKG RECEIVE 8 – WF_AGENTS DOCUMENT TYPE DEFINITION 8 – WF_AGENTS_PKG GENERATE 8 – WF_AGENTS_PKG RECEIVE 8 – WF_EVENT_SUBSCRIPTIONS DOCUMENT TYPE DEFINITION 8 – WF_EVENT_SUBSCRIPTIONS_PKG GENERATE 8 – WF_EVENT_SUBSCRIPTIONS_PKG RECEIVE 8 – I CHAPTER ORACLE WORKFLOW HOME PAGE 9 – ACCESSING THE ORACLE WORKFLOW HOME PAGE 9 – SETTING USER PREFERENCES 9 – VIEWING NOTIFICATIONS AND PROCESSING RESPONSES 10 – OVERVIEW OF NOTIFICATION HANDLING 10 – REVIEWING NOTIFICATIONS VIA ELECTRONIC MAIL 10 – VIEWING NOTIFICATIONS FROM A WEB BROWSER 10 – REVIEWING A SUMMARY OF YOUR NOTIFICATIONS VIA ELECTRONIC MAIL 10 – DEFINING RULES FOR AUTOMATIC NOTIFICATION PROCESSING 10 – DOCUMENT MANAGEMENT INTEGRATION IN NOTIFICATIONS 10 – MONITORING WORKFLOW PROCESSES 11 – OVERVIEW OF WORKFLOW MONITORING 11 – WORKFLOW MONITOR 11 – WORKFLOW MONITOR ACCESS 11 – TESTING A WORKFLOW DEFINITION 12 – TESTING WORKFLOW DEFINITIONS 12 – MANAGING BUSINESS EVENTS 13 – EVENTS 13 – SYSTEMS 13 – AGENTS 13 – EVENT SUBSCRIPTIONS 13 – SETTING UP MESSAGE PROPAGATION 13 – RAISING EVENTS 13 – SIGNING UP SYSTEMS 13 – SYNCHRONIZING SYSTEMS 13 – REVIEWING LOCAL QUEUES 13 – WORKFLOW AGENT PING/ACKNOWLEDGE 13 – THE WORKFLOW AGENT PING/ACKNOWLEDGE ITEM TYPE 13 – SUMMARY OF THE MASTER PING PROCESS 13 – MASTER PING PROCESS ACTIVITIES 13 – SUMMARY OF THE DETAIL PING PROCESS 13 – DETAIL PING PROCESS ACTIVITIES 13 – PREDEFINED WORKFLOW EVENTS 14 – EVENT DEFINITION EVENTS 14 – EVENT GROUP DEFINITION EVENTS 14 – SYSTEM DEFINITION EVENTS 14 – AGENT DEFINITION EVENTS 14 – EVENT SUBSCRIPTION DEFINITION EVENTS 14 – SYNCHRONIZE EVENT SYSTEMS EVENT 14 – SEED EVENT GROUP 14 – PING AGENT EVENTS 14 – SYSTEM SIGNUP EVENT 14 – ANY EVENT 14 – UNEXPECTED EVENT 14 – WORKFLOW SEND PROTOCOL 14 – THE WORKFLOW SEND PROTOCOL ITEM TYPE 14 – SUMMARY OF THE WORKFLOW EVENT PROTOCOL PROCESS 14 – WORKFLOW EVENT PROTOCOL PROCESS ACTIVITIES 14 – WORKFLOW SEND PROTOCOL EVENTS 14 – DEMONSTRATION WORKFLOW PROCESSES 15 – SAMPLE WORKFLOW PROCESSES 15 – DISPLAYING THE PROCESS DIAGRAM OF A SAMPLE WORKFLOW 15 – REQUISITION PROCESS 15 – INSTALLING THE REQUISITION DATA MODEL 15 – INITIATING THE REQUISITION WORKFLOW 15 – THE REQUISITION ITEM TYPE 15 – SUMMARY OF THE REQUISITION APPROVAL PROCESS 15 – REQUISITION PROCESS ACTIVITIES 15 – SUMMARY OF THE NOTIFY APPROVER SUBPROCESS 15 – NOTIFY APPROVER SUBPROCESS ACTIVITIES 15 – SAMPLE STARTPROCESS FUNCTION 15 – EXAMPLE FUNCTION ACTIVITIES 15 – EXAMPLE: SELECT APPROVER 15 – EXAMPLE: VERIFY AUTHORITY 15 – EXAMPLE NOTIFICATION ACTIVITY 15 – EXAMPLE: NOTIFY REQUISITION APPROVAL REQUIRED 15 – PRODUCT SURVEY PROCESS 15 – INSTALLING THE PRODUCT SURVEY DATA MODEL 15 – INITIATING THE PRODUCT SURVEY WORKFLOW 15 – THE PRODUCT SURVEY ITEM TYPE 15 – SUMMARY OF THE SURVEY – SINGLE PROCESS 15 – SURVEY – SINGLE PROCESS ACTIVITIES 15 – SUMMARY OF THE SURVEY – MASTER/DETAIL PROCESS 15 – SURVEY – MASTER/DETAIL PROCESS ACTIVITIES 15 – SUMMARY OF THE DETAIL SURVEY PROCESS 15 – DETAIL SURVEY PROCESS ACTIVITIES 15 – DOCUMENT REVIEW PROCESS 15 – THE DOCUMENT MANAGEMENT ITEM TYPE 15 – SUMMARY OF THE DOCUMENT REVIEW PROCESS 15 – DOCUMENT REVIEW PROCESS ACTIVITIES 15 – ERROR CHECK PROCESS 15 – THE PERIODIC ALERT ITEM TYPE 15 – SUMMARY OF THE ERROR CHECK PROCESS 15 – ERROR CHECK PROCESS ACTIVITIES 15 – SUMMARY OF THE USER DEFINED ALERT ACTION PROCESS 15 – USER DEFINED ALERT ACTION PROCESS ACTIVITIES 15 – EVENT SYSTEM DEMONSTRATION 15 – INSTALLING THE EVENT SYSTEM DEMONSTRATION DATA MODEL 15 – INITIATING THE EVENT SYSTEM DEMONSTRATION WORKFLOW 15 – THE EVENT SYSTEM DEMONSTRATION ITEM TYPE 15 – SUMMARY OF THE BUYER: TOP LEVEL PO PROCESS 15 – BUYER: TOP LEVEL PO PROCESS ACTIVITIES 15 – SUMMARY OF THE BUYER: SEND PO TO SUPPLIER SUBPROCESS 15 – BUYER: SEND PO TO SUPPLIER SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE BUYER: RECEIVE SUPPLIER PO ACKNOWLEDGEMENT SUBPROCESS 15 – BUYER: RECEIVE SUPPLIER PO ACKNOWLEDGEMENT SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE BUYER: ADVANCED SHIPMENT NOTICE SUBPROCESS 15 – BUYER: ADVANCED SHIPMENT NOTICE SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE BUYER: RECEIVE SUPPLIER INVOICING SUBPROCESS 15 – BUYER: RECEIVE SUPPLIER INVOICING SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE SUPPLIER: TOP LEVEL ORDER PROCESS 15 – SUPPLIER: TOP LEVEL ORDER PROCESS ACTIVITIES 15 – SUMMARY OF THE SUPPLIER: GET ORDER DETAILS SUBPROCESS 15 – SUPPLIER: GET ORDER DETAILS SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE SUPPLIER: CREDIT CHECK SUBPROCESS 15 – SUPPLIER: CREDIT CHECK SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE SUPPLIER: STOCK CHECK SUBPROCESS 15 – SUPPLIER: STOCK CHECK SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE SUPPLIER: ADVANCED SHIPMENT NOTICE SUBPROCESS 15 – SUPPLIER: ADVANCED SHIPMENT NOTICE SUBPROCESS ACTIVITIES 15 – SUMMARY OF THE SUPPLIER: SEND SUPPLIER INVOICE SUBPROCESS 15 – SUPPLIER: SEND SUPPLIER INVOICE SUBPROCESS ACTIVITIES 15 – B2B PURCHASE ORDER EVENT 15 – B2B PURCHASE ORDER ACKNOWLEDGEMENT EVENT 15 – B2B ADVANCED SHIPMENT NOTICE EVENT 15 – B2B INVOICE EVENT 15 – WORKFLOW ADMINISTRATION SCRIPTS 16 – MISCELLANEOUS SQL SCRIPTS 16 – FNDWFLST 16 – FNDWFPR 16 – WFNLADD SQL 16 – WFAGTLST SQL 16 – WFBKG SQL 16 – WFBKGCHK SQL 16 – WFCHACT SQL 16 – WFCHACTA SQL 16 – WFCHITA SQL 16 – WFCHITT SQL 16 – WFCHLUC SQL 16 – WFCHLUT SQL 16 – WFCHMSG SQL 16 – WFCHMSGA SQL 16 – WFDIRCHK SQL 16 – WFEVTENQ SQL 16 – WFJVSTOP SQL 16 – WFNLENA SQL 16 – WFNTFSH SQL 16 – WFPROT SQL 16 – WFQCLEAN SQL 16 – WFREFCHK SQL 16 – WFRETRY SQL 16 – WFRMALL SQL 16 – WFRMITA SQL 16 – WFRMITMS SQL 16 – WFRMITT SQL 16 – WFRMTYPE SQL 16 – WFRUN SQL 16 – WFSTAT SQL 16 – WFSTATUS SQL 16 – WFSTDCHK SQL 16 – WFVER SQL 16 – WFVERCHK SQL 16 – WFVERUPD SQL 16 – C H A P T E R T 1 –