Search Results get_revenue_value




Overview
Explore in AI Chat

Overview

OKL_FORMULAFUNCTION_PVT is a private PL/SQL package body owned by the APPS schema within the Oracle Lease and Finance Management (OKL) module of Oracle E-Business Suite. It belongs to the ETRM (Enterprise Transaction and Revenue Management) family of objects and is classified as a private (PVT) API, meaning its procedures and functions are intended for internal use by the formula engine rather than as a published integration interface. The package provides a template mechanism for the OKL formula engine: it demonstrates how developers can implement formula functions and evaluate parameter values against a contract and its associated lines. The source header indicates an early file revision date (115.2, 2002), confirming this is foundational sample code used to illustrate the extension pattern for operand-based formula evaluation rather than a production business calculation routine.

Key Procedures and Functions

Three functions are documented in the package body, all following the same design pattern: each accepts a contract identifier and a line identifier, and each returns a NUMBER that is consumed as a parameter value by an Operand function in the formula engine.

  • GET_REVENUE_VALUE — Sample function intended to return a revenue-related numeric value for a given contract and line. The embedded developer comment explicitly states it is a demonstration of how to implement a formula function and parameter evaluation, and that a developer may write any logic using the contract ID and line ID. The shipped body returns the constant 1, which serves as a placeholder for custom logic.
  • GET_TAX_VALUE — Sample function structured to return a tax-related numeric value for a contract and line. It follows the identical comment block and placeholder-return convention as GET_REVENUE_VALUE.
  • GET_BONUS_VALUE — Sample function intended to return a bonus-related numeric value for a contract and line, following the same pattern.

The consistent signature and return semantics across all three functions allow the formula engine to treat them interchangeably as operand parameter providers. None of the three functions contains production business logic in the shipped form.

Tables Accessed

No tables are referenced in the documented metadata, and the package body defines no APPS synonyms or SQL statements. The functions are pure code stubs that return literals; any database access would be introduced by a developer extending the sample logic, at which point the contract ID and line ID parameters would typically be used to query OKL contract and line tables.

Usage Notes

This package is invoked by the OKL formula engine when an Operand function requires a parameter value that must be derived programmatically. Because it is classified as PVT and is referenced by zero other packages, it is not a standard call point for external custom code. Its practical role in both EBS 12.1.1 and 12.2.2 is as a developer extension template: implementers copy or modify the sample functions to supply real contract- and line-level values to the formula engine, replacing the placeholder return of 1 with retrieval logic. When adapting the code, the documented contract ID and line ID parameters remain the supported inputs, and the NUMBER return type must be preserved so the operand evaluation continues to function correctly.