Search Results get_system_param_value




Overview
Explore in AI Chat

Overview

OKL_SYSTEM_PARAMS_ALL_PUB is the public application programming interface for maintaining and retrieving system-level parameters within the Oracle Lease and Finance Management (OKL) module of Oracle E-Business Suite. The package provides a controlled, API-driven mechanism for creating, modifying, validating, locking, and reading configuration values that govern the behavior of the leasing application across its various sub-processes. These parameters are stored centrally so that multiple functional areas — contract origination, asset management, book and product configuration, and credit card remittance handling — draw from a single, consistent source of operational settings.

The package is declared with AUTHID CURRENT_USER and exposes a set of global constants that identify well-known parameter names, including ITEM_INV_ORG_ID, RPT_PROD_BOOK_TYPE_CODE, ASST_ADD_BOOK_TYPE_CODE, and CCARD_REMITTANCE_ID. It also defines standard return-status constants (G_RET_STS_SUCCESS, G_RET_STS_ERROR, G_RET_STS_UNEXP_ERROR) and exception handles consistent with the Oracle EBS API programming model. The naming of the package and its public classification indicate that it is intended as the supported entry point for external callers, rather than a private utility package.

Key Procedures and Functions

The documented interface comprises eleven procedures and functions, of which the following are the primary public operations:

  • INSERT_SYSTEM_PARAMETERS — Creates new system parameter records, validating the supplied input before persisting rows.
  • UPDATE_SYSTEM_PARAMETERS — Modifies the value or attributes of existing system parameters.
  • DELETE_SYSTEM_PARAMETERS — Removes system parameter records that are no longer required.
  • VALIDATE_SYSTEM_PARAMETERS — Performs validation checks on parameter data before or independent of persistence.
  • LOCK_SYSTEM_PARAMETERS — Obtains a lock on parameter records, supporting controlled, concurrent-safe maintenance.
  • GET_SYSTEM_PARAM_VALUE — Retrieves the value of a specified system parameter. This is the function most commonly referenced by callers who search for "get_system_param_value," and it is the standard read path for consumer code that needs a configuration setting at runtime.

The package also exposes subtype definitions (sypv_rec_type, sypv_tbl_type) inherited from OKL_SYP_PVT, allowing callers to work with record and table structures representing system parameter data. All procedures follow the Oracle API convention of accepting an API version and initialization message list, and returning a return status, message count, and message data.

Tables Accessed

The package operates against a single documented base object, OKL_SYSTEM_PARAMS_ALL, accessed through its APPS synonym. This table is the repository for all system parameter values managed by the OKL application. INSERT_SYSTEM_PARAMETERS writes new rows to it, UPDATE_SYSTEM_PARAMETERS modifies existing rows, DELETE_SYSTEM_PARAMETERS removes rows, and GET_SYSTEM_PARAM_VALUE performs a query against it to return the requested setting. No other tables are documented as being referenced by this package, reflecting its narrow, focused responsibility as a parameter store interface.

Usage Notes

OKL_SYSTEM_PARAMS_ALL_PUB is referenced by approximately twenty other packages within the E-Business Suite, confirming its role as a shared foundation component for the leasing module. It is typically invoked from Oracle Forms-based setup and configuration screens, where administrators maintain system parameters, and from PL/SQL customizations or extensions that need to read a parameter using GET_SYSTEM_PARAM_VALUE. Because the package enforces the standard API return-status contract, callers should always check x_return_status and inspect the message stack via the message count and message data outputs rather than relying on exceptions alone. Direct DML against OKL_SYSTEM_PARAMS_ALL should be avoided; all maintenance should flow through this public API to ensure validation and locking logic is honored. When extending the application, developers should treat the exposed parameter-name constants as the authoritative keys for the settings they represent.