Previous	Next		Contents	Index	Glossary

Oracle Workflow provides several predefined events for significant occurrences within the Business Event System. See: Predefined Workflow Events

When an event occurs in an application on your local system, an event key must be assigned to uniquely identify that particular instance of the event. Then the event must be raised to the Event Manager.

You can raise an event by any of the following methods:

• Raise the event from the application where the event occurs using the WF_EVENT.Raise() API. See: Raise.

• Raise the event from a workflow process using a Raise event activity. See: Event Activity.

• Raise the event manually using the Raise Events page. See: Raising Events.

When you define an event in the Event Manager, you must assign it a unique internal name, which is case-sensitive. The suggested format for these internal names is a compound structure of identifiers separated by periods (.) as follows:

<company>.<family>.<product>.<component>.<object>.<event>

This format allows you to organize the events you define into a classification hierarchy.

You can also define event groups that let you associate any events you want with each other and reference them as a group in event subscriptions. An event group is a type of event composed of a set of individual member events. The internal names of event groups should follow the same format as the names of individual events. Once you have defined an event group, you can register a subscription on the group rather than having to create separate subscriptions for each individual event within it. The subscription will be executed whenever any one of the group's member events occurs.

Note: Event groups cannot be used to raise events. You must raise each event individually.

Any detail information needed to describe what occurred in an event, in addition to the event name and event key, is called the event data. For example, the event data for a purchase order event includes the item numbers, descriptions, and cost. The event data can be structured as an XML document.

The application where the event occurs can include the event data when raising the event to the Event Manager. If the application will not provide the event data, you should specify a Generate function for the event that can produce the complete event data from the event key. The Generate function must follow a standard API. See: Raise and Standard API for an Event Data Generate Function.

If an application raises an event without providing the event data, and any subscriptions to the event require the event data, the Event Manager calls the Generate function to produce the event data. If the event data is required but no Generate function is defined for the event, Oracle Workflow creates a default set of event data using the event name and event key.

If you use a program to create event definitions automatically, the program can set its own name and brief identifier as the owner name and owner tag for the events. The program can then use this identifying information to locate the events that it owns. You can use the Edit Event and Edit Group pages to update the owner name and owner tag manually if necessary.

See Also

To Define an Event Group

To Find Events

To Update or Delete an Event