Oracle E-Business Suite development & extensibility handbook

✍ Scribed by Anil Passi; Vladimir Ajvaz

• Tongue: English
• Leaves: 408
• Category: Library

✦ Table of Contents

Contents......Page 3
Preface......Page 13
How To Use This Guide......Page 14
Other Information Sources......Page 15
Do Not Use Database Tools to Modify Oracle Applications Data......Page 22
Your Feedback......Page 23
1 Overview of Oracle Workflow......Page 25
Overview of Oracle Workflow......Page 26
Major Features and Definitions......Page 27
Workflow Processes......Page 30
Oracle Workflow Procedures and Functions......Page 32
2 Workflow Engine APIs......Page 33
Overview of the Workflow Engine......Page 34
Oracle Workflow Java Interface......Page 36
Additional Workflow Engine Features......Page 39
Workflow Engine APIs......Page 51
CreateProcess......Page 53
SetItemUserKey......Page 55
GetItemUserKey......Page 56
GetActivityLabel......Page 57
SetItemOwner......Page 58
StartProcess......Page 60
LaunchProcess......Page 62
SuspendProcess......Page 64
ResumeProcess......Page 66
AbortProcess......Page 68
CreateForkProcess......Page 70
StartForkProcess......Page 72
Background......Page 73
AddItemAttribute......Page 75
AddItemAttributeArray......Page 78
SetItemAttribute......Page 80
setItemAttrFormattedDate......Page 83
SetItemAttrDocument......Page 84
SetItemAttributeArray......Page 86
getItemTypes......Page 89
GetItemAttribute......Page 90
GetItemAttrDocument......Page 92
GetItemAttrClob......Page 94
getItemAttributes......Page 95
GetItemAttrInfo......Page 96
GetActivityAttrInfo......Page 97
GetActivityAttribute......Page 98
GetActivityAttrClob......Page 100
getActivityAttributes......Page 101
BeginActivity......Page 102
CompleteActivity......Page 104
CompleteActivityInternalName......Page 107
AssignActivity......Page 109
Event......Page 110
HandleError......Page 112
SetItemParent......Page 115
ItemStatus......Page 117
getProcessStatus......Page 118
Workflow Function APIs......Page 119
loadItemAttributes......Page 120
loadActivityAttributes......Page 121
getActivityAttr......Page 122
getItemAttr......Page 124
setItemAttrValue......Page 125
execute......Page 126
Workflow Attribute APIs......Page 127
WFAttribute......Page 129
value......Page 130
getName......Page 131
getValue......Page 132
getType......Page 133
getFormat......Page 134
getValueType......Page 135
toString......Page 136
compareTo......Page 137
Workflow Core APIs......Page 138
CLEAR......Page 139
GET_ERROR......Page 140
TOKEN......Page 141
RAISE......Page 142
CONTEXT......Page 145
TRANSLATE......Page 147
Workflow Purge APIs......Page 148
Items......Page 150
Activities......Page 151
Notifications......Page 152
Total......Page 153
TotalPERM......Page 154
Directory......Page 155
Purge Obsolete Workflow Runtime Data Concurrent Program......Page 156
Workflow Monitor APIs......Page 158
GetAccessKey......Page 159
GetDiagramURL......Page 160
GetEnvelopeURL......Page 162
GetAdvancedEnvelopeURL......Page 164
WF_ITEM_ACTIVITY_STATUSES_V......Page 166
WF_NOTIFICATION_ATTR_RESP_V......Page 168
WF_RUNNABLE_PROCESSES_V......Page 169
WF_ITEMS_V......Page 170
3 Directory Service APIs......Page 171
Workflow Directory Service APIs......Page 172
GetRoleUsers......Page 174
GetUserRoles......Page 175
GetRoleInfo......Page 176
GetRoleInfo2......Page 177
IsPerformer......Page 178
UserActive......Page 179
GetUserName......Page 180
GetRoleName......Page 181
GetRoleDisplayName......Page 182
CreateAdHocUser......Page 183
CreateAdHocRole......Page 185
AddUsersToAdHocRole......Page 187
RemoveUsersFromAdHocRole......Page 188
SetAdHocUserStatus......Page 189
SetAdHocRoleStatus......Page 190
SetAdHocUserExpiration......Page 191
SetAdHocRoleExpiration......Page 192
SetAdHocUserAttr......Page 193
SetAdHocRoleAttr......Page 194
Workflow LDAP APIs......Page 195
Synch_changes......Page 196
Synch_all......Page 197
Schedule_changes......Page 198
Workflow Local Synchronization APIs......Page 199
Propagate_User......Page 200
Propagate_Role......Page 204
Propagate_User_Role......Page 209
get_pref......Page 210
4 Notification System APIs......Page 211
Notification Model......Page 212
Notification Document Type Definition......Page 217
Notification APIs......Page 222
Send......Page 224
SendGroup......Page 229
Forward......Page 231
Transfer......Page 233
Cancel......Page 235
CancelGroup......Page 236
Respond......Page 237
Responder......Page 239
NtfSignRequirementsMet......Page 240
VoteCount......Page 241
OpenNotificationsExist......Page 242
Close......Page 243
AddAttr......Page 244
SetAttribute......Page 245
GetAttrInfo......Page 247
GetInfo......Page 248
GetText......Page 249
GetShortText......Page 250
GetAttribute......Page 251
GetAttrDoc......Page 253
GetSubject......Page 254
GetBody......Page 255
GetShortBody......Page 256
TestContext......Page 257
AccessCheck......Page 258
WorkCount......Page 259
getNotifications......Page 260
getNotificationAttributes......Page 261
WriteToClob......Page 262
Denormalize_Notification......Page 263
EncodeBLOB......Page 265
5 Business Event System APIs......Page 267
Overview of the Oracle Workflow Business Event System......Page 268
Business Event System Datatypes......Page 269
getSystem......Page 270
setSystem......Page 271
getValue......Page 272
setValue......Page 273
Parameter List Structure......Page 274
Event Message Structure......Page 275
getSendDate......Page 278
getEventName......Page 279
getToAgent......Page 280
setPriority......Page 281
setParameterList......Page 282
setEventData......Page 283
setErrorMessage......Page 284
Content......Page 285
GetValueForParameter......Page 286
Example for Using Abstract Datatypes......Page 288
Mapping Between WF_EVENT_T and OMBAQ_TEXT_MSG......Page 290
Mapping Between WF_EVENT_T and SYS.AQ$_JMS_TEXT_MESSAGE......Page 293
Event APIs......Page 296
Raise......Page 297
Raise3......Page 301
Send......Page 303
NewAgent......Page 305
Test......Page 306
Enqueue......Page 307
Listen......Page 308
SetErrorInfo......Page 311
SetDispatchMode......Page 312
AddParameterToList......Page 313
AddParameterToListPos......Page 314
GetValueForParameter......Page 315
GetValueForParameterPos......Page 316
SetMaxNestedRaise......Page 317
GetMaxNestedRaise......Page 318
Event Subscription Rule Function APIs......Page 319
Default_Rule......Page 321
Log......Page 323
Error......Page 324
Warning......Page 325
Success......Page 326
Workflow_Protocol......Page 327
Error_Rule......Page 328
SetParametersIntoParameterList......Page 329
Event Function APIs......Page 330
Parameters......Page 331
SubscriptionParameters......Page 333
AddCorrelation......Page 334
Generate......Page 336
Receive......Page 338
Business Event System Replication APIs......Page 340
WF_EVENTS Document Type Definition......Page 342
WF_EVENTS_PKG.Generate......Page 343
WF_EVENTS_PKG.Receive......Page 344
WF_EVENT_GROUPS Document Type Definition......Page 345
WF_EVENT_GROUPS_PKG.Generate......Page 346
WF_EVENT_GROUPS_PKG.Receive......Page 347
WF_SYSTEMS Document Type Definition......Page 348
WF_SYSTEMS_PKG.Generate......Page 349
WF_SYSTEMS_PKG.Receive......Page 350
WF_AGENTS Document Type Definition......Page 351
WF_AGENTS_PKG.Generate......Page 352
WF_AGENTS_PKG.Receive......Page 353
WF_AGENT_GROUPS Document Type Definition......Page 354
WF_AGENT_GROUPS_PKG.Generate......Page 355
WF_AGENT_GROUPS_PKG.Receive......Page 356
WF_EVENT_SUBSCRIPTIONS Document Type Definition......Page 357
WF_EVENT_SUBSCRIPTIONS_PKG.Generate......Page 358
WF_EVENT_SUBSCRIPTIONS_PKG.Receive......Page 359
Cleanup_Subscribers......Page 360
6 Workflow Queue APIs......Page 363
Workflow Queue APIs......Page 364
EnqueueInbound......Page 367
DequeueOutbound......Page 369
DequeueEventDetail......Page 372
PurgeEvent......Page 374
PurgeItemType......Page 375
ProcessInboundQueue......Page 376
GetMessageHandle......Page 377
DequeueException......Page 378
DeferredQueue......Page 379
InboundQueue......Page 380
OutboundQueue......Page 381
ClearMsgStack......Page 382
CreateMsg......Page 383
WriteMsg......Page 384
SetMsgAttr......Page 385
SetMsgResult......Page 386
7 Document Management APIs......Page 387
Document Management APIs......Page 388
get_launch_document_url......Page 389
get_launch_attach_url......Page 390
get_open_dm_display_window......Page 391
get_open_dm_attach_window......Page 392
set_document_id_html......Page 393
Glossary......Page 395
Index......Page 399