Oracle Workflow Guide

Contents......Page 3
Preface......Page 17
How To Use This Guide......Page 18
Finding Out What’s New......Page 19
Other Information Sources......Page 20
Do Not Use Database Tools to Modify Oracle Workflow Data......Page 26
Your Feedback......Page 27
1 Overview of Oracle Workflow......Page 29
Introduction to Oracle Workflow......Page 30
Major Features and Definitions......Page 31
Workflow Processes......Page 34
2 Setting Up Oracle Workflow......Page 37
Oracle Workflow Hardware and Software Requirements......Page 38
Overview of Required Set Up Steps for the Standalone Version of Oracle Workflow......Page 41
Optional Set Up Steps......Page 42
Other Workflow Features......Page 43
Identifying the Version of Your Oracle Workflow Server......Page 44
Setup Flowchart......Page 45
Setup Checklist......Page 46
Setup Steps......Page 47
Overview of Oracle Workflow Access Protection......Page 121
Setting Up a Default Access Level......Page 125
Using the Workflow Definitions Loader......Page 127
Using the Workflow XML Loader......Page 132
3 Defining a Workflow Process......Page 139
Overview of Oracle Workflow Builder......Page 140
The Navigator Tree Structure......Page 141
Viewing the Navigator Tree......Page 142
Creating Process Definitions in Oracle Workflow Builder......Page 145
Opening and Saving Item Types......Page 150
Quick Start Wizard Overview......Page 156
Using Oracle Workflow Builder with Different Server Versions......Page 159
Item Type Definition Web Page......Page 162
4 Defining Workflow Process Components......Page 165
Item Types......Page 166
Allowing Access to an Object......Page 181
Lookup Types......Page 183
Messages......Page 187
Activities......Page 204
Voting Activity......Page 222
Deleting Objects in Oracle Workflow Builder......Page 229
Modifying Objects in Oracle Workflow Builder......Page 230
Workflow Objects That Support Versioning......Page 231
Workflow Objects That Do Not Support Versioning......Page 232
5 Defining a Workflow Process Diagram......Page 241
Process Window......Page 242
Modifying Fonts in Oracle Workflow Builder......Page 261
Creating a Shortcut Icon for a Workflow Process......Page 262
Roles......Page 264
6 Predefined Workflow Activities......Page 269
And/Or Activities......Page 270
Compare Execution Time Activity......Page 271
Wait Activity......Page 272
Block Activity......Page 273
Launch Process Activity......Page 274
Loop Counter Activity......Page 275
End Activity......Page 276
Notify Activity......Page 277
Vote Yes/No Activity......Page 278
Master/Detail Coordination Activities......Page 279
Get Monitor URL Activity......Page 282
Set Event Property Activity......Page 283
Compare Event Property Activity......Page 284
XML Get Tag Value Activity......Page 286
XML Compare Tag Value Activities......Page 287
XML Transform Activity......Page 288
Execute Concurrent Program Activity......Page 290
Submit Concurrent Program Activity......Page 291
Wait for Concurrent Program Activity......Page 292
Default Error Process......Page 294
System: Error Item Type and Item Attributes......Page 295
Default Error Process......Page 296
Retry–only Process......Page 300
Default Event Error Process......Page 302
7 Defining Procedures and Functions for Oracle Workflow......Page 309
Defining Procedures and Functions for Oracle Workflow......Page 310
Standard API for PL/SQL Procedures Called by Function Activities......Page 311
Standard API for Java Procedures Called by Function Activities......Page 316
Standard API for an Item Type Selector or Callback Function......Page 321
”PL/SQL” Documents......Page 325
”PL/SQL CLOB” Documents......Page 327
Standard API for an Event Data Generate Function......Page 329
Enqueue......Page 330
Dequeue......Page 331
Standard API for an Event Subscription Rule Function......Page 332
8 Oracle Workflow APIs......Page 337
Oracle Workflow Procedures and Functions......Page 338
Overview of the Workflow Engine......Page 339
Oracle Workflow Java Interface......Page 340
Additional Workflow Engine Features......Page 342
Workflow Engine APIs......Page 352
CreateProcess......Page 354
SetItemUserKey......Page 356
GetItemUserKey......Page 357
GetActivityLabel......Page 358
SetItemOwner......Page 359
StartProcess......Page 360
LaunchProcess......Page 362
SuspendProcess......Page 364
ResumeProcess......Page 365
AbortProcess......Page 366
CreateForkProcess......Page 368
StartForkProcess......Page 370
Background......Page 371
AddItemAttribute......Page 373
AddItemAttributeArray......Page 376
SetItemAttribute......Page 378
SetItemAttrDocument......Page 381
SetItemAttributeArray......Page 383
getItemTypes......Page 386
GetItemAttribute......Page 387
GetItemAttrDocument......Page 389
GetItemAttrClob......Page 390
getItemAttributes......Page 391
GetItemAttrInfo......Page 392
GetActivityAttrInfo......Page 393
GetActivityAttribute......Page 394
GetActivityAttrClob......Page 396
BeginActivity......Page 397
CompleteActivity......Page 399
CompleteActivityInternalName......Page 402
AssignActivity......Page 404
Event......Page 405
HandleError......Page 407
SetItemParent......Page 409
ItemStatus......Page 410
getProcessStatus......Page 411
Workflow Core APIs......Page 412
CLEAR......Page 413
GET_ERROR......Page 414
TOKEN......Page 415
RAISE......Page 416
CONTEXT......Page 419
TRANSLATE......Page 421
Workflow Purge APIs......Page 422
Items......Page 424
Activities......Page 425
Notifications......Page 426
Total......Page 427
TotalPERM......Page 428
AdHocDirectory......Page 429
Purge Obsolete Workflow Runtime Data Concurrent Program......Page 430
Workflow Directory Service APIs......Page 431
GetRoleUsers......Page 432
GetUserRoles......Page 433
GetRoleInfo......Page 434
GetRoleInfo2......Page 435
IsPerformer......Page 436
UserActive......Page 437
GetUserName......Page 438
GetRoleName......Page 439
GetRoleDisplayName......Page 440
SetAdHocUserStatus......Page 441
SetAdHocRoleStatus......Page 442
CreateAdHocUser......Page 443
CreateAdHocRole......Page 445
AddUsersToAdHocRole......Page 447
SetAdHocUserExpiration......Page 448
SetAdHocRoleExpiration......Page 449
SetAdHocUserAttr......Page 450
SetAdHocRoleAttr......Page 451
RemoveUsersFromAdHocRole......Page 452
get_pref......Page 453
Workflow Monitor APIs......Page 454
GetAccessKey......Page 455
GetDiagramURL......Page 456
GetEnvelopeURL......Page 458
GetAdvancedEnvelopeURL......Page 460
WF_ITEM_ACTIVITY_STATUSES_V......Page 462
WF_NOTIFICATION_ATTR_RESP_V......Page 464
WF_RUNNABLE_PROCESSES_V......Page 465
WF_ITEMS_V......Page 466
Workflow Queue APIs......Page 467
EnqueueInbound......Page 470
DequeueOutbound......Page 472
DequeueEventDetail......Page 475
PurgeEvent......Page 477
PurgeItemType......Page 478
ProcessInboundQueue......Page 479
GetMessageHandle......Page 480
DequeueException......Page 481
DeferredQueue......Page 482
InboundQueue......Page 483
OutboundQueue......Page 484
ClearMsgStack......Page 485
CreateMsg......Page 486
WriteMsg......Page 487
SetMsgAttr......Page 488
SetMsgResult......Page 489
Document Management APIs......Page 490
get_launch_document_url......Page 491
get_launch_attach_url......Page 492
get_open_dm_display_window......Page 493
get_open_dm_attach_window......Page 494
set_document_id_html......Page 495
Notification Model......Page 497
Notification APIs......Page 502
Send......Page 504
SendGroup......Page 508
Forward......Page 510
Transfer......Page 511
Cancel......Page 512
CancelGroup......Page 513
Respond......Page 514
Responder......Page 515
VoteCount......Page 516
OpenNotificationsExist......Page 517
Close......Page 518
AddAttr......Page 519
SetAttribute......Page 520
GetAttrInfo......Page 522
GetInfo......Page 523
GetText......Page 524
GetShortText......Page 525
GetAttribute......Page 526
GetAttrDoc......Page 527
GetSubject......Page 528
GetBody......Page 529
GetShortBody......Page 530
TestContext......Page 531
AccessCheck......Page 532
WorkCount......Page 533
GetNotifications......Page 534
GetNotificationAttributes......Page 535
WriteToClob......Page 536
Overview of the Oracle Workflow Business Event System......Page 537
Business Event System Datatypes......Page 538
getSystem......Page 539
setSystem......Page 540
getValue......Page 541
setValue......Page 542
Parameter List Structure......Page 543
Event Message Structure......Page 544
getReceiveDate......Page 547
getEventKey......Page 548
getErrorMessage......Page 549
setSendDate......Page 550
setParameterList......Page 551
setFromAgent......Page 552
setErrorMessage......Page 553
Address......Page 554
GetValueForParameter......Page 555
Example for Using Abstract Datatypes......Page 557
Mapping Between WF_EVENT_T and OMBAQ_TEXT_MSG......Page 559
Event APIs......Page 562
Raise......Page 563
Send......Page 566
NewAgent......Page 567
Test......Page 568
Enqueue......Page 569
Listen......Page 570
Workflow Listen Process Concurrent Program......Page 571
SetErrorInfo......Page 572
Event Subscription Rule Function APIs......Page 573
Default_Rule......Page 574
Log......Page 576
Error......Page 577
Warning......Page 578
Success......Page 579
Workflow_Protocol......Page 580
Error_Rule......Page 581
Event Function APIs......Page 582
Parameters......Page 583
SubscriptionParameters......Page 585
AddCorrelation......Page 586
Generate......Page 588
Receive......Page 590
Business Event System Replication APIs......Page 592
WF_EVENTS Document Type Definition......Page 594
WF_EVENTS_PKG.Generate......Page 595
WF_EVENTS_PKG.Receive......Page 596
WF_EVENT_GROUPS Document Type Definition......Page 597
WF_EVENT_GROUPS_PKG.Generate......Page 598
WF_EVENT_GROUPS_PKG.Receive......Page 599
WF_SYSTEMS Document Type Definition......Page 600
WF_SYSTEMS_PKG.Generate......Page 601
WF_SYSTEMS_PKG.Receive......Page 602
WF_AGENTS Document Type Definition......Page 603
WF_AGENTS_PKG.Generate......Page 604
WF_AGENTS_PKG.Receive......Page 605
WF_EVENT_SUBSCRIPTIONS Document Type Definition......Page 606
WF_EVENT_SUBSCRIPTIONS_PKG.Generate......Page 607
WF_EVENT_SUBSCRIPTIONS_PKG.Receive......Page 608
9 Oracle Workflow Home Page......Page 645
Accessing the Oracle Workflow Home Page......Page 646
Setting User Preferences......Page 649
10 Viewing Notifications and Processing Responses......Page 653
Reviewing Notifications via Electronic Mail......Page 654
Viewing Notifications from a Web Browser......Page 665
Reviewing a Summary of Your Notifications via Electronic Mail......Page 675
Defining Rules for Automatic Notification Processing......Page 677
Document Management Integration in Notifications......Page 684
11 Monitoring Workflow Processes......Page 689
Workflow Monitor......Page 690
Workflow Monitor Access......Page 695
12 Testing a Workflow Definition......Page 705
Testing Workflow Definitions......Page 706
13 Managing Business Events......Page 711
Managing Business Events......Page 712
Events......Page 714
Systems......Page 727
Agents......Page 732
Event Subscriptions......Page 743
Setting Up Message Propagation......Page 755
Raising Events......Page 767
Signing Up Systems......Page 769
Synchronizing Systems......Page 771
Reviewing Local Queues......Page 774
Workflow Agent Ping/Acknowledge......Page 777
The Workflow Agent Ping/Acknowledge Item Type......Page 778
Summary of the Master Ping Process......Page 779
Master Ping Process Activities......Page 780
Summary of the Detail Ping Process......Page 781
Detail Ping Process Activities......Page 782
14 Predefined Workflow Events......Page 785
Event Definition Events......Page 786
System Definition Events......Page 787
Agent Definition Events......Page 788
Seed Event Group......Page 789
Ping Agent Events......Page 791
System Signup Event......Page 793
Any Event......Page 794
Unexpected Event......Page 796
Workflow Send Protocol......Page 800
The Workflow Send Protocol Item Type......Page 801
Summary of the Workflow Event Protocol Process......Page 803
Workflow Event Protocol Process Activities......Page 804
Workflow Send Protocol Events......Page 807
15 Demonstration Workflow Processes......Page 811
Sample Workflow Processes......Page 812
Displaying the Process Diagram of a Sample Workflow......Page 813
Requisition Process......Page 815
Installing the Requisition Data Model......Page 816
Initiating the Requisition Workflow......Page 818
The Requisition Item Type......Page 822
Summary of the Requisition Approval Process......Page 823
Requisition Process Activities......Page 825
Summary of the Notify Approver Subprocess......Page 829
Notify Approver Subprocess Activities......Page 831
Sample StartProcess Function......Page 833
Example: Select Approver......Page 836
Example: Verify Authority......Page 839
Example: Notify Requisition Approval Required......Page 841
Product Survey Process......Page 844
Installing the Product Survey Data Model......Page 845
Initiating the Product Survey Workflow......Page 846
The Product Survey Item Type......Page 848
Summary of the Survey – Single Process......Page 849
Survey – Single Process Activities......Page 851
Summary of the Survey – Master/Detail Process......Page 852
Survey – Master/Detail Process Activities......Page 854
Summary of the Detail Survey Process......Page 856
Detail Survey Process Activities......Page 857
The Document Management Item Type......Page 859
Summary of the Document Review Process......Page 860
Document Review Process Activities......Page 861
The Periodic Alert Item Type......Page 864
Summary of the Error Check Process......Page 866
Error Check Process Activities......Page 867
Summary of the User Defined Alert Action Process......Page 870
User Defined Alert Action Process Activities......Page 871
Event System Demonstration......Page 873
Installing the Event System Demonstration Data Model......Page 874
Initiating the Event System Demonstration Workflow......Page 876
The Event System Demonstration Item Type......Page 881
Summary of the Buyer: Top Level PO Process......Page 883
Buyer: Top Level PO Process Activities......Page 885
Buyer: Send PO to Supplier Subprocess Activities......Page 888
Summary of the Buyer: Receive Supplier PO Acknowledgement Subprocess......Page 890
Buyer: Receive Supplier PO Acknowledgement Subprocess Activities......Page 891
Summary of the Buyer: Advanced Shipment Notice Subprocess......Page 893
Buyer: Advanced Shipment Notice Subprocess Activities......Page 894
Summary of the Buyer: Receive Supplier Invoicing Subprocess......Page 895
Buyer: Receive Supplier Invoicing Subprocess Activities......Page 896
Summary of the Supplier: Top Level Order Process......Page 897
Supplier: Top Level Order Process Activities......Page 898
Summary of the Supplier: Get Order Details Subprocess......Page 901
Supplier: Get Order Details Subprocess Activities......Page 902
Summary of the Supplier: Credit Check Subprocess......Page 904
Supplier: Credit Check Subprocess Activities......Page 905
Summary of the Supplier: Stock Check Subprocess......Page 906
Supplier: Stock Check Subprocess Activities......Page 907
Summary of the Supplier: Advanced Shipment Notice Subprocess......Page 908
Supplier: Advanced Shipment Notice Subprocess Activities......Page 909
Summary of the Supplier: Send Supplier Invoice Subprocess......Page 910
Supplier: Send Supplier Invoice Subprocess Activities......Page 911
B2B Purchase Order Event......Page 912
B2B Purchase Order Acknowledgement Event......Page 915
B2B Advanced Shipment Notice Event......Page 916
B2B Invoice Event......Page 917
16 Workflow Administration Scripts......Page 921
Miscellaneous SQL Scripts......Page 922
FNDWFPR......Page 924
Wfbkg.sql......Page 925
Wfchact.sql......Page 926
Wfchitt.sql......Page 927
Wfchmsg.sql......Page 928
Wfdirchk.sql......Page 929
Wfevtenq.sql......Page 930
Wfprot.sql......Page 931
Wfrefchk.sql......Page 932
Wfrmita.sql......Page 933
Wfrmtype.sql......Page 934
Wfstdchk.sql......Page 935
Wfverupd.sql......Page 936
A Oracle Workflow Builder Menus and Toolbars......Page 937
Oracle Workflow Builder Menus......Page 938
Oracle Workflow Builder Toolbars......Page 943
B Oracle Applications Embedded Workflows......Page 947
Predefined Workflows Embedded in Oracle Applications and Oracle Self– Service Web Applications......Page 948
Resolving Customization Issues......Page 963
What Is Supported......Page 964
Glossary......Page 967
Index......Page 971