Search Results okl_formulae_pub_w




Overview
Explore in AI Chat

Overview

OKL_FORMULAE_PUB_W is the public wrapper package body in the APPS schema that exposes the formulae maintenance API for Oracle Lease and Finance Management (OKL), part of the Oracle E-Business Suite 12.1.1 and 12.2.2 technology stack. It sits alongside the core API OKL_FORMULAE_PUB and the private implementation OKL_FMA_PVT / OKL_FMA_PVT_W, providing the outer, published entry point through which callers create, modify, validate, and remove formula definitions used for lease pricing and contract calculation. Formulae in OKL drive interest accrual, payment stream generation, residuals, and other numeric derivations captured on lease agreements and contract templates. The "_W" suffix denotes a wrapper package, indicating that the body delegates business logic to the underlying private layer (OKL_FMA_PVT_W and OKL_FMA_PVT) while enforcing a consistent public contract.

Key Procedures and Functions

The package exposes a documented set of public programs operating on formula records:

  • INSERT_FORMULAE — Creates a new formula definition, persisting the header and related attributes that describe the formula and its components.
  • UPDATE_FORMULAE — Modifies an existing formula definition, allowing maintained attributes to be changed while preserving identity.
  • DELETE_FORMULAE — Removes a formula definition from the repository, typically after validation that it is not referenced by active contracts.
  • LOCK_FORMULAE — Obtains a concurrency lock on a formula record so that multi-user edits are serialized and lost-update conflicts are avoided.
  • VALIDATE_FORMULAE — Performs business-rule validation on formula data, returning API-style status and error information to the caller before commit.

All five programs follow the Oracle Application Object Library (FND_API) conventions, accepting and returning standard message and return-status structures so that callers can handle success, warning, and error outcomes uniformly. Parameter lists are not reproduced here; consult the packaged specification for exact signatures.

Tables Accessed

The ETRM metadata does not enumerate underlying base tables directly; access occurs indirectly through the private package layers and APPS synonyms. Documented dependencies include OKL_FMA_PVT and OKL_FMA_PVT_W, which encapsulate the DML against the OKL formula tables, and OKC_API, which supplies shared contract/attribute utilities. The wrapper also references FND_API for standard API plumbing. The JTF collection types (JTF_DATE_TABLE, JTF_NUMBER_TABLE, JTF_VARCHAR2_TABLE_100/200/500/2000) are used for bulk or table-structured parameters, consistent with the multi-record editing patterns common in OKL forms. Reads and writes therefore target the OKL formula definition and component entities managed by OKL_FMA_PVT, with validation logic reading configuration and reference data as required.

Usage Notes

OKL_FORMULAE_PUB_W is invoked whenever formula definitions must be maintained programmatically. In standard EBS usage it is called from the Oracle Forms-based OKL setup and maintenance windows, where the LOCK, INSERT, UPDATE, and DELETE operations correspond directly to user actions. It is also the correct entry point for custom PL/SQL, concurrent programs, and interfaces that must create or amend formulae without bypassing validation. The documented dependency graph shows the package is referenced by no other database object at the time of documentation, confirming its position as a top-level public API. As a wrapper, it should be preferred over direct calls to OKL_FMA_PVT so that FND_API error handling and validation remain in effect. Callers should always invoke VALIDATE_FORMULAE before committing changes and must handle the returned API status; concurrent maintenance should rely on LOCK_FORMULAE to prevent conflicting updates.