Defining Events

arrow icon   To View and Maintain Events:

  1. Use a Web browser to navigate to the Event Manager, using a responsibility and navigation path specified by your system administrator. Then choose the Events tab. See: Oracle Workflow Developer Navigation Paths.

  2. Search for the events you want to display. The main search option is:

    You can also enter the following additional search criteria:

  3. To view the subscriptions to an event, select the subscription icon for that event.

    Note: For events that do not have any subscriptions, a blank subscription icon appears in the Subscription column. For events that do have subscriptions to them, a full subscription icon appears.

  4. If you have workflow administrator privileges, you can use the administration icons and buttons in the Events page to perform administrative operations.

arrow icon   To Create or Update an Event:

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

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

    Note: Your Oracle E-Business Suite installation may include seeded events owned by Oracle E-Business Suite products that you have not licensed. For such events, the Update Event page displays a notice that the event is not licensed. Oracle Workflow will not execute any subscriptions to these events.

  2. Enter the internal name of the event in the Name field. The internal name is case-sensitive. The suggested format is a compound structure of identifiers separated by periods (.) as follows:

    <company>.<family>.<product>.<component>.<object>.<event> 
  3. Enter a display name for the event.

  4. Enter an optional description for the event.

  5. Select Enabled or Disabled as the event status. If you disable an event, its definition remains in the Event Manager for reference, but you cannot use the event in active subscriptions.

  6. If you are defining an event that occurs on your local system, enter a generate function for the event. A generate function is a PL/SQL procedure or Java API that can produce the complete event data from the event name, event key, and an optional parameter list. Define only one generate function for an event, either PL/SQL or Java. See: Standard API for an Event Data Generate Function.

  7. Identify the program or application that owns the event by selecting the application short name in the Owner Tag field. By default, Oracle Workflow sets the Owner Name field to the application name associated with that application short name. However, you can optionally enter a different name in the Owner Name field, such as a particular program or component within the application.

  8. Review the customization level for the event.

arrow icon   To Create or Update an Event Group:

  1. Navigate to the Create Group page or to the Update Group page. The Create Group page and the Update Group page are identical, except that the fields in the Update Group page are populated with previously defined information for the selected event group.

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

    Note: Your Oracle E-Business Suite installation may include seeded event groups owned by Oracle E-Business Suite products that you have not licensed. For such events, the Update Group page displays a notice that the event group is not licensed. Oracle Workflow will not execute any subscriptions to these event groups.

  2. Enter the internal name of the event group in the Name field. The internal name is case-sensitive. The suggested format is a compound structure of identifiers separated by periods (.) as follows:

     <company>.<family>.<product>.<component>.<object>.<event> 
  3. Enter a display name for the event group.

  4. Enter an optional description for the event group.

  5. Select Enabled or Disabled as the event group status. If you disable an event group, its definition remains in the Event Manager for reference, but you cannot use the event group in active subscriptions.

  6. Identify the program or application that owns the event group by selecting the application short name in the Owner Tag field. By default, Oracle Workflow sets the Owner Name field to the application name associated with that application short name. However, you can optionally enter a different name in the Owner Name field, such as a particular program or component within the application.

  7. Review the customization level for the event group.

  8. Select the Apply button to save the event group definition.

  9. To add a member event to the group, select the Add Events to Group button.

    Note: An event group can contain only individual events as its members. It cannot contain another group.

  10. In the Add Events to Group page, search for the events you want to add. The main search option is:

    You can also enter the following additional search criteria.

  11. Select the event or events that you want to add to your event group, and select the Add to Group button.

  12. You can optionally enter new search criteria to search for other events to add to the event group.

  13. After you finish adding events to the event group, select the Apply button to save the event group members.

  14. To delete a member event from the group, select the event in the Update Group page and select the Delete button.

    Note: Deleting a member event from an event group does not delete the event definition for the individual event. The individual event remains in the Event Manager.

arrow icon   To Raise a Test Event:

  1. Navigate to the Test Business Event page.

  2. In the Event Identifier region, specify the event you want to raise.

  3. In the Event Parameters region, optionally enter any additional parameter name and value pairs to be stored in the parameter list within the event message. You can enter up to 100 parameters.

  4. In the Event Data region, you can optionally enter an XML document to describe what occurred in the event.

    Note: You can also assign generate functions in the event definition to generate the event data, or raise the event using the WF_EVENT.Raise() API instead of using the Test Business Event page. These methods let you provide the event data as a CLOB storing up to four gigabytes of data. See: To Create or Update an Event and Raise.

  5. Choose the tier where you want to raise the event and begin event processing.

    The Test Business Event page displays a confirmation message together with the values you submitted for you to review. If the event triggers a Web service subscription that is executed synchronously and returns an XML response, the page also displays that response.

  6. To clear all fields except the Event Name field, select the Clear button. You can then optionally raise another event.