Search Results ahl_appr_object_type

Overview

APPS.AHL_WF_NOTIFICATION_PVT is a private PL/SQL package in the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 releases, owned by the APPS schema and classified as a Private (PVT) API within the Application Help (AHL) product family. Its business function is to provide the mechanism by which AHL applications launch Oracle Workflow notifications that carry an embedded Oracle Application Framework (OA) region. Rather than emitting a plain-text notification, the package constructs and starts a Workflow process whose notification embeds a live OA page, allowing the recipient to view and act on structured application content directly within the notification itself.

The package is declared with AUTHID CURRENT_USER and is therefore executed under the privilege domain of the calling session rather than the definer. It is a supporting utility rather than a public integration surface, meaning customers and integrators generally do not call it directly; it is consumed internally by other AHL components that require OA-embedded approval or notification behaviour. The ETRM metadata indicates the package is referenced by five other packages, confirming its role as a shared internal service. The current source header identifies the file as AHLVNTFS.pls at version 120.1.12020000.2, dated 07-December-2012.

Key Procedures and Functions

The documented package specification exposes exactly one program unit:

• LAUNCH_OA_Notification — A public procedure that launches the Workflow notification process containing an embedded OA region. It accepts the CMRO object type, the Workflow process name and item type, the notification subject, the AOL function name that defines the OA region, and up to three optional name/value parameter pairs to be passed into that region. It returns an item key identifying the launched notification instance and a return status following the FND_API conventions. The item key is meaningful only when the returned status equals FND_API.G_RET_STS_SUCCESS.

The parameter p_object is documented as accepting CMRO object types defined against the lookup type AHL_APPR_OBJECT_TYPE, which is the object the user searched for. This lookup governs the set of valid approval object types that can be supplied when starting an OA-embedded notification.

Tables Accessed

The ETRM metadata for this package lists only DBMS_RANDOM among referenced database objects, accessed through an APPS synonym. DBMS_RANDOM is a supplied PL/SQL package rather than an application table; it is used within this context to generate a unique identifier for the Workflow item key assigned to the launched notification. No AHL or Workflow base tables are documented as being directly read or written by the package specification itself. Persistence of the notification is handled by the Oracle Workflow engine (WF_NOTIFICATIONS, WF_ITEMS and related runtime tables) as a consequence of the launch call, not through direct DML issued by this package.

Usage Notes

Because the package is classified as a Private API, it should be regarded as an internal implementation detail of the AHL approval and notification framework. Typical invocation occurs from other AHL packages (five documented dependents) and from AHL forms or concurrent programs that need to raise an OA-embedded notification as part of an approval flow. Customers extending AHL approvals should prefer the documented public AHL APIs; where a direct call is unavoidable, the caller must supply a valid object type from the AHL_APPR_OBJECT_TYPE lookup, a registered Workflow process and item type, and a valid AOL function for the OA region. Callers must check x_return_status against FND_API.G_RET_STS_SUCCESS before using the returned item key, since the item key is populated only on successful launch. Because the specification is AUTHID CURRENT_USER, the invoking schema must hold the necessary privileges on Workflow and OA objects. Its private status also means the signature is not guaranteed to remain stable across patch levels and should not be treated as a supported integration contract.