Search Results okl_ubb_integration_pub




Overview
Explore in AI Chat

Overview

The APPS.OKL_UBB_INTEGRATION_PUB package is a public PL/SQL API within the Oracle Lease and Finance Management (OLFM) module of Oracle E-Business Suite. Its designation as a _PUB package identifies it as an officially supported public interface, meaning it is intended for invocation by external callers, integration components, and custom code rather than being reserved for internal package use. The package name references "UBB," which in the OLFM context relates to Usage-Based Billing, a functionality that supports contracts where charges are assessed based on metered or usage-driven quantities rather than fixed periodic amounts.

The central business purpose of this package is to programmatically create a usage-based billing contract within the ETRM (Enterprise Transaction and Reporting Management) data model. The package header carries the standard OLFM API identity variables — G_PKG_NAME, G_APP_NAME, and G_API_TYPE — and is declared with AUTHID CURRENT_USER, meaning that privileges are evaluated against the invoker's schema rather than the package owner. This is consistent with the OLFM convention of exposing APIs that respect the calling user's security context.

Key Procedures and Functions

The package exposes a single documented procedure:

  • CREATE_UBB_CONTRACT — Creates a usage-based billing contract. It accepts the standard OLFM API parameters, including an API version number, an initialization flag for the message list, and the conventional OUT parameters for return status, message count, and message data. It accepts an input contract header identifier (p_chr_id) typed against OKC_K_HEADERS_V and returns the resulting contract header identifier (x_chr_id) for the created or processed contract.

The procedure follows the established OLFM error-handling pattern: callers inspect x_return_status against the standard status constants and, when a failure occurs, retrieve diagnostic messages using the message count and message data outputs together with the OLFM/OKC message retrieval utilities.

Tables Accessed

The metadata does not enumerate specific base tables accessed through APPS synonyms. The only documented table reference is OKC_K_HEADERS_V, which supplies the datatype anchor for the contract header identifier parameter and the returned identifier. OKC_K_HEADERS_V is the contract header entity in the Oracle Contracts core schema (OKC), the foundation on which OLFM lease and usage contracts are built. Because CREATE_UBB_CONTRACT creates a contract, it necessarily operates against the contract header and related contract data structures, but the documented package metadata does not itemize those dependencies.

Usage Notes

OKL_UBB_INTEGRATION_PUB is referenced by three other packages, indicating it is embedded in a broader integration flow rather than being called in isolation. It is typically invoked programmatically — from other OLFM integration packages, from custom PL/SQL, or from interfaces that need to establish a usage-based billing contract without manual entry through the Oracle Forms UI. The package was present as early as the 11.5.1-era source header (version 115.1, dated 2002) and remains documented in ETRM 12.2.2, confirming its continuity across the 12.1.1 and 12.2.2 releases. Callers should pass a valid API version, respect the invoker's rights model implied by AUTHID CURRENT_USER, and always evaluate the return status and message outputs to detect and handle errors.