Search Results ame_api3




Overview
Explore in AI Chat

Overview

AME_API3 (internally stored as AMEEAPI3.PKH, header revision 120.5, dated 2006) is a public PL/SQL package in the Oracle Approvals Management (AME) module of Oracle E-Business Suite. The package is classified under the AME product and carries the display name "Ancillary Parallel Approvers Process," which accurately describes its role: it provides secondary, supporting routines that complement the primary AME_API and AME_API2 packages rather than driving the core approval engine itself.

The package installs with AUTHID CURRENT_USER, meaning its SQL executes under the privileges of the calling schema. It is owned by APPS and is exposed to any licensed component of the E-Business Suite. Its central business purpose is to give callers read access to AME configuration metadata—rules, conditions, approval groups, item classes, and attributes—and to manage transient insertions and suppressions of approvers in an approval workflow. Because twenty other packages reference AME_API3, it functions as a shared utility layer consumed by both Oracle-delivered AME components and customer extensions.

Key Procedures and Functions

Twenty-eight documented routines are exposed. They group into the following functional areas.

  • Rule-related: GETRULEDESCRIPTION returns the description text (up to 100 bytes) for a given rule primary key, returning NULL on failure. GETAPPLICABLERULES1, GETAPPLICABLERULES2, and GETAPPLICABLERULES3 return the set of rules applicable to a transaction, each variant accommodating progressively broader result sets. GETCONDITIONDETAILS returns the detail of conditions attached to a rule.
  • Approver manipulation: CLEARINSERTION and CLEARINSERTIONS remove approvers previously inserted by ame_api.insertApprover or ame_api.setFirstAuthorityApprover. CLEARSUPPRESSION and CLEARSUPPRESSIONS remove approvers previously suppressed. GETAVAILABLEINSERTIONS lists approvers that may still be inserted. These routines support the "parallel approvers" use case where an external process modifies the AME-generated approver list before it is finalized.
  • Approval groups: GETALLAPPROVALGROUPS, GETAPPROVALGROUPID, GETGROUPMEMBERS1 through GETGROUPMEMBERS4, and GETITEMCLASSES/GETITEMCLASSID/GETITEMCLASSNAME return approval group definitions, their internal identifiers, and their membership lists.
  • Attributes: GETATTRIBUTEVALUE returns the value of an AME attribute for the current transaction context.

No parameter lists are published in the reference metadata; callers should consult the package specification (AMEEAPI3.PKH) or AME documentation for exact signatures.

Tables Accessed

AME_API3 reads and writes the core AME configuration and execution tables through APPS synonyms:

Usage Notes

AME_API3 is not intended for direct end-user invocation. It is called programmatically from Oracle Forms (approval and approval-group setup screens), from concurrent programs that process or report on approval workflows, and from custom PL/SQL that must inspect or adjust AME configuration or the in-flight approver list. The transient insertion/deletion routines are meaningful only during an active approval transaction: once AME has produced the approver list, a calling application may insert or suppress approvers and later clear those modifications. All calls must be made from a schema with execute privilege on the package, and because the package runs AUTHID CURRENT_USER, callers must have direct object privileges on the underlying AME and Workflow tables. Customers should treat the documented procedures as a public, supported interface and avoid referencing the base tables directly.