Search Results lock_formulae

Overview

APPS.OKL_FORMULAE_PUB is the public application programming interface for Oracle Lease and Finance Management (OKL/ETRM) formula definitions. Formulae in Oracle E-Business Suite leasing govern the derivation of amounts used throughout lease and loan contracts: payment streams, interest calculations, residuals, and other financial computations defined through formula value sets. The package body follows the standard EBS API architecture by exposing a thin, validation-aware public layer that delegates all persistence work to the private package OKL_FMA_PVT. Its responsibilities include managing savepoints, translating private-layer return statuses into the FND_API error model, propagating message stack contents through FND_MSG_PUB, and shielding callers from direct DML against the underlying formula tables. The header comment in the source shows the object under version control as OKLPFMAB.pls at version 115.10, and the design consistently uses the PL/SQL record type fmav_rec_type as the primary carrier of formula attributes into and out of the API.

Key Procedures and Functions

The documented procedures represent the complete lifecycle of a formula definition:

• INSERT_FORMULAE — Creates a new formula record. The procedure establishes a savepoint, invokes OKL_FMA_PVT.INSERT_ROW, checks the returned status, and rolls back to the savepoint on error. It re-assigns the output record returned by the private layer so callers receive the fully populated formula record.
• UPDATE_FORMULAE — Modifies an existing formula definition. This is the entry point most commonly associated with the catalog search term "update_formulae," and it applies the same savepoint and error-propagation pattern used by the insert routine.
• LOCK_FORMULAE — Acquires a row-level lock on a formula record, typically used before performing a read-modify-write sequence in a concurrent environment.
• DELETE_FORMULAE — Removes a formula definition, subject to the referential and validation rules enforced by the private layer.
• VALIDATE_FORMULAE — Performs non-persistent validation of formula data, allowing callers to confirm correctness before committing changes.
• ADD_LANGUAGE — A multilingual seed routine retained for API consistency. In this body it is implemented as a NULL stub with the private call commented out, meaning no translation rows are created by this procedure in the current release.

Tables Accessed

The only directly documented table reference is PLITBLM, the standard EBS Multi-Lingual Tables (MLS) support table used by the translation infrastructure. Formula attribute data itself is written and read through OKL_FMA_PVT, which owns the DML against the physical formula tables; the public package therefore does not name those objects. Any custom code that queries formula tables directly should instead treat this API as the supported write path.

Usage Notes

OKL_FORMULAE_PUB is referenced by three other packages within the application, indicating it is embedded in higher-level lease origination and setup flows rather than being called in isolation. Typical invocation scenarios include the Lease Management setup forms, concurrent programs that import or maintain formula definitions, and custom extensions that must create or update formulae programmatically. Callers should initialize the message list, pass a valid API version, inspect x_return_status for FND_API.G_RET_STS_ERROR or G_RET_STS_UNEXP_ERROR, and drain the message stack with FND_MSG_PUB on failure. Because write operations are wrapped in savepoints and roll back on error, the API is safe to call within a larger transaction without leaving partial formula rows behind.