Results for “update_version_irs”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

OKL_ITEM_RESIDUALS_PVT is an internal (private) PL/SQL package body in the Oracle Lease and Finance Management (OKL) module of Oracle E-Business Suite, classified under the PVT API layer. It encapsulates the business logic that governs item residual values across the lease lifecycle, including residual creation, versioning, status transitions, and activation. Residual values represent the contractually guaranteed or estimated worth of leased equipment at the end of a lease term, and they drive pricing, rate calculation, and end-of-term processing. Because the package is classified PVT, it is not a published public API; it is consumed internally by ETRM components and by sibling private packages such as OKL_ICP_PVT, OKL_IRH_PVT, OKL_IRV_PVT, OKL_LEASE_RATE_SETS_PVT, and OKL_WF_PVT. The package body is documented as VALID and is not referenced by any database object, confirming its role as an internal implementation unit invoked through higher-level processes rather than directly by external callers.

Key Procedures and Functions

The documented interface exposes eleven procedures that collectively manage the residual record lifecycle:

• GET_EFFECTIVE_DATE — Determines the effective date applicable to a residual operation, anchoring version and status changes to the correct business date.
• CREATE_IRS — Creates a new item residual set record, establishing the residual definition for a leased item.
• UPDATE_VERSION_IRS — Applies modifications to an existing residual version, preserving version history.
• CREATE_VERSION_IRS — Generates a new version of an existing residual record, supporting change tracking over the lease lifecycle.
• CHANGE_LRS_STS — Changes the lifecycle status (for example, draft, active, terminated) of a lease residual set.
• ACTIVATE_ITEM_RESIDUAL — Activates a residual record, making it effective for downstream pricing and accounting.
• REMOVE_TERMS — Removes associated term records from a residual set, supporting restructuring or renegotiation.
• CREATE_IRS_SUBMIT — The submission wrapper for the creation operation, handling orchestration, validation, and workflow invocation.
• UPDATE_VERSION_IRS_SUBMIT — Submission wrapper for version update processing.
• CREATE_VERSION_IRS_SUBMIT — Submission wrapper for version creation processing.
• SUBMIT_ITEM_RESIDUAL — Top-level orchestration procedure that submits an item residual operation for approval or processing, interfacing with the Oracle Workflow engine.

The presence of parallel SUBMIT procedures indicates an asynchronous, workflow-driven pattern in which the core DML operations are wrapped by declarative submission entry points.

Tables Accessed

The package operates against the ETRM residual schema through APPS synonyms. OKL_FE_ITEM_RESIDUAL and OKL_FE_ITEM_RESIDUAL_ALL are the primary residual entities holding item-level residual data and its denormalized/translated view respectively. OKL_FE_EO_TERM_OBJECTS and the view OKL_FE_EO_TERM_VERS_V connect residuals to end-of-term object definitions and their versions. OKL_ITM_CAT_RV_PRCS and OKL_ITM_CAT_RV_PRCS_V hold item category residual processing rules that govern how residuals are calculated. OKL_LEASE_QUOTES_B and OKL_QUICK_QUOTES_B represent the lease quote and quick quote headers from which residual terms originate. FND_LOG_MESSAGES supports debug and diagnostic logging via FND_LOG and OKL_DEBUG_PUB. WF_EVENTS and WF_PARAMETER_LIST_T are used for Oracle Workflow event raising and parameter passing, consistent with the SUBMIT procedures. PLITBLM is the standard PL/SQL table-of-varchar2 index-by table utility used for internal collections.

Usage Notes

As a private package, OKL_ITEM_RESIDUALS_PVT is not intended for direct invocation from forms, concurrent programs, or custom code. It is reached indirectly when users create or modify residuals through the Lease Management and Quick Quote user interfaces, or when end-of-term and pricing processes execute. The dependency list shows it calls FND_API (error handling), MO_GLOBAL (multi-org security), OKL_API, OKL_WF_PVT, and WF_EVENT for workflow integration, indicating that residual changes raise workflow events and honor organization-level access controls. Developers extending ETRM residual functionality should call the public OKL_ITEM_RESIDUALS API rather than this private body, since the PVT layer offers no API compatibility guarantee and may change between releases. The metadata confirms the object is not referenced by any database object, reinforcing that it serves exclusively as an internal helper invoked by dependent ETRM packages.