Search Results okl_execute_formula_pub




Overview
Explore in AI Chat

Overview

The OKL_EXECUTE_FORMULA_PUB package body in the APPS schema is a public API within the Oracle E-Business Suite Lease Management (formerly Oracle Lease Management, OKL) module, part of the Enterprise Contracts and Lease Management family. Its business purpose is to evaluate and execute lease-related formulae defined in the lease management data model. Lease formulae in OKL are configurable expressions used to calculate amounts such as rent, interest, residual value, pricing adjustments, and other financial computations that depend on lease headers, lease lines, and associated variables. This package provides the public entry point for triggering that evaluation logic during lease origination, repricing, or contract modification.

The package is classified as a PUB (public) API, indicating it is intended to be called by other Oracle EBS modules and by customer extensions rather than being an internal-only implementation detail. It delegates core computational work to the companion private package OKL_EXECUTE_FORMULA_PVT, exposing a stable, supported interface to callers while keeping internal logic hidden.

Key Procedures and Functions

The documented metadata identifies the following public program unit:

  • EXECUTE — The principal public procedure of the package. It accepts a formula reference (or equivalent context identifying the formula to be evaluated) along with the lease context needed for evaluation, invokes the underlying private implementation, and returns the computed result or status to the caller. The exact parameter list is not documented in the available ETRM metadata and therefore is not reproduced here; callers should consult the package specification in the APPS schema for the authoritative signature. Consistent with Oracle EBS API standards, the procedure follows the FND_API error-handling convention, returning a standard API return status with a message buffer populated via FND_MSG_PUB.

Tables Accessed

The dependency information shows the package references several lease management views and tables through APPS synonyms:

  • OKL_FORMULAE_V — The view exposing the formula definitions (expression text, variables, and associated metadata) that OKL_EXECUTE_FORMULA_PUB evaluates. This is the central source of the formula being executed.
  • OKL_K_HEADERS_V — The lease contract header view, supplying contract-level attributes and context values required by formulae that depend on header fields (for example, contract dates, currency, and party information).
  • OKL_K_LINES_V — The lease contract line view, providing line-level context such as asset, quantity, and pricing attributes used by formulae that operate at the line level.

The package also depends on the FND_API and FND_MSG_PUB packages for the standard API framework and message handling, on OKC_API and OKL_API for shared contract and lease utilities, and on OKL_EXECUTE_FORMULA_PVT for the actual formula execution engine.

Usage Notes

OKL_EXECUTE_FORMULA_PUB is typically invoked programmatically rather than through a standalone concurrent program or form. Common invocation scenarios include lease authoring and repricing flows within the Lease Management forms, where formula results drive calculated fields; concurrent pricing and billing processes that need to recompute contractual amounts; and custom PL/SQL extensions that must apply the same formula logic as the standard application to remain consistent. Because the metadata records that the package is referenced by 55 other database objects, it is a heavily reused integration point, confirming that callers should treat it as a supported interface rather than modify it. When calling EXECUTE directly, adhere to the FND_API return-status convention: check the returned status, and inspect FND_MSG_PUB for any error or warning messages produced during evaluation. The package body is documented as VALID in EBS 12.1.1 and 12.2.2, and it is not referenced by any database object itself, so no downstream invalidation concerns arise from its recompilation.