Search Results get_error_name




Overview
Explore in AI Chat

Overview

FND_WF_EVENT is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that provides Forms-based access to the Oracle Workflow engine. Its central purpose is to bridge the gap between Oracle Forms, which historically could not natively construct or pass Oracle object types and PL/SQL collections required by the Workflow APIs, and the Workflow runtime, which expects structured event data and parameter collections. The package is classified as OTHER in the ETRM API classification, reflecting its role as a utility rather than a public business API.

Two primary business functions are served. First, the package resolves which Form Function should be launched for a given Workflow notification or item, allowing a user to drill from a notification directly into the correct application form. Second, it exposes a Forms-compatible wrapper for raising Workflow events, since the standard Workflow raise APIs accept object types that Forms cannot instantiate directly. A third, smaller responsibility covers retrieval of Workflow error names for display in the Forms UI. The package carries a source header dated 2005 and declares AUTHID CURRENT_USER, meaning execution privileges are evaluated against the invoking user rather than the package owner.

Key Procedures and Functions

  • GET_FORM_FUNCTION — A public function that returns the Form Function Name applicable to a specific Workflow item type and item key combination. It is the routine most directly associated with the search term "get_form_function." Applications use its return value to determine the correct navigation target when a user opens a notification or clicks through from a Workflow item, so the function is central to notification-to-form integration.
  • RAISE_TABLE — A private procedure that raises a Workflow event. It is documented as callable only from Oracle Forms, existing solely because Forms lacked support for object types. It accepts an event name, event key, optional event data as a CLOB, a PL/SQL parameter table passed IN OUT NOCOPY, a count of parameters, and an optional send date. The parameter table is capped at 100 parameters and must contain consecutive rows beginning at index 1; raise3 must return the same number of parameters as were submitted.
  • GET_ERROR_NAME — A public function that returns the Workflow error name. The documentation explicitly notes it is intended only for use from Forms, and it exists only because Forms cannot fetch from a package directly in the manner required.
  • ERASE — A documented procedure in the package, listed in the ETRM metadata among the four exposed routines. It operates alongside the other Forms-oriented helpers in the package interface.

The package also declares public types Param_Rec and Param_Table, which model a single name/value parameter pair and an indexed collection of such pairs respectively. These types underpin the raise_table interface.

Tables Accessed

The package reads and writes the core Oracle Workflow runtime tables through APPS synonyms. WF_ITEMS and WF_ITEM_ACTIVITY_STATUSES hold the Workflow item instances and their activity status, and are the source from which GET_FORM_FUNCTION derives the owning item's context. WF_ACTIVITIES, WF_ACTIVITY_ATTRIBUTES, WF_ACTIVITY_ATTR_VALUES, and WF_PROCESS_ACTIVITIES describe activity definitions, their attributes, attribute values, and process composition. WF_NOTIFICATIONS and WF_NOTIFICATION_ATTRIBUTES represent the notification records and their attribute values that drive user drill-down. WF_PARAMETER_LIST_T and WF_PARAMETER_T define the Workflow parameter collection types, while PLITBLM is the PL/SQL table used by Forms for list handling. Together these tables supply the item context, activity metadata, notification detail, and parameter structures the package needs to resolve form functions and raise events.

Usage Notes

FND_WF_EVENT is invoked primarily from Oracle Forms, typically from a notification detail block or a custom form that needs to navigate to the application screen associated with a Workflow item. A developer calls GET_FORM_FUNCTION with the item type and item key, then passes the returned function name to the Forms navigation built-in. RAISE_TABLE is used from Forms when a user action must raise a Workflow event; because Forms cannot construct the Workflow object types, the caller populates the Param_Table collection, which is passed by reference and updated in place, so the caller must read back the returned parameters. GET_ERROR_NAME and ERASE round out the Forms-facing surface for error display and cleanup.

Because RAISE_TABLE and GET_ERROR_NAME are restricted to Forms, custom PL/SQL batch code, concurrent programs, and integration code should call the standard Workflow APIs directly rather than this package. The package is referenced by five other packages, indicating it is also reused internally. Values returned by GET_FORM_FUNCTION depend on correctly maintained Workflow activity attribute and item data, so organizations should ensure their Workflow definitions and notification attributes are properly configured; otherwise the function may not return a usable function name and navigation will fail. All calls execute with the privileges of the invoking user due to the AUTHID CURRENT_USER declaration.