Search Results g_exception_halt




Overview

OKL_AM_SYSTEM_PARAMS_PVT is a private (PVT) PL/SQL package in the Oracle E-Business Suite applications schema (APPS), belonging to the Oracle Lease Management (OKL) module. It serves as the internal implementation layer for managing system-level parameter records that govern lease and asset management processing behavior. The package declares AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than the definer, which is standard practice for ETRM private APIs that are wrapped by a public package counterpart.

The companion public package, OKL_SYSTEM_PARAMS_ALL_PUB, exposes the record and table types (sypv_rec_type and sypv_tbl_type) that OKL_AM_SYSTEM_PARAMS_PVT re-declares through SUBTYPE. This design keeps the private package consistent with the public API contract while isolating internal validation and persistence logic. The package observes the standard Oracle EBS API error-handling conventions inherited from OKL_API and OKC_API, including the constants G_RET_STS_SUCCESS, G_RET_STS_ERROR, and G_RET_STS_UNEXP_ERROR, along with the message tokens G_SQLERRM_TOKEN and G_SQLCODE_TOKEN used to surface database errors to callers.

Key Procedures and Functions

The ETRM metadata documents a single procedure within this package:

  • PROCESS_SYSTEM_PARAMS — The principal processing routine for system parameter data. It is the entry point through which parameter record changes are validated and applied to the underlying OKL_SYSTEM_PARAMS tables. Consistent with the package's global variable declarations (including G_API_VERSION, the G_MISS_* missing-value sentinels, and the G_TRUE/G_FALSE flags), the procedure operates on the record and table type structures shared with the public API, and returns status codes conforming to the standard EBS API contract.

No other procedures or functions are documented in the ETRM metadata for this package in release 12.2.2.

Tables Accessed

The documented tables referenced through APPS synonyms are:

  • OKL_SYSTEM_PARAMS and OKL_SYSTEM_PARAMS_ALL — The core parameter tables. OKL_SYSTEM_PARAMS_ALL is the multi-org (or "ALL") variant holding the master set of system parameter values for lease management, and is the principal target of PROCESS_SYSTEM_PARAMS inserts and updates. OKL_SYSTEM_PARAMS provides the organization-specific view of the same data.
  • OKL_SYS_ACCT_OPTS — Stores system accounting options associated with lease parameters; the package references it to keep parameter and accounting-option settings synchronized.
  • FA_BOOK_CONTROLS — The Oracle Assets book controls table. It is referenced for validation of depreciation and accounting book context when processing lease system parameters that depend on asset book configuration.

Usage Notes

As a PVT package, OKL_AM_SYSTEM_PARAMS_PVT is not intended for direct invocation by external or customer code. It is called internally, most typically from:

  • The public wrapper OKL_SYSTEM_PARAMS_ALL_PUB, which forwards validated calls to the private implementation. Customizations should target the public package instead.
  • Oracle Lease Management setup forms and concurrent programs, particularly those handling the System Parameters setup step where users configure lease-wide processing options.

The ETRM metadata records that this package is referenced by two other packages, confirming its role as a shared internal dependency within the OKL module rather than a standalone API. Because the package uses AUTHID CURRENT_USER and standard OKL_API/OKC_API error constants, callers must check the returned status code and, on error, read the ERROR_MESSAGE and ERROR_CODE tokens for diagnostic detail. The user search term g_exception_halt does not appear in the documented source excerpt for this package; that global is associated with other ETRM/OKL exception-handling utilities and is not declared among the global variables shown here.