Search Results error_rule

Overview

APPS.WF_RULE is the Oracle Workflow event subscription rule function library. Its purpose is to supply the standard rule functions that administrators assign to event subscriptions, where a rule function defines precisely what Oracle Workflow does when the subscription's triggering event occurs. The package is declared AUTHID CURRENT_USER, is classified as a public API (API classification OTHER) in the ETRM repository, belongs to product OWF, and is registered against the business entity WF_EVENT. Its lifecycle status is active and its compatibility is marked S (supported).

The package is not a business-transaction processor; it is infrastructure. Most of its entry points are simple, deterministic functions that return a status code — ERROR, SUCCESS, or WARNING — and that optionally mutate the event message passed in. In this role WF_RULE is the mechanism by which a subscription can be made to do nothing, to fail deliberately, to log its payload for diagnosis, or to forward the event as a notification. Because these functions conform to the expected rule-function signature, they can be registered declaratively in the Event Manager without any custom PL/SQL.

Key Procedures and Functions

The documented API contains fourteen functions and procedures:

• LOG — writes the contents of the event message using DBMS_OUTPUT.put_line and returns SUCCESS; used primarily from SQL*Plus for testing and debugging.
• ERROR — returns ERROR and, when configured with a message name in the subscription Parameters field, sets that error message into the event.
• WARNING — returns the WARNING status code for the subscription.
• SUCCESS — returns the SUCCESS status code, allowing a subscription to complete normally without side effects.
• ERROR_RULE — the error-path counterpart to ERROR, applied when a subscription must terminate with an error condition.
• DEFAULT_RULE, DEFAULT_RULE2, DEFAULT_RULE3 — the standard processing rules used by the majority of subscriptions; the numbered variants exist to support differing parameter and Agent handling requirements across releases.
• DEFAULT_RULE_OR — a default rule variant that evaluates multiple conditions in an OR relationship.
• INSTANCE_DEFAULT_RULE — the default rule applied to events raised against a workflow instance.
• DEFAULT_GENERATE — a rule that generates the standard event handling behavior, including invocation of the subscribed function or notification.
• WORKFLOW_PROTOCOL — implements the wf: protocol for event subscription parameters, resolving references to workflow objects so that a subscription can target a workflow construct rather than a bare PL/SQL callable.
• SETPARAMETERSINTOPARAMETERLIST — loads parameters into a WF_PARAMETER_LIST_T structure for use by downstream rule processing.
• SENDNOTIFICATION — sends a notification derived from the event, typically to an agent identified in the subscription definition.

Tables Accessed

All table access is performed through APPS synonyms. The package reads and writes WF_EVENT_T, the event message object that carries the payload and parameter list; WF_PARAMETER_LIST_T, the nested parameter structure populated by SETPARAMETERSINTOPARAMETERLIST; WF_AGENT_T, which describes the recipient agent for notification and default-rule processing; WF_EVENT_SUBSCRIPTIONS, the subscription definitions that supply the rule name, parameters, and status; and WF_ERROR_PROCESSES_S, used by ERROR_RULE and ERROR for error-process resolution. DBMS_LOB is referenced for large event payload handling, DUAL for scalar evaluation, and PLITBLM for PL/SQL table (index-by table) operations.

Usage Notes

WF_RULE is invoked by the Workflow Event Manager at runtime rather than from a form. Administrators reference its functions by name in the Rule Function field of an event subscription, with the Parameter field supplying values such as an error message internal name or a wf: protocol target. Custom code may call LOG, ERROR, and SENDNOTIFICATION directly for diagnostics or for chaining behavior, and the package is referenced by seventeen other packages within the EBS schema. Because rule functions run in the event system's session, the AUTHID CURRENT_USER declaration means privileges are evaluated against the invoking schema, a consideration when granting execute rights to custom users.