Search Results generate_total_pv_rent

Overview

The OKL_GENERATE_PV_RENT_PVT package is a private PL/SQL API within the Oracle Lease and Finance Management (OLFM) module of Oracle E-Business Suite, classified under the PVT (private) API tier. Its principal business function is the generation and calculation of present value (PV) rent amounts associated with lease and financing contracts. Working against contract header, line, stream type, rule, and rate parameter data, the package derives total present value rent figures used in lease pricing, revenue recognition, and cash flow scheduling. The package is not intended for direct external invocation; it exposes internal computational logic that supports higher-level OLFM processing, and it is referenced by one other package in the application schema. The header comment indicates an origin date of January 2008 and a file revision identifier (OKLRTPVS.pls), consistent with the object's long-standing presence across EBS 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

The package exposes four documented programs. GENERATE_TOTAL_PV_RENT is the primary entry point, returning the computed total present value rent for a given contract header (p_khr_id) along with standard API-style return status, message count, and message data outputs. GENERATE_ASSET_RENT derives the rent component attributable to individual assets or lines within a contract, decomposing the overall PV into per-asset contributions. GENERATE_STREAM_ELEMENTS constructs the underlying cash flow stream elements — the dated payment or receipt records — that feed subsequent present value and interest computations; the package's internal record types (cash_flow_rec and cash_flow_tbl, carrying fields such as cf_number, cf_amount, cf_date, cf_days, cf_arrears, cf_stub, cf_dpp, and cf_ppy) support this processing. COMPUTE_IIR calculates the implied interest rate associated with a given set of cash flows, an essential input when present value discounting must reconcile to a contract's rate structure. Each program follows the ETRM convention of accepting an API version and initialization flag and returning status, message count, and message data.

Tables Accessed

The package reads and writes across a defined set of OLFM and shared application tables accessed via APPS synonyms. Contract definition and structure are drawn from OKC_K_HEADERS_B (contract headers), OKC_K_LINES_B (contract lines), OKC_LINE_STYLES_B (line style definitions), OKC_RULES_B and OKC_RULE_GROUPS_B (contract rules and rule groupings governing pricing and rent behavior). Lease-specific attributes come from OKL_K_HEADERS and OKL_K_LINES, while stream behavior and rate parameters are sourced from OKL_STRM_TYPE_B (stream types and their purposes) and OKL_K_RATE_PARAMS (rate and interest parameters). Currency context is obtained from FND_CURRENCIES. Working or staging data for stream generation is held in OKL_ST_GEN_TMPT_SETS, and PLITBLM is used as a PL/SQL index-by table utility for bulk processing. These tables collectively supply the contract, stream, rule, and rate inputs required for accurate PV rent computation.

Usage Notes

Because OKL_GENERATE_PV_RENT_PVT is classified as a private API, it is normally invoked indirectly — through public OLFM APIs, lease generation or repricing concurrent programs, or lease entry forms — rather than called directly by custom code. The presence of the global variable G_commit_count (declared as NUMBER) alongside the constant G_commit_after_records (set to 500) indicates that the package performs periodic intermediate commits during high-volume processing, releasing work every 500 records. This design is typical of bulk stream and cash flow generation, where large contract portfolios are processed in a single run. The header's G_PKG_NAME, G_APP_NAME, G_UNEXPECTED_ERROR, G_SQLERRM_TOKEN, and G_SQLCODE_TOKEN constants conform to the standard ETRM error-handling and logging pattern. Customizations should avoid calling the private programs directly; instead, developers should rely on documented public APIs to preserve upgrade safety across 12.1.1 and 12.2.2. Behavior differences across releases are limited primarily to underlying table columns and dependent public package versions rather than the package's core computational contract.