"To Create or Update an Event Subscription (Oracle Workflow Developer's Guide)

Oracle Workflow Developer's Guide
Release 2.6.3
Part Number B10284-02


	Previous	Next		Contents	Index	Glossary

To Create or Update an Event Subscription

1. Navigate to the Create Event Subscription page or to the Update Event Subscriptions page. The Create Event Subscription page and the Update Event Subscriptions page are identical, except that the fields in the Update Event Subscriptions page are populated with previously defined information for the selected subscription.

Note: For seeded subscriptions with a customization level of Limit, you can only update the subscription status. For seeded subscriptions with a customization level of Core, you cannot update any properties; you can only view the subscription definition.

Note: Your Oracle Applications installation may include seeded subscriptions owned by Oracle Applications products that you have not licensed. For such subscriptions, the Update Subscription page displays a notice that the subscription is not licensed. Oracle Workflow will not execute any of these subscriptions.

2. In the Subscriber region, enter the system where the subscription executes. Select the field's search icon to display a list of values from which to choose. You can search by the system internal name or display name. See: Using a List of Values.

3. In the Triggering Condition region, specify the type of source system to which the subscription applies in the Source Type field.

Local - The subscription applies only to events raised on the subscribing system.

External - The subscription applies only to events received by an inbound agent on the subscribing system.

Note: All event messages received by an inbound agent on the subscribing system are considered to have an External source, whether the sending agent is located on a remote system or on the local system.

Error - The subscription applies to only to errored events dequeued from the WF_ERROR queue.

4. Enter the event that triggers the subscription in the Event Filter field. You can specify an individual event or an event group. Select the field's search icon to display a list of values from which to choose. You can search by the event internal name. See: Using a List of Values.

5. Enter an optional source agent to which the subscription applies. If you specify a source agent, then the subscription is executed only when the triggering event is received from that agent. Select the field's search icon to display a list of values from which to choose. You can search by the agent name. See: Using a List of Values.

Note: In most cases, the Source Agent field is left blank.

6. In the Execution Condition region, enter an optional phase number for the subscription to specify the order in which subscriptions triggered by the same event are executed. The phase number also controls whether a subscription is executed immediately or is deferred.

7. Select Enabled or Disabled as the subscription status. If you disable a subscription, it still remains in the Event Manager for reference, but it can no longer be executed when events occur.

8. In the Rule Data field, specify the event information required by the subscription.

Key--The subscription requires only the event key.

Message--The subscription requires the complete event data.

9. You can review the customization level for the subscription.

Core - No changes can be made to the subscription definition. This level is used only for subscriptions seeded by Oracle Applications.

Limit - The subscription status can be updated to Enabled or Disabled, but no other changes can be made to the subscription definition. This level is used only for subscriptions seeded by Oracle Applications.

User - Any property in the subscription definition can be updated. This level is automatically set for subscriptions that you define.

10. In the Action region, define the subscription processing you want to perform when the triggering event occurs. Subscription processing can include:

Running a function on the event message.

Sending the event message to a workflow process.

Sending the event message to an agent.

11. Enter the rule function to run on the event message. The rule function must be defined according to a standard API. See: Standard API for an Event Subscription Rule Function.

Enter the rule function in the following format:

 <package_name>.<function_name>

Note: If you enter a rule function other than the default, Oracle Workflow does not automatically send the event message to the specified workflow and agent. You must explicitly include the send processing in your custom rule function instead. You can still enter workflow and agent information in the Action region for your function to reference, however.

12. If you want to send the event message to a workflow process, enter the workflow item type to which the process belongs in the Workflow Type field and the name of the process in the Workflow Process field. Select each field's search icon to display a list of values from which to choose. You can search for the workflow type by the internal name, display name, or description, and for the workflow process by the process name. See: Using a List of Values.

Note: The list of values for the Workflow Process field includes only the runnable processes within the item type you specify.

13. If you want to send the event message to an agent, enter either the Out Agent that you want to send the outbound message, or the To Agent that you want to receive the inbound message, or both. Select each field's search icon to display a list of values from which to choose. You can search by the agent name. See: Using a List of Values.

If you specify both a To Agent and an Out Agent, Oracle Workflow places the event message on the Out Agent's queue for propagation, addressed to the To Agent.

If you specify a To Agent without an Out Agent, Oracle Workflow selects an outbound agent on the subscribing system whose queue type matches the queue type of the To Agent. The event message is then placed on this outbound agent's queue for propagation, addressed to the To Agent.

If you specify an Out Agent without a To Agent, Oracle Workflow places the event message on the Out Agent's queue without a specified recipient. The Out Agent must use either a multi-consumer queue with a subscriber list or a single-consumer queue.

Note: The Out Agent must be located on the subscribing system. The list of values for the Out Agent field includes only agents with a direction of Out.

The list of values for the To Agent field includes only agents with a direction of In.

14. If you want to send the event message to an agent, select Normal, High, or Low as the priority with which the recipient should dequeue the message.

15. Optionally enter any additional parameters for the rule function in the Parameters field. Use spaces to separate the parameters, and specify the name and value for each parameter in the following format:

 <name1>=<value1> <name2>=<value2> ... <nameN>=<valueN>

Note: If you send the event message to a workflow process and you want to specify additional parameters to set as item attributes for the process, you can enter these parameters in the Parameters field for a subscription and use WF_RULE.SetParametersIntoParameterList() in the subscription rule function to set the subscription parameters into the event message parameter list. The event parameters will then be set as item attributes for the workflow process when the process receives the event. See: SetParametersIntoParameterList, Oracle Workflow API Reference.

16. In the Documentation region, identify the program or application that owns the subscription by entering the program name in the Owner Name field and the program ID in the Owner Tag field.

17. You can review the customization level for the subscription.

Core - No changes can be made to the subscription definition. This level is used only for subscriptions seeded by Oracle Applications.

Limit - The subscription status can be updated to Enabled or Disabled, but no other changes can be made to the subscription definition. This level is used only for subscriptions seeded by Oracle Applications.

User - Any property in the subscription definition can be updated. This level is automatically set for subscriptions that you define.

18. Enter an optional description for the subscription.

19. Select the Apply button to save the subscription. You can also select the Cancel button to return to the previous page without saving the subscription.


	Previous	Next		Contents	Index	Glossary