Search Results okl_fma_pvt




Overview
Explore in AI Chat

Overview

OKL_FMA_PVT is a private PL/SQL package in the APPS schema that supports Oracle E-Business Suite's Oracle Lease and Finance Management (OLFM) module, historically known as the Enterprise Territory and Resource Management (ETRM) lease application. The package name abbreviates "Formulae" (FMA), reflecting its role as the internal implementation layer behind the OKL_FORMULAE_PUB public API, which is used to define formulas applied during lease calculations. In the Oracle EBS architecture, a "PVT" package is the private counterpart to a "PUB" package: the public package exposes callable entry points and performs the bulk of the business validation, while the private package performs the physical row-level operations on the underlying base tables. OKL_FMA_PVT is classified as a private API (classification PVT) and is documented in ETRM 12.2.2; it carries a VALID status in ETRM 12.1.1/12.2.2. It depends on standard Oracle EBS infrastructure packages FND_API (application program interface utilities, commonly used for error handling and API conventions) and OKC_API, and it is referenced by eleven other packages, including OKL_FORMULAE_PUB, OKL_SETUPFORMULAE_PUB and OKL_SETUPFORMULAE_PVT, and the setup FMACONSTRAINTS packages. This dependency pattern confirms that OKL_FMA_PVT is the foundational data management layer for the lease formula setup feature.

Key Procedures and Functions

The package exposes fifteen documented procedures and functions. The metadata lists the following ten by name, each of which is described below by purpose only; parameter lists are intentionally not reproduced.

  • QC — A quality-control routine, typically used to verify that formula records conform to expected data integrity rules.
  • CHANGE_VERSION — Handles version management for formula records, allowing a formula definition to be revised while preserving version history.
  • API_COPY — Copies an existing formula definition, enabling users to create a new formula based on an existing one.
  • ADD_LANGUAGE — Inserts translated language rows for a formula, maintaining the multilingual (TL) side of the formula name and description.
  • INSERT_ROW — Performs the physical insert of a new formula row into the base table.
  • LOCK_ROW — Acquires a lock on an existing formula row to prevent concurrent modification during an update or delete.
  • UPDATE_ROW — Performs the physical update of an existing formula row.
  • DELETE_ROW — Performs the physical delete of a formula row.
  • VALIDATE_ROW — Checks that the data supplied for a formula row satisfies the application's validation rules before insert or update.
  • LOAD_SEED_ROW — Loads seeded (out-of-the-box) formula records during setup or upgrade, a common pattern for Oracle EBS seed data routines.

The remaining five documented subprograms follow the same naming conventions and complete the private API surface.

Tables Accessed

OKL_FMA_PVT accesses the following tables through APPS synonyms:

  • OKL_FORMULAE_B — The base table holding formula definitions; it is the primary insert, update, delete, and lock target.
  • OKL_FORMULAE_TL — The translation table storing language-specific formula names and descriptions, maintained by ADD_LANGUAGE.
  • FND_LANGUAGES — The Oracle EBS languages table, read to validate installed and active language codes.
  • DUAL — Used for single-value queries, commonly to obtain sequence numbers or system values.
  • PLITBLM — A standard EBS PL/SQL table used for bulk processing and temporary storage.

It also depends on the view OKL_FORMULAE_V and on OKC_API. Because OKL_FMA_PVT is referenced by OKL_FORMULAE_PUB, OKL_SETUPFORMULAE_PUB and the setup FMACONSTRAINTS packages, it is the underlying write layer for the entire lease formula configuration feature.

Usage Notes

As a private package, OKL_FMA_PVT should not be called directly by customer code. It is invoked indirectly through OKL_FORMULAE_PUB and the setup formula APIs, which expose the supported entry points and delegate row-level work to this package. In the standard Oracle EBS flow, invocation occurs from the OLFM setup forms that maintain formulae, from concurrent programs that load or validate formula seed data, and during upgrade or patching operations that run LOAD_SEED_ROW for seeded definitions. Customizations should call the public API rather than OKL_FMA_PVT, since direct calls bypass the public validation and error-handling conventions. Understanding this package is relevant when troubleshooting formula setup errors, diagnosing insert or update failures on OKL_FORMULAE_B, or tracing why a formula setup step fails validation, as error messages surfaced by the public API generally originate in the VALIDATE_ROW and row-manipulation routines of this private package.