Search Results okl_la_stream_pub




Overview
Explore in AI Chat

Overview

OKL_LA_STREAM_PUB is the public application programming interface for lease and loan stream generation within the Oracle Lease and Finance Management (OKL) module of Oracle E-Business Suite. In the context of ETRM Release 12.2.2, the package carries an API classification of PUB, indicating it is exposed for supported external invocation by forms, concurrent programs, workflows, and custom extensions. The package belongs to the APPS schema and is built on top of the internal private package OKL_LA_STREAM_PVT, from which it inherits the yields_rec_type subtype used when passing interest yield structures between caller and API.

The principal business function served by this package is the creation, recalculation, and maintenance of the accounting and cash-flow streams that underpin a contract's financial schedule. Streams represent the dated, typed movements (rents, fees, interest, amortization, and expenses) that the Lease and Finance engine uses to derive accounting entries, yield calculations, and reporting. The package also supplies parameter extraction routines that marshal contract data into the common streams interface structures used by the stream creation engine.

Key Procedures and Functions

The package exposes seven documented entry points:

  • GENERATE_STREAMS — Drives generation of the contract's streams. It accepts the contract header identifier, a generation context, and a skip-processing-engine flag, returning request, transaction, and standard API messaging status values.
  • UPDATE_CONTRACT_YIELDS — Updates the stored interest yield information for a contract, consuming the yields record type passed by the caller.
  • EXTRACT_PARAMS_LEASE — Extracts lease-specific contract parameters, including lease header, one-off fees, periodic expenses, yields, required stream types, line details, and rents, and returns them in the standard common streams interface structures.
  • EXTRACT_PARAMS_LOAN — Performs the equivalent extraction for loan-type contracts.
  • GEN_INTR_EXTR_STREAM — Generates interest and external stream records associated with the contract.
  • EXTRACT_PARAMS_LOAN_PAYDOWN — Extracts loan parameters required for paydown-related stream processing.
  • EXTRACT_PARAMS_LOAN_REAMORT — Extracts loan parameters required for reamortization processing.

All procedures conform to the OKC_API / OKL_API conventions, accepting an API version and message-list initialization flag and returning standard x_return_status, x_msg_count, and x_msg_data outputs.

Tables Accessed

The documented table reference for this package is OKC_K_HEADERS_B, accessed through an APPS synonym. This is the base table for contract headers in the Oracle Contracts (OKC) schema, and it supplies the contract header identifier and context information required to resolve the correct contract before stream generation or parameter extraction proceeds. Additional contract sub-entity data (fees, expenses, yields, line details, and rents) is passed through the common streams interface record types rather than being enumerated as direct table references in the documented metadata.

Usage Notes

OKL_LA_STREAM_PUB is typically invoked when a user or process initiates stream generation for a lease or loan contract, when yields or interest terms are changed mid-life and streams must be recalculated, and during paydown or reamortization activities on loan contracts. It is called from the Lease and Finance Management forms, from concurrent programs that build and refresh accounting streams in batch, and from custom code that requires a supported, published interface rather than direct manipulation of stream tables.

The package is referenced by ten other packages within the ETRM documentation set, indicating it sits centrally in the stream-generation call graph. Because it is classified PUB, Oracle supports its documented signatures; callers should always check x_return_status and iterate the message list via standard API error-handling utilities before committing work. Direct invocation should respect the generation context and processing-engine flags exposed on GENERATE_STREAMS to avoid duplicate or conflicting stream creation.