Search Results okl_formulae_pub




Overview
Explore in AI Chat

Overview

OKL_FORMULAE_PUB is a public PL/SQL package in the APPS schema that supports the formula management capability of Oracle E-Business Suite's Enterprise Contract and Lease Management (OKL) module. Formula definitions drive the calculated terms used across lease and contract workflows — interest rates, payment streams, escalation and indexation logic, and similar derived values. The package provides the API layer through which formula records are inserted, maintained, validated, locked, and translated, isolating callers from the underlying FMA (Formula Management) private structures.

The object holds a VALID status and is classified as a PUB API, indicating it is an externally callable, supported entry point rather than a purely internal implementation unit. It is documented against both Oracle EBS 12.1.1 and 12.2.2; the published ETRM metadata for 12.2.2 enumerates eleven procedures and functions in total, of which six are individually named.

Key Procedures and Functions

The documented callable units cover the full lifecycle of a formula definition record:

  • INSERT_FORMULAE — creates a new formula definition, persisting the header and associated detail elements supplied by the caller.
  • UPDATE_FORMULAE — modifies an existing formula definition, applying changes to previously created formula records.
  • DELETE_FORMULAE — removes a formula definition from the repository.
  • VALIDATE_FORMULAE — performs the consistency and completeness checks required before a formula is accepted or activated, returning validation outcome to the caller.
  • LOCK_FORMULAE — acquires the lock required to protect a formula record during concurrent maintenance, preventing conflicting updates.
  • ADD_LANGUAGE — inserts the translated (TL) rows for a formula so that its descriptive attributes are available in an additional installed language.

The remaining five documented units are not individually named in the published metadata; they follow the same naming and error-handling conventions and support the same formula administration domain.

Tables Accessed

The package accesses the table exposed through the APPS synonym PLITBLM. In the FMA schema family, this is the translation table holding the language-dependent (TL) columns for formula definitions. Its presence in the dependency list is consistent with the documented ADD_LANGUAGE procedure, which maintains the multilingual representation of formula data rather than the base formula row itself.

The dependency report additionally shows that OKL_FORMULAE_PUB references OKC_API and OKL_FMA_PVT. OKC_API supplies shared contract-management services used during formula validation, while OKL_FMA_PVT provides the private formula-management routines that perform the substantive work behind this public wrapper.

Usage Notes

OKL_FORMULAE_PUB is referenced by the OKL_FORMULAE_PUB package specification/body pairing, by the OKL_FORMULAE_PUB_W wrapper, and by three other packages: OKL_SETUPFMACONSTRAINTS_PVT, OKL_SETUPFORMULAE_PVT, and OKL_SETUPFORMULAE_PVT (listed twice). This places the package squarely in the supporting layer of the Formula Setup and Formula Constraints setup flows.

Typical invocation is therefore indirect. Users maintain formulas through the Oracle Lease and Contract Management setup forms; those forms and their underlying setup packages delegate to OKL_FORMULAE_PUB for persistence and validation rather than issuing direct DML. Concurrent programs and custom extensions that need to create or amend formula definitions programmatically should call these public procedures instead of writing to the base and translation tables, so that locking, validation, and translation-row synchronization are applied consistently. Callers should invoke LOCK_FORMULAE before UPDATE_FORMULAE or DELETE_FORMULAE on a shared record, call VALIDATE_FORMULAE before treating a formula as usable, and call ADD_LANGUAGE whenever a new language is installed or a formula is made available in an additional locale. As with all APPS public APIs, error conditions are surfaced through the standard exception mechanism and should be handled by the calling code.