Search Results okl_am_integration_pvt




Overview
Explore in AI Chat

Overview

OKL_AM_INTEGRATION_PVT is a private (PVT) PL/SQL package in the Oracle E-Business Suite Applications (APPS) schema belonging to the Oracle Lease and Finance Management (OKL) product family. It provides the internal integration layer between lease management transactions and Oracle Contracts (OKC) subledger functionality, specifically for handling the termination and cancellation of quote records associated with lease contracts. The package is classified as private, meaning its procedures are not intended to be called directly by external consumers; they are instead invoked by the public API layer or by other OKL packages as part of controlled business flows.

The package declares the standard API global constants defined by FND_API and OKL_API, including G_RET_STS_SUCCESS, G_RET_STS_ERROR, G_RET_STS_UNEXP_ERROR, G_TRUE, G_FALSE, and the database error token G_DB_ERROR. It also adopts OKC_API.G_INVALID_VALUE as the local constant G_INVALID_VALUE. This is the identifier that users search on when diagnosing validation failures, because it typically surfaces in error messages when an argument supplied to a termination-quote operation does not conform to the expected domain.

Key Procedures and Functions

  • CANCEL_TERMINATION_QUOTES — The single documented procedure in the package. It cancels termination quotes associated with a lease or contract header. Its parameter set includes the standard API version, an initialization flag for the message list, the contract header identifier (p_khr_id), a source transaction identifier (p_source_trx_id), an optional source indicator (p_source), and the standard output parameters x_return_status, x_msg_count, and x_msg_data that conform to the FND_API error-handling convention. The G_INVALID_VALUE constant is declared within this package to support the validation logic used by this procedure.

Tables Accessed

  • OKC_K_HEADERS_B — The base table for contract headers in Oracle Contracts. It is read to resolve the contract against which termination quotes are being cancelled, and may be referenced when validating the header status and identifier.
  • OKL_SYSTEM_PARAMS — Stores system-level configuration and setup parameters for Lease Management. The package reads these values to determine behavior such as validation thresholds or feature toggles affecting quote cancellation.
  • OKL_TRX_CONTRACTS — The lease transaction-to-contract association table. It links the source transaction identifier to the underlying contract and is central to identifying which contracts are impacted by a cancellation request.
  • PLITBLM — The PL/SQL table used by the FND message stack (via FND_MSG_PUB) to accumulate error and warning messages returned through x_msg_count and x_msg_data.

Usage Notes

Because OKL_AM_INTEGRATION_PVT is a private package, it is not called directly from Oracle Forms or concurrent programs by end users. It is invoked internally by other OKL packages — the ETRM metadata records that it is referenced by four other packages — during lease termination workflows, typically when a user cancels a termination quote from the Lease Management responsibility. The calling public API is responsible for supplying the contract header identifier and source transaction identifier and for propagating the returned status and messages to the user interface.

When troubleshooting the G_INVALID_VALUE condition, the practical guidance is to inspect the parameters passed into the cancellation flow, particularly p_khr_id and p_source_trx_id, since an invalid or null value in either will trigger the standard OKC validation error. Enabling FND debug logging and examining the FND message stack at the time of failure will reveal the exact token replaced by G_INVALID_VALUE. Custom code should never bypass the public API layer to call this package directly, as doing so risks inconsistent contract state and unsupported upgrade paths across EBS 12.1.1 and 12.2.2.