Search Results eva_getfunctionvalue




Overview
Explore in AI Chat

Overview

The APPS.OKL_FORMULAEVALUATE_PUB package body is a public (PUB-classified) API within the Oracle E-Business Suite Contracts (OKL / ETRM — Enterprise Contracts) module. Its business purpose is to evaluate formulae defined against lease and contract agreements, resolving the parameters and function values that drive formula-based calculations such as pricing, interest, residuals, and periodic payment amounts. The package acts as the public wrapper layer that exposes the private implementation housed in OKL_FORMULAEVALUATE_PVT, applying the standard Oracle EBS API validation, message-handling, and savepoint conventions. The source header indicates a build designation of noship (115.4, dated 2004-04-13), which certifies the unit as internal infrastructure rather than an externally exposed or customer-callable entry point.

Key Procedures and Functions

The ETRM metadata documents two public procedures for this package:

  • EVA_GETPARAMETERVALUES — Retrieves the set of parameter values required to evaluate a formula. Based on the source excerpt, it accepts a formula assignment identifier (p_fma_id), a contract header identifier (p_contract_id), and an optional line identifier (p_line_id), and returns a context parameter table (x_ctx_parameter_tbl) along with the standard API return status, message count, and message data outputs. It delegates to the private OKL_FORMULAEVALUATE_PVT.EVA_GetParameterValues, wrapping the call in a savepoint and translating internal return statuses into the standard FND_API.G_EXC_ERROR and G_EXC_UNEXPECTED_ERROR exceptions.
  • EVA_GETFUNCTIONVALUE — Returns the calculated value of a formula function, and is the object returned by the user's search term eva_getfunctionvalue. It resolves an individual function within a formula to its evaluated result. The procedure follows the same public wrapper pattern described above, forwarding to the private implementation and managing messages and return status.

Tables Accessed

Access is performed entirely through APPS synonyms. The parameters and identifiers reference the ETRM contract views OKL_FORMULAE_V (formula definitions, via p_fma_id), OKL_K_HEADERS_V (contract headers, via p_contract_id), and OKL_K_LINES_V (contract lines, via p_line_id). These views supply the contract and formula context from which the formulae evaluation engine derives its working values. The bulk of the underlying data retrieval is delegated to the private package; the public body itself primarily coordinates message handling through FND_MSG_PUB and savepoint management.

Usage Notes

This package is invoked programmatically rather than directly. The metadata records that it is referenced by three other packages, indicating it is called from higher-level ETRM processing rather than from end-user forms directly. Typical callers include contract pricing, billing, and accounting engines that need to resolve a formula's calculated value at runtime. Because the package is classified as a public API and follows FND_API conventions, custom extensions should invoke OKL_FORMULAEVALUATE_PUB rather than the private PKT layer. Callers must initialize the message list, check x_return_status for FND_API.G_RET_STS_ERROR or G_RET_STS_UNEXP_ERROR, and retrieve messages via FND_MSG_PUB before proceeding.