Search Results okl_stream_generator_pub




Overview
Explore in AI Chat

Overview

The APPS.OKL_STREAM_GENERATOR_PUB package body is a public PL/SQL API within the Oracle E-Business Suite Lease Management (OKL) module, part of the Enterprise Tax, Revenue, and Leasing (ETRM) family of applications. Its primary business function is the generation of contractual cash flow streams for a lease or financing contract. In lease accounting and financial servicing, a "stream" represents the scheduled set of periodic payment, interest, and principal amounts that define the financial behavior of a contract over its term. The OKL_STREAM_GENERATOR_PUB package provides the public entry point through which these streams are created, regenerated, or refreshed, and it optionally computes the associated contract rates that drive present-value and interest calculations. The package follows the standard Oracle EBS API architecture, separating the public (PUB) layer, which handles API housekeeping and validation, from a private (PVT) layer, OKL_STREAM_GENERATOR_PVT, which contains the substantive generation logic. The public body was last revised under version 115.9 and is classified as a PUB API, indicating it is intended for supported external invocation.

Key Procedures and Functions

The documented package exposes three procedures or functions, of which the principal and most frequently referenced is GENERATE_STREAMS. This procedure serves as the public wrapper that generates the cash flow streams for a specified contract, identified by the p_khr_id parameter. It accepts parameters that control whether contract rates are computed (p_compute_rates), the scope of generation via p_generation_type (defaulting to 'FULL'), and an optional reporting book class. It returns a contract rates record of type OKL_STREAM_GENERATOR_PVT.rate_rec_type along with standard API return status, message count, and message data outputs.

The body demonstrates the canonical EBS API pattern. It opens with a call to okl_api.start_activity to initialize the message list and validate the API version, then evaluates the returned status, raising OKL_API.G_EXCEPTION_UNEXPECTED_ERROR or OKL_API.G_EXCEPTION_ERROR as appropriate. Control then passes to okl_stream_generator_pvt.generate_streams, which performs the actual generation work. On return, the status is re-evaluated and the public procedure finalizes with okl_api.end_activity. The second documented procedure, GEN_VAR_INT_SCHEDULE, supports generation of variable interest schedules, addressing contracts whose interest terms vary over the lease term rather than remaining fixed.

Tables Accessed

The provided metadata does not enumerate specific base tables accessed via APPS synonyms. Functionally, however, the stream generation process reads and writes the core Lease Management contract and stream tables, including the contract header and line tables together with the stream and rate tables that persist generated cash flows. Because the substantive data manipulation resides in the private package, table-level access is inherited from OKL_STREAM_GENERATOR_PVT. The public body itself primarily performs API plumbing rather than direct DML, using OKL_API for activity management and message handling.

Usage Notes

This package is typically invoked when a lease contract requires initial stream creation, recalculation following a contract modification, or regeneration during booking and rebooking activities. Two other packages reference it, indicating it participates in broader contract lifecycle processing, such as booking or pricing flows. It may be called from Lease Management forms, concurrent programs, or custom PL/SQL code that needs to generate streams programmatically. Callers should always supply a valid p_api_version, initialize the message list as required, and inspect x_return_status for OKL_API.G_RET_STS_SUCCESS, G_RET_STS_ERROR, or G_RET_STS_UNEXP_ERROR. Because the API is version 12.1.1 and 12.2.2 compatible, the same public signature applies across both releases.