"To Define Event Details for an Event Node (Oracle Workflow Developer's Guide)

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


	Previous	Next		Contents	Index	Glossary

To Define Event Details for an Event Node

The event action defined for the event activity determines which event details you must define for an event node. For each event detail, it is either required or optional to use an item type attribute to store or retrieve the detail information. Note that you must first create item type attributes of the appropriate types before you can reference those predefined item attributes here. The item type attributes you use for event details must be associated with the same item type that the event activity itself is associated with. See: Item Type Attributes

and To Define an Item Type or Activity Attribute.

1. Display the property pages of an event activity node. Select the Event Details tab.

2. For an activity with the event action Receive, enter the following event details:

Event Name--Optionally select an item type attribute of type text where you want to store the event name that the node receives.

Note: The event activity can only receive events that match the event name specified as the event filter. See: To Create an Event Activity.

Event Key--Optionally select an item type attribute of type text where you want to store the event key that the node receives.

Event Message--Optionally select an item type attribute of type event where you want to store the event message that the node receives.

Note: When the activity receives an event, the Workflow Engine stores the event name, event key, and event message in the item type attributes you specify, and also sets any parameters in the event message parameter list as item type attributes for the process, creating new item type attributes if a corresponding attribute does not already exist for any parameter. See: To Define Optional Activity Details.

Additionally, if the event was originally raised by a Raise event activity in another workflow process, the item type and item key for that process are included in the parameter list within the event message. In this case, the Workflow Engine automatically sets the specified process as the parent for the process that receives the event, overriding any existing parent setting. See: SetItemParent, Oracle Workflow API Reference.

3. For an activity with the event action Raise, enter the following event details:

Event Name--Enter the name of the event that the node raises. You can either specify a constant event name or select an item type attribute of type text that dynamically determines the event name at runtime.

Note: You can only raise an individual event. You cannot raise event groups.

Event Key--Select the item type attribute of type text that contains the event key for the event that the node raises.

Event Data--Optionally select an item type attribute that contains the event data for the event that the node raises. You can store event data in item type attributes of type text, number, date, lookup, role, or attribute. You must not use an item type attribute of type event, however, since the event data is only a part of the complete event message structure which is the format for the event attribute type.

The maximum length of the data you can enter in a text attribute is 4000 bytes. If the event data exceeds 4000 bytes, you should assign a Generate function in the event definition to generate the event data, rather than providing the event data through a text attribute. See: To Define an Event.

Note: The Event Name and Event Key are required for a Raise event activity.

Note: In addition to these event details, you can use the activity attributes for a Raise event activity node to specify parameters that you want to include in the parameter list for the event message. If the event message is later received by another process, the Workflow Engine sets the event parameters as item type attributes for that process. See: To Define Activity Attribute Values.

Also, a Raise event activity automatically sets the item type and item key for the current workflow process in the parameter list for the event message. If the event message is later received by another process, the Workflow Engine uses that item type and item key to automatically set the process that raised the event as the parent for the process that receives the event. See: SetItemParent, Oracle Workflow API Reference.

4. For an activity with the event action Send, enter the following event details:

Event Message--Select the item type attribute of type event that contains the event message that the node sends.

Event Name--Optionally enter the name of the event that the node sends. You can either specify a constant event name or select an item type attribute of type text that dynamically determines the event name at runtime. The event name that you enter here overrides the previous event name value in the event message.

Event Key--Optionally select an item type attribute of type text that contains the event key of the event that the node sends. The event key that you enter here overrides the previous event key value in the event message.

Out Agent--Optionally enter the outbound agent from which the node sends the event. Specify both the agent name and the system name for the agent using the following format:

      <agent_name>@<system_name>

You can either specify a constant Out Agent name or select an item type attribute of type text that dynamically determines the Out Agent name at runtime. The Out Agent that you enter here overrides the previous outbound agent value in the event message.

To Agent--Optionally enter the inbound agent to which the node sends the event. Specify both the agent name and the system name for the agent using the following format:

      <agent_name>@<system_name>

You can either specify a constant To Agent name or select an item type attribute of type text that dynamically determines the To Agent name at runtime. The To Agent that you enter here overrides the previous inbound agent value in the event message.

Note: The Event Message is required for a Send event activity. Additionally, you must either include a To Agent or a From Agent within the event message, or specify a To Agent or an Out Agent in the event details for this node. If you neither specify an inbound agent nor an outbound agent, the event cannot be sent.

Note: If no correlation ID is initially specified in the event message, Oracle Workflow automatically sets the correlation ID to the item key of the process.

5. Choose Apply to save your changes, OK to save your changes and close the property page or Cancel to cancel your changes and close the property page.

To Define Event Details for an Event Node

See Also