Oracle Workflow Developer's Guide Release 2.6.4 Part Number B15853-04

Contents

Previous

Next

Predefined Workflow Events

This chapter tells you how to use Oracle Workflow's predefined events.

This chapter covers the following topics:

• Predefined Workflow Events
• Workflow Send Protocol

Predefined Workflow Events

Oracle Workflow provides several predefined events for significant occurrences within the Business Event System and other Oracle Workflow components. You can define subscriptions to these events for replication, validation, or other purposes. You can enable or disable many of the events if necessary.

Some predefined events are referenced by default subscriptions that are created automatically when you install Oracle Workflow. The subscriber for all the default subscriptions is the local system. You can enable, disable, or copy many of these subscriptions to perform the event processing that you want.

Important: You must not change or disable the definition of the Unexpected event or of the predefined Error subscription to that event. If you do, the Event Manager will not be able to perform default error handling for events and subscription processing.

Note: Predefined events and default subscriptions are also provided with some Oracle Applications products. For more information on Oracle Applications-specific workflow events, consult the documentation or help for that specific Oracle Application product and the Oracle E-Business Suite Electronic Technical Reference Manual, available from OracleMetaLink.

Related Topics

Event Definition Events

Event Group Definition Events

System Definition Events

Agent Definition Events

Agent Group Definition Events

Event Subscription Definition Events

Synchronize Event Systems Event

Seed Event Group

Ping Agent Events

System Signup Event

Any Event

Unexpected Event

User Entry Has Changed Event

Notification Events

Notification Mailer Events

Business Event System Control Events

Generic Service Component Framework Control Events

Workflow Engine Events

Directory Service Events

Workflow Send Protocol

Event Definition Events

Event Created

Oracle Workflow raises this event whenever a new individual event or event group definition is created.

Event Updated

Oracle Workflow raises this event whenever an individual event or event group definition is updated.

Event Deleted

Oracle Workflow raises this event whenever an individual event or event group definition is deleted.

Event Group Definition Events

Event Group Creation

Oracle Workflow raises this event whenever a new event group member definition is created.

Event Group Updated

Oracle Workflow raises this event whenever an event group member definition is updated.

Event Group Deleted

Oracle Workflow raises this event whenever an event group member definition is deleted.

System Definition Events

System Created

Oracle Workflow raises this event whenever a new system definition is created.

System Updated

Oracle Workflow raises this event whenever a system definition is updated.

System Deleted

Oracle Workflow raises this event whenever a system definition is deleted.

Agent Definition Events

Agent Created

Oracle Workflow raises this event whenever a new agent definition is created.

Agent Updated

Oracle Workflow raises this event whenever an agent definition is updated.

Agent Deleted

Oracle Workflow raises this event whenever an agent definition is deleted.

Agent Group Definition Events

Note: Agent groups are currently available only for the version of Oracle Workflow embedded in Oracle Applications.

Agent Group Member Created

Oracle Workflow raises this event whenever a new agent group member definition is created.

Agent Group Member Updated

Oracle Workflow raises this event whenever an agent group member definition is updated.

Agent Group Member Deleted

Oracle Workflow raises this event whenever an agent group member definition is deleted.

Event Subscription Definition Events

Subscription Created

Oracle Workflow raises this event whenever a new subscription definition is created.

Subscription Updated

Oracle Workflow raises this event whenever a subscription definition is updated.

Subscription Deleted

Oracle Workflow raises this event whenever a subscription definition is deleted.

Synchronize Event Systems Event

You can raise this event to synchronize the Event Manager data on the local system with another system. The event message for the Synchronize Systems event contains the definitions of all the Event Manager objects on the local system. See: Synchronizing Systems.

Seed Event Group

This event group contains events used for automatic replication of Business Event System objects from one system to another. The group includes all the event, event group, system, agent, and subscription definition events, as well as the Synchronize Event Systems event.

Oracle Workflow provides two default subscriptions to the Seed Event Group. The first subscription can send the Event Manager data to an agent and to a workflow process when one of the group member events is raised locally. To use this subscription, you must create a copy of this subscription with the same properties, except you should give your new subscription a customization level of User and add the agent or workflow to which you want to send the data, and enable the subscription. The following table lists the properties defined for this subscription.

The second subscription can load the Event Manager data into the local system when one of the group member events is received from an external source. To use this subscription, you must enable it. The following table lists the properties defined for this subscription.

Related Topics

Synchronizing Systems

Ping Agent Events

Ping Agent Event

The Detail Ping process in the Workflow Agent Ping/Acknowledge item type sends this event to ping inbound agents. You can use the Launch Processes Web page to launch the Master Ping Process, which in turn launches the Detail Ping process. See: Workflow Agent Ping/Acknowledge.

Oracle Workflow provides one default subscription to the Ping Agent event. This subscription sends the Acknowledge Ping event back to the originating system when the Ping Agent event is received from an external source. The subscription is enabled by default. The following table lists the properties defined for this subscription.

Acknowledge Ping

Oracle Workflow sends this event back to the originating system when a Ping Agent event is received. See: Workflow Agent Ping/Acknowledge.

Oracle Workflow provides one default subscription to the Acknowledge Ping event. This subscription sends the Acknowledge Ping event to the Detail Ping process in the Workflow Agent Ping/Acknowledge item type when the event is received from an external source. The subscription is enabled by default. The following table lists the properties defined for this subscription.

System Signup Event

You can raise this event from the System Signup Web page on a source system to sign up a destination system for receiving event messages from the source system. See: To Sign Up a System.

Oracle Workflow provides one default subscription to the System Signup event. This subscription loads the Event Manager data into the local system when the System Signup event is raised locally. The subscription is enabled by default. The following table lists the properties defined for this subscription.

Any Event

This event is raised implicitly when any other event is raised locally or received from an external source. You can define a subscription to the Any event to implement processing that you want to execute whenever an event occurs.

Oracle Workflow provides three default subscriptions to the Any event. The first subscription can be triggered when an event is raised locally. To use this subscription, you must create a copy of this subscription with the same properties, except you should give your new subscription a customization level of User, define the action for the subscription, and enable it. The following table lists the properties defined for this subscription.

The second subscription can be triggered when an event is received from an external source. To use this subscription, you must create a copy of this subscription with the same properties, except you should give your new subscription a customization level of User, define the action for the subscription and enable it. The following table lists the properties defined for this subscription.

The third subscription sends the event message to the Default Event Error process in the System: Error item type and raises an exception when an event is received from an Error source (that is, when it is dequeued from the WF_ERROR or WF_JAVA_ERROR queue). To use this subscription, you must enable it. The following table lists the properties defined for this subscription.

Unexpected Event

Oracle Workflow executes subscriptions to this event when an event is raised locally or received from an external source, but no subscription exists for that event.

Important: You must not change or disable the definition of the Unexpected event. If you do, the Event Manager will not be able to perform error handling for event and subscription processing.

Oracle Workflow provides two default subscriptions to the Unexpected event. The first subscription sends the event message to the Default Event Error process in the System: Error item type when an unexpected event is received from an external source. This subscription allows your local system to handle any event messages received from external systems that you were not expecting.

The Default Event Error process notifies the system administrator, who can retry or abort subscription processing for the event. For example, the system administrator can optionally define a subscription to process the event and then retry the event.

The External subscription to the Unexpected event is enabled by default. You can disable it if necessary.

Important: If you want to disable this subscription, be careful to consider all the consequences for handling unexpected event messages from external sources. If the subscription is disabled, these event messages will remain on the inbound queue where they are received and may be undetected for some time.

The following table lists the properties defined for this subscription.

The second subscription sends the event message to the Default Event Error process in the System: Error item type when an unexpected event is received from an Error source (that is, when it is dequeued from the WF_ERROR or WF_JAVA_ERROR queue). This subscription is enabled by default.

Important: You must not change or disable the definition of the predefined Error subscription to the Unexpected event. If you disable this subscription, then the Event Manager will not be able to perform error handling for any events for which you have not defined custom Error subscriptions.

The following table lists the properties defined for this subscription.

User Entry Has Changed Event

The Workflow LDAP APIs raise this event when changed user information is retrieved from an LDAP directory. You can run these APIs to synchronize the Workflow directory service with Oracle Internet Directory if you implement Oracle Internet Directory integration. One event is raised for each changed user. See: Synchronizing Workflow Directory Services with Oracle Internet Directory, Oracle Workflow Administrator's Guide and Workflow LDAP APIs, Oracle Workflow API Reference.

The standalone version of Oracle Workflow provides two default subscriptions to the User Entry Has Changed event. The first subscription creates a new user record in the WF_LOCAL_ROLES table for the standalone version of Oracle Workflow when the User Entry Has Changed event is raised locally, if that user does not already exist in the table. This subscription is enabled by default. The following table lists the properties defined for this subscription.

The second subscription loads the changed user data into the WF_LOCAL_ROLES table for the standalone version of Oracle Workflow when the User Entry Has Changed event is raised locally. This subscription is enabled by default. The following table lists the properties defined for this subscription.

In Oracle Applications, the embedded version of Oracle Workflow provides one default subscription to the User Entry Has Changed event that loads the changed user data into the WF_LOCAL_ROLES table for Oracle Applications when the User Entry Has Changed event is raised locally. You should enable this subscription if you are using the version of Oracle Workflow embedded in Oracle Applications and you want to implement integration with Oracle Internet Directory. The following table lists the properties defined for this subscription.

Notification Events

Event for Notification Send

Oracle Workflow uses this event to send outbound notification messages.

Oracle Workflow provides one default subscription to the Notification Send event, which is the default subscription if a notification mailer encounters errors during the generation and sending of outbound messages. When the Notification Send event is received from an Error source (that is, when it is dequeued from the WF_ERROR or WF_JAVA_ERROR queue), this subscription sends the event message to the Default Event Error process in the System: Error item type. The subscription is enabled by default. The following table lists the properties defined for this subscription.

Event for Notification Reassign

Oracle Workflow uses this event to send an outbound notification message to the new recipient when a notification is reassigned.

Event for Notification Cancel

Oracle Workflow uses this event to send an outbound cancellation message when a previously sent notification is canceled.

Notification Send Group

This event group contains events for various types of outbound messages sent by notification mailers.

Oracle Workflow provides two default subscriptions to the Notification Send Group. The first subscription places the event message on the WF_NOTIFICATION_OUT agent to be sent by a notification mailer when one of the group member events is raised locally. This subscription is enabled by default. The following table lists the properties defined for this subscription.

The second subscription can be used to place the event message on the WF_SMTP_O_1_QUEUE to be processed by the C-based version of the Notification Mailer, when one of the group member events is raised locally. This subscription should only be used when Oracle Support determines it to be necessary. Do not enable this subscription unless you are directed to do so by Oracle Support. The following table lists the properties defined for this subscription.

Send Summary Notification Event

Oracle Workflow raises this event to generate and send a summary notification for each user and role with a notification preference of SUMMARY or SUMHTML when a Launch Summary Notifications event is raised.

Oracle Workflow provides one default subscription to the Send Summary Notification event. When the Send Summary Notification event is raised locally, this subscription places the event message on the WF_NOTIFICATION_OUT agent to be sent by a notification mailer. The subscription is enabled by default. The following table lists the properties defined for this subscription.

E-Mail Notification Dispatch Failure

Oracle Workflow raises this event when an e-mail cannot be sent due to a failure in rendering the content of the message or in sending the message to the recipient, such as if the recipient has an invalid e-mail address.

Oracle Workflow provides two default subscriptions to the E-Mail Notification Dispatch Failure event. The first subscription sets the recipient's notification preference to DISABLED when the E-Mail Notification Dispatch Failure event is raised locally, to prevent further e-mail notifications from being sent until the issue that caused the failure is resolved. The subscription is enabled by default. The following table lists the properties defined for this subscription.

The second subscription sends the event message to the Default Event Error process in the System: Error item type when the E-Mail Notification Dispatch Failure event is received from an Error source (that is, when it is dequeued from the WF_ERROR or WF_JAVA_ERROR queue). The subscription is enabled by default. The following table lists the properties defined for this subscription.

Notification Send Error Event

This event is not currently used.

Receipt of Incoming Response Event

Oracle Workflow raises this event when an inbound message is received by a notification mailer.

Return to Sender Event

Oracle Workflow raises this event if there are problems during the processing of an inbound response message received by a notification mailer, and these problems require the original notification or the response to be resent.

Notification Recipient Is Unavailable Event

Oracle Workflow raises this event if an inbound response message received by a notification mailer contains a string of text that matches a tag pattern associated with the Unavailable tag action.

Notification Error Event

Oracle Workflow raises this event if an inbound response message received by a notification mailer contains a string of text that matches a tag pattern associated with the Error tag action.

Notification Receive Group

This event group contains events for various types of incoming messages received by notification mailers.

Oracle Workflow provides one default subscription to the Notification Receive Group. This subscription processes the incoming message when one of the group member events is received from an external source.

• oracle.apps.wf.notification.receive.message - The notification mailer performs normal response processing for the message. See: Inbound Notification Mailer Processing, Oracle Workflow Administrator's Guide.

• oracle.apps.wf.notification.receive.sendreturn - The outbound notification is resent.

• oracle.apps.wf.notification.receive.unavail - The message is moved to the discard folder, and the notification mailer continues waiting for a reply to the notification since the notification's status is still OPEN. However, the notification's mail status is updated to UNAVAIL.

• oracle.apps.wf.notification.receive.error - The message is moved to the discard folder, and Oracle Workflow initiates an error process, if one is defined for the workflow process to which the notification activity belongs. The notification's status is still OPEN, but its mail status and activity status are updated to ERROR. Ideally, the workflow administrator corrects the problem and resends the notification by updating its mail status to MAIL.

This subscription is enabled by default. The following table lists the properties defined for this subscription.

Event for Notification Respond

Oracle Workflow raises this event whenever a user responds to a notification.

Event for Notification Close

Oracle Workflow raises this event whenever a notification is closed.

Denormalize Notification Event

Oracle Workflow raises this event if the denormalization of a notification needs to be deferred.

Oracle Workflow provides one default subscription to the Denormalize Notification event. This subscription stores denormalized values for certain notification fields, including the notification subject, in the WF_NOTIFICATIONS table when the Denormalize Notification event is raised locally. The subscription is enabled by default. The following table lists the properties defined for this subscription.

oracle.apps.fnd.wf.attribute.denormalize Event

Oracle Workflow raises this event when a worklist flexfields rule is created or updated, requiring denormalized message attributes to be stored in the designated worklist flexfields columns.

Oracle Workflow provides one default subscription to the oracle.apps.fnd.wf.attribute.denormalize event. This subscription runs the Denormalize Worklist Flexfields concurrent program (FNDWFDCC) to store any message attributes that are mapped by the worklist flexfields rule in the designated worklist flexfields columns, when the event is raised locally. The subscription is enabled by default. The following table lists the properties defined for this subscription.

Notification Mailer Events

Launch Summary Notifications

Oracle Workflow uses this event to make a notification mailer service component send summary notifications to roles with a notification preference of SUMMARY or SUMHTML. A summary notification lists all notifications for a role that are open at the time that the summary is sent.

Oracle Workflow provides one default subscription to the Launch Summary Notifications event. When the Launch Summary Notifications event is raised locally, this subscription raises the oracle.apps.wf.notification.summary.send event for each role with a notification preference of SUMMARY or SUMHTML. The subscription is enabled by default. The following table lists the properties defined for this subscription.

Unsolicited Email Threshold Reached Event

A notification mailer raises this event when it receives a second unsolicited message from an e-mail address that is already on its warned list.

Note: If the mailer receives additional unsolicited messages from the same e-mail address, those messages are simply discarded. The mailer does not raise the Unsolicited Email Threshold Reached event again.

Business Event System Control Events

Business Event System Control Ping Event

The Workflow Control Queue Cleanup program raises this event to send to the middle tier subscribers for the WF_CONTROL queue, in order to check whether they are still active.

Business Event System Control Group

This event group contains control events for Oracle Applications or standalone Oracle Workflow internal processing. Events in this group are meant to be placed on the WF_CONTROL queue for middle tier processes to dequeue.

Oracle Workflow provides one default subscription to the Business Event System Control Group. This subscription places the event message on the standard WF_CONTROL queue when one of the group member events is raised locally. Middle tier subscribers to this queue can then dequeue the event message. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Business Event System Applications Control Group

This event group contains control events for Oracle Applications internal processing. Events in this group are meant to be updated with Oracle Applications context information and placed on the WF_CONTROL queue for middle tier processes to dequeue. This group does not currently have any seeded members.

Oracle Application Object Library provides one default subscription to the Business Event System Applications Control Group. When one of the group member events is raised locally, this subscription updates the event message with Oracle Applications context data such as the database ID and security group ID and then places the event message on the standard WF_CONTROL queue. Middle tier subscribers to this queue can then dequeue the event message. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Related Topics

Cleaning Up the Workflow Control Queue, Oracle Workflow Administrator's Guide

Business Event System Cleanup API, Oracle Workflow API Reference

Generic Service Component Framework Control Events

Start Event

The Generic Service Component Framework uses this event to start a service component.

Refresh Event

The Generic Service Component Framework uses this event to refresh a running service component with new parameter values, for those parameters that can be dynamically refreshed.

Suspend Event

The Generic Service Component Framework uses this event to suspend processing for a running service component.

Resume Event

The Generic Service Component Framework uses this event to resume processing for a suspended service component.

Stop Event

The Generic Service Component Framework uses this event to stop a running service component.

GSC Business Event System Control Group

This event group contains control events for Generic Service Component Framework internal processing. Events in this group are meant to be placed on the WF_CONTROL queue for middle tier processes to dequeue.

Oracle Workflow provides one default subscription to the GSC Business Event System Control Group. This subscription places the event message on the standard WF_CONTROL queue when one of the group member events is raised locally. Middle tier subscribers to this queue can then dequeue the event message. This subscription is enabled by default. The following table lists the properties defined for this subscription.

For more information about the Generic Service Component Framework, please refer to the Oracle Applications Manager online help or the Oracle Enterprise Manager online help.

Workflow Engine Events

oracle.apps.wf.engine.abort Event

The Oracle Workflow Engine raises this event when a workflow process is aborted using WF_ENGINE.AbortProcess. See: AbortProcess, Oracle Workflow API Reference.

oracle.apps.wf.engine.retry Event

The Oracle Workflow Engine raises this event when an activity is retried using WF_ENGINE.HandleError. See: HandleError, Oracle Workflow API Reference.

oracle.apps.wf.engine.skip Event

The Oracle Workflow Engine raises this event when an activity is skipped using WF_ENGINE.HandleError. See: HandleError, Oracle Workflow API Reference.

Directory Service Events

Workflow User Updated Event

Oracle Workflow raises this event whenever a user is updated in the Oracle Workflow directory service.

Oracle Workflow provides one default subscription to the Workflow User Updated event. When the Workflow User Updated event is raised locally, this subscription makes corresponding updates to any associations of that user with roles. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Workflow Role Updated Event

Oracle Workflow raises this event whenever a role is updated in the Oracle Workflow directory service.

Oracle Workflow provides one default subscription to the Workflow Role Updated event. When the Workflow Role Updated event is raised locally, this subscription makes corresponding updates to any associations of that role with users. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Workflow User/Role Relationship Created Event

Oracle Workflow raises this event whenever an association of a user with a role is created in the Oracle Workflow directory service.

Oracle Workflow provides two default subscriptions to the Workflow User/Role Relationship Created event. The first subscription updates the hierarchy of role assignments for a user when the Workflow User/Role Relationship Created event is raised locally. This subscription is enabled by default. The following table lists the properties defined for this subscription.

The second subscription stores denormalized associations of the user with roles, based on the hierarchy of role assignments for the user, when the Workflow User/Role Relationship Created event is raised locally. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Workflow User/Role Relationship Updated Event

Oracle Workflow raises this event whenever an association of a user with a role is updated in the Oracle Workflow directory service.

Oracle Workflow provides one default subscription to the Workflow User/Role Relationship Updated event. This subscription updates the hierarchy of role assignments for a user when the Workflow User/Role Relationship Updated event is raised locally. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Workflow Role Hierarchy Relationship Created Event

Oracle Workflow raises this event whenever a hierarchical relationship of a role to another role is created in the Oracle Workflow directory service.

Oracle Workflow provides one default subscription to the Workflow Role Hierarchy Relationship Created event. This subscription runs the Workflow Role Hierarchy Propagation concurrent program (FNDWFDSRHP) to update the denormalized associations of users with roles, based on the hierarchy of roles, when the Workflow Role Hierarchy Relationship Created event is raised locally. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Workflow Role Hierarchy Relationship Updated Event

Oracle Workflow raises this event whenever a hierarchical relationship of a role to another role is updated in the Oracle Workflow directory service.

Oracle Workflow provides one default subscription to the Workflow Role Hierarchy Relationship Updated event. This subscription runs the Workflow Role Hierarchy Propagation concurrent program (FNDWFDSRHP) to update the denormalized associations of users with roles, based on the hierarchy of roles, when the Workflow Role Hierarchy Relationship Updated event is raised locally. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Workflow Send Protocol

The Workflow Send Protocol process is a sample workflow process that demonstrates receiving, sending, and acknowledging event messages. Depending on your requirements, you can copy or customize this process to accommodate your organization's specific needs.

The Workflow Send Protocol process receives an event message from a subscription, sends the event message to the inbound agent specified in the subscription, waits to receive an acknowledgement if required, and also sends an acknowledgement if required. You can use the process on one system to send a message to another system, for example, and you can also use the same process on the second system to send the acknowledgement message back to the first system.

The Workflow Send Protocol workflow consists of one process, the Workflow Event Protocol process. This process is launched when it receives an event message from an event subscription.

You can start the Workflow Send Protocol workflow by any of the following methods:

• Raise the Workflow Send Protocol event from the Raise event page. Enter a unique event key, and enter any valid XML document as the event data. A predefined subscription sends the event message to the Workflow Event Protocol process. See: Raising Events and Workflow Send Protocol Events.

• The process can also be started when an agent receives the Workflow Send Protocol event from an external source. A predefined subscription sends the event message to the Workflow Event Protocol process. See: Workflow Send Protocol Events.

• Define your own subscription to send any event you choose to the Workflow Event Protocol process. In the subscription, specify the workflow item type as WFSNDPRT and the workflow process name as WFEVPRTC. Ensure that you either use the default rule function or include send processing in your custom rule function to send the event to the workflow. The Workflow Event Protocol process starts when the subscription is executed and the process receives the event message. See: To Define an Event Subscription.

Related Topics

The Workflow Send Protocol Item Type

Summary of the Workflow Event Protocol Process

Workflow Event Protocol Process Activities

Workflow Send Protocol Events

The Workflow Send Protocol Item Type

The Workflow Send Protocol process is associated with an item type called Workflow Send Protocol. Currently there is one workflow process associated with Workflow Send Protocol: the Workflow Event Protocol process.

To view the details of the Workflow Send Protocol item type in the Workflow Builder, choose Open from the File menu. Then connect to the database and select the Workflow Send Protocol item type, or connect to a file called wfsndprt.wft in the <ORACLE_HOME>\wf\Data\<language> directory.

If you examine the property page of Workflow Send Protocol, you see that it has a persistence type of Temporary and persistence number of days of 0. This means that the runtime data associated with any work items for this item type are eligible for purging as soon as they complete.

The Workflow Send Protocol item type also has several attributes associated with it. These attributes reference information in the Workflow application tables. The attributes are used and maintained by function activities as well as event activities throughout the process. The following table lists the Workflow Send Protocol item type attributes.

Summary of the Workflow Event Protocol Process

To view the properties of the Workflow Event Protocol process, select the process in the navigator tree, and then choose Properties from the Edit menu. This process activity is runnable, indicating that it can be initiated as a top level process to run.

When you display the Process window for the Workflow Event Protocol process, you see that the process consists of eight unique activities, some of which are reused to make up the ten activity nodes that appear in the workflow diagram. To examine the activities of the process in more detail, we have numbered each node for easy referencing below. The numbers themselves are not part of the process diagram.

Workflow Event Protocol Process

The Workflow Send Protocol workflow begins when the Event Manager sends an event message to the Workflow Event Protocol process. For example, when you raise the Workflow Send Protocol event locally or receive that event from an external source, predefined subscriptions send the event message to the Workflow Event Protocol process. See: Workflow Send Protocol Events.

The workflow begins at node 1 with the Receive message activity. At node 2, the process attempts to retrieve the agent details for the intended outbound and inbound agents from the subscription.

If no inbound agent is specified, the process continues immediately to node 6 to determine whether to send an acknowledgement message.

If the subscription does specify a To Agent, the process sends the event message to that agent. Then the process determines whether the event message requires an acknowledgement from the recipient, based on a subscription parameter. If an acknowledgement is required, the Workflow Engine waits to receive the acknowledgement message. Otherwise, the process continues immediately to node 6 to determine whether to send an acknowledgement message.

At node 6, the process determines whether it should send an acknowledgement of the original message that it received. If no acknowledgement needs to be sent, the process ends at this point. Otherwise, the process retrieves the agent details for the inbound agent where the acknowledgement must be sent and sends the acknowledgement message to that agent. Then the process ends.

Workflow Event Protocol Process Activities

Following is a description of each activity in the process, listed by the activity's display name.

Receive Message (Node 1)

This event activity receives the event message that is sent to the Workflow Event Protocol process by the Event Manager to start a new item.

Get Agent Details (Node 2)

This function activity attempts to retrieve the agent details from the subscription for the outbound agent that should send the message and the inbound agent that should receive the message. If no inbound agent is specified, the process continues immediately to node 6. If an inbound agent is specified, but no outbound agent is specified, the function selects a default outbound agent on the local system.

Send Event Message (Node 3)

This event activity sends the event message from an outbound agent on the local system to the specified inbound agent.

Compare Text (Node 4)

This Standard function activity compares two text values. At this node, the process checks the Acknowledge Required? item attribute to determine whether the event message sent at node 3 requires an acknowledgement from the recipient.

If the subscription that initiated the process included the parameter name and value pair ACKREQ=Y, the Workflow Engine sets the Acknowledge Required? item attribute to Y when the process is launched. In this case, the process continues from node 4 to node 5. Otherwise, the process continues directly from node 4 to node 6.

Receive Acknowledgement Message (Node 5)

This event activity waits to receive the Workflow Send Protocol Acknowledgement event message that is returned to the Workflow Event Protocol process from the system that received the event message sent at node 3.

Compare Text (Node 6)

This Standard function activity compares two text values. At this node, the process checks the Send Acknowledgement? item attribute to determine whether to send an acknowledgement of the original message that it received.

If the original message requires an acknowledgement, the Workflow Engine sets the Send Acknowledgement? item attribute to Y when the process is launched. In this case, the process continues from node 6 to node 7. Otherwise, the process ends at node 10.

To Agent Details (Node 7)

This function activity selects an inbound agent on the originating system where the acknowledgement must be sent and retrieves the agent details for that agent.

Send Acknowledgement Message (Node 8)

This event activity sends the Workflow Send Protocol Acknowledgement message from an outbound agent on the local system to the inbound agent identified at node 7.

End (Nodes 9 and 10)

This Standard function activity marks the end of the process.

Workflow Send Protocol Events

Workflow Send Protocol Event

You can raise this event from the Raise Event page to send the event message to an agent using the Workflow Event Protocol process in the Workflow Send Protocol item type. This workflow process lets you specify whether the message requires an acknowledgement from the recipient, and whether you want to send an acknowledgement of a message that you have received.

Oracle Workflow provides two default subscriptions to the Workflow Send Protocol event. The first subscription sends the event message to the Workflow Event Protocol process in the Workflow Send Protocol item type when the Workflow Send Protocol event is raised locally. A subscription parameter specifies that the message requires an acknowledgement. This subscription is enabled by default. You can also create a copy of this subscription with the same properties, except you should give your new subscription a customization level of User, and add an outbound agent and inbound agent to the subscription to specify where you want the Workflow Event Protocol process to send the event message. The following table lists the properties defined for this subscription.

The second subscription sends the event message to the Workflow Event Protocol process in the Workflow Send Protocol item type when the Workflow Send Protocol event is received from an external source. This subscription is enabled by default. You can optionally create a copy of this subscription with the same properties, except you should give your new subscription a customization level of User, and add an outbound agent and inbound agent to the subscription to specify that you want the Workflow Event Protocol process to send the event message on to another agent. The following table lists the properties defined for this subscription.

Workflow Send Protocol Acknowledgement Event

Oracle Workflow sends this event back to the originating system when an event message sent to or from the Workflow Event Protocol process requires an acknowledgement.

Oracle Workflow provides one default subscription to the Workflow Send Protocol Acknowledgement Event. This subscription sends the event message to the Workflow Event Protocol process in the Workflow Send Protocol item type when the Workflow Send Protocol Acknowledgement event is received from an external source. This subscription is enabled by default. The following table lists the properties defined for this subscription.

Copyright © 2003, 2006, Oracle. All rights reserved.