Results for “okl_system_params_v”

2 results




AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

OKL_SYP_PVT is a private (PVT) PL/SQL package body in the Oracle E-Business Suite Applications (APPS) schema that supports the Oracle Lease and Finance Management (OKL) module. Its name derives from the OKL System Parameters domain, and it provides the internal application programming interface through which the system-level and organization-level parameters governing lease and finance contracts are created, maintained, validated, and copied. These parameters include, but are not limited to, accounting and depreciation defaults, stream type definitions, formula definitions, item and category validation sources, and location and book controls used during contract origination and asset processing.

The package is designated private because it is not intended for direct invocation by external applications. It serves as the workhorse layer behind the public API surface (for example, OKL_SYP_PUB) and the associated Oracle Forms user interface. Users searching on okl_system_params_v are typically working with the system parameters setup screen or the underlying view that surfaces the OKL_SYSTEM_PARAMS content; OKL_SYP_PVT is the procedural component that persists and validates the data behind that view.

Consistent with Oracle's API conventions, OKL_SYP_PVT borrows the standard error handling utilities from OKL_API, including the ERROR_REC_TYPE and ERROR_TBL_TYPE structures, so that messages raised during processing are accumulated and propagated to the calling layer in a uniform manner.

Key Procedures and Functions

The ETRM documentation lists 18 documented procedures and functions in the package, with the following named entries:

  • QC — A standard quality-control check routine, typically used to assert that mandatory setup prerequisites and system parameter prerequisites are satisfied before dependent processing proceeds.
  • CHANGE_VERSION — Manages versioning of system parameter records, allowing changes to be tracked or copied across versions in support of effective dating and audit requirements.
  • API_COPY — Copies an existing system parameter configuration to a target, commonly used when seeding a new organization or business context from an existing one.
  • INSERT_ROW — Creates a new system parameter record, performing the associated validation and defaulting.
  • LOCK_ROW — Obtains a row-level lock on a system parameter record to prevent concurrent modification during an update or delete.
  • UPDATE_ROW — Modifies an existing system parameter record, revalidating the changed values.
  • DELETE_ROW — Removes a system parameter record, subject to referential and business validation.
  • VALIDATE_ROW — Applies the business rules that ensure a system parameter record is internally consistent and that referenced setup (for example, stream types, formulae, and item categories) exists and is valid.

An additional helper, load_error_tbl, iterates the FND_MSG_PUB message stack and populates the OKL_API error table. It contains a documented workaround for a defect in FND_MSG_PUB: when exactly one message is on the stack, COUNT_AND_GET resets the internal index to 1, and the subsequent GET would otherwise raise NO_DATA_FOUND. The procedure compensates by resetting the message index to G_FIRST in that case. A companion function, find_highest_exception, scans the accumulated messages and returns the highest-severity exception (for example, G_RET_STS_UNEXP_ERROR), giving callers a single status code to act upon.

Tables Accessed

Through APPS synonyms the package reads and writes the following documented tables:

Usage Notes

Because OKL_SYP_PVT is a private package, it is not called directly by end users. It is invoked by the public wrapper package (OKL_SYP_PUB), by the Oracle Forms used to maintain system parameters, and by concurrent programs that seed or migrate lease and finance setups. The metadata indicates the package is referenced by seven other packages, confirming that it forms a lower layer that other OKL components depend upon. Customizations should target the public API rather than this private package, since its interface may change between releases. When a caller invokes an operation, the package validates the row, raises messages to the FND_MSG_PUB stack, then uses load_error_tbl and find_highest_exception to return a consolidated status and error table to the caller.