Search Results get_amount_remaining

Overview

AMS_CLAIM_INSTALL is an Oracle E-Business Suite PL/SQL package body owned by the APPS schema that forms part of the Oracle Marketing (AMS) application family. Its principal business function is to provide a lightweight, dependency-safe interface for determining whether the Oracle Trade Management claims functionality — internally designated the "Claims" or "OZF" module — is installed and available in the current environment, and for retrieving monetary balances associated with a given claim.

The package functions largely as a thin wrapper or facade over the underlying OZF_CLAIM_INSTALL package. Rather than embedding business logic directly, AMS_CLAIM_INSTALL delegates the substantive work to OZF_CLAIM_INSTALL and simply normalizes the caller experience. This pattern is common in EBS, where an AMS-namespaced public API shields dependent code from direct coupling to the Trade Management (OZF) schema objects. The header comment dates the source to 2004, and the ETRM classification records it as an "OTHER" API with two documented program units.

Key Procedures and Functions

• CHECK_INSTALLED — A public function returning a BOOLEAN value. Its documented purpose is to check whether the Claims module is installed. It performs this by returning the result of OZF_CLAIM_INSTALL.Check_Installed. A notable defensive behavior is that the function traps all exceptions via a WHEN OTHERS handler and returns FALSE, ensuring that any failure in the underlying check is treated as "not installed" rather than propagating an error to the caller. This makes the function safe to call in conditional guards.
• GET_AMOUNT_REMAINING — A public procedure that returns the remaining amount of the root claim. It accepts a claim identifier as input and returns the amount remaining, the accounted amount remaining, the associated currency code, and a standard FND_API return status. It initializes the return status to FND_API.G_RET_STS_SUCCESS before delegating to OZF_CLAIM_INSTALL.Get_Amount_Remaining, then inspects the returned status to detect error conditions. The procedure carries no documented table access of its own, as the underlying query is executed within OZF_CLAIM_INSTALL.

Tables Accessed

The ETRM metadata records no tables referenced directly by this package through APPS synonyms. This is consistent with its role as a delegation layer: all persistence and query activity is performed inside OZF_CLAIM_INSTALL, which resolves the claims and claim-line tables in the OZF schema. Because neither program unit executes SQL directly, AMS_CLAIM_INSTALL introduces no independent read or write footprint and inherits whatever transactional behavior the underlying OZF routines perform. Callers should therefore regard the OZF claims tables as the effective data source for the amount-remaining values returned.

Usage Notes

AMS_CLAIM_INSTALL is typically invoked from Oracle Forms, concurrent programs, and custom extensions that must operate conditionally on the presence of Trade Management claims. CHECK_INSTALLED is the natural first call in a dependent code path: if it returns FALSE, the calling process can skip claim-related logic rather than failing at runtime against absent objects. GET_AMOUNT_REMAINING is used wherever the outstanding balance of a root claim, in both entered and accounted terms, is required.

Because the package is a wrapper, the more relevant dependency is OZF_CLAIM_INSTALL and, transitively, the presence of the Oracle Trade Management module. Callers should always validate the x_return_status output rather than assuming success, since the procedure deliberately surfaces underlying errors through FND_API status codes. The ETRM metadata notes that no other documented packages reference AMS_CLAIM_INSTALL, indicating that it serves as a client-facing utility rather than a foundational dependency within the AMS package hierarchy. In both EBS 12.1.1 and 12.2.2 the package behaves identically, as it relies solely on the stable OZF_CLAIM_INSTALL interface and the FND_API message constants.