Search Results okl_system_params_all_v

Overview

OKL_SYSTEM_PARAMS_ALL_PUB is a public (PUB-classified) PL/SQL API package in the Oracle E-Business Suite Applications (APPS) schema that services the Oracle Lease and Finance Management (OKL) module. Its business function is to provide a controlled, standardized interface for creating, maintaining, validating, and retrieving the system-level parameter records that govern the behavior of the OKL/ETRM application. These system parameters act as configuration switches and default-value holders that influence how lease, contract, and asset transactions are processed across the module. By exposing a public API rather than permitting direct DML against the underlying table, the package enforces the module's business rules, message-handling conventions, and transaction-integrity controls for the OKL_SYSTEM_PARAMS_ALL entity.

The package body carries a header revision of 120.2 dated 2006/07/31, indicating that the API has been stable across release lines and remains valid for EBS 12.1.1 and 12.2.2. The documented procedures delegate their core work to the private package OKL_SYP_PVT, with the public package serving as the sanctioned entry point.

Key Procedures and Functions

The ETRM metadata documents eleven procedures and functions within this package. The primary documented procedures are:

• INSERT_SYSTEM_PARAMETERS — Inserts a new system parameter row, delegating the actual insert to OKL_SYP_PVT and translating its return status into standard API exceptions.
• LOCK_SYSTEM_PARAMETERS — Acquires a lock on a system parameter record, typically used to serialize concurrent modifications before an update or delete.
• UPDATE_SYSTEM_PARAMETERS — Modifies the values of an existing system parameter record through the same delegated pattern.
• DELETE_SYSTEM_PARAMETERS — Removes a system parameter record, subject to the module's validation and referential rules.
• VALIDATE_SYSTEM_PARAMETERS — Performs business-rule validation of the supplied parameter record without persisting changes.
• GET_SYSTEM_PARAM_VALUE — Retrieves the current value of a named system parameter for consumption by callers at runtime.

Each DML-oriented procedure follows a consistent pattern: a SAVEPOINT is established, OKL_SYP_PVT is invoked, and the returned status is inspected. If the private API signals an error or unexpected error, the corresponding exception is raised, a ROLLBACK TO SAVEPOINT is issued, and FND_MSG_PUB.count_and_get is used to populate the message count and data outputs. The OTHERS handler additionally logs the exception via FND_MSG_PUB.ADD_EXC_MSG. This guarantees that partial or failed operations do not leave the table in an inconsistent state.

Tables Accessed

The single documented table accessed by this package is OKL_SYSTEM_PARAMS_ALL, referenced through its APPS synonym. The table stores the system parameter definitions and their configured values for the OKL module. The package reads from it in GET_SYSTEM_PARAM_VALUE and VALIDATE_SYSTEM_PARAMETERS, and writes to it through the insert, update, and delete procedures. All access is mediated by OKL_SYP_PVT and by the view OKL_SYSTEM_PARAMS_ALL_V referenced in the source comments, so direct DML is neither required nor recommended.

Usage Notes

Because it is a PUB-classified API, OKL_SYSTEM_PARAMS_ALL_PUB is the supported interface for maintaining OKL system parameters. It is referenced by approximately twenty other packages within the ETRM code base, making it a foundational configuration dependency for higher-level lease and contract processing. Typical invocation paths include Oracle Forms setup windows for lease management system parameters, concurrent programs that seed or refresh configuration, and custom extensions that need to read a parameter value at runtime. Callers should always provide the standard API parameters (API version, initialization flag, and the OUT return status, message count, and message data), check x_return_status against the G_RET_STS_SUCCESS, G_RET_STS_ERROR, and G_RET_STS_UNEXP_ERROR constants, and surface messages via FND_MSG_PUB. The search term g_ret_sts_error corresponds to the error branch of the return-status constant used in these checks; callers must test for it explicitly to distinguish recoverable errors from unexpected failures. GET_SYSTEM_PARAM_VALUE is the appropriate read-only entry point and avoids locking, whereas LOCK, UPDATE, and DELETE should be used together within a single logical transaction.