Search Results oks_bill_util_pub




Overview
Explore in AI Chat

Overview

The APPS.OKS_BILL_LEVEL_ELEMENTS_PVT package is a private (PVT) PL/SQL API within the Oracle E-Business Suite Service Contracts (OKS) module. It encapsulates the business logic governing bill level elements — the configurable attributes that determine how service contract and subscription lines are grouped, priced, and invoiced at specific hierarchy levels. In ETRM 12.1.1 and 12.2.2, the package operates as the transactional engine for the OKS_LEVEL_ELEMENTS entity, providing the create, read, update, delete, lock, and validation operations that the public API layer and concurrent programs rely upon.

Because it is designated a PVT package, it is not intended as a public integration surface. Instead, it is consumed internally by public APIs such as OKS_BILL_UTIL_PUB — the object most commonly correlated with the user's search term oks_bill_util_pub — which invokes the private package to persist and validate bill level element definitions during billing and contract authoring flows.

Key Procedures and Functions

The ETRM metadata documents 18 procedures and functions. The core documented entry points include:

  • INSERT_ROW — Creates a new bill level element record, applying defaulting and mandatory-column logic before the row is committed to the base table.
  • UPDATE_ROW — Modifies an existing level element record, typically after a successful concurrency check against the row's version column.
  • DELETE_ROW — Removes a level element record, subject to referential and business-rule validation.
  • LOCK_ROW — Acquires a row-level lock to serialize concurrent modifications, supporting optimistic or pessimistic concurrency control.
  • VALIDATE_ROW — Performs attribute-level and cross-field validation, raising the standard FND_API error stack when rules are violated.
  • API_COPY — Duplicates an existing level element definition, enabling rapid creation of similar billing structures.
  • CHANGE_VERSION — Maintains the version/change tracking of a level element record, supporting audit and history requirements.
  • QC — A query/check routine used to retrieve or verify level element data before downstream processing.

All procedures follow the Oracle Application Object Library (FND_API) conventions, returning a standard x_return_status, x_msg_count, and x_msg_data triple so that calling code can interpret success, warning, or error outcomes uniformly.

Tables Accessed

The package reads and writes the following documented tables via APPS synonyms:

  • OKS_LEVEL_ELEMENTS — The primary base table storing bill level element definitions. All INSERT, UPDATE, DELETE, and LOCK operations target this table.
  • OKS_LEVEL_ELEMENTS_V — The validation view used by VALIDATE_ROW and QC to enforce business rules against the current data set.
  • PLITBLM — A standard FND message/translation table leveraged for multi-language message retrieval.

Usage Notes

OKS_BILL_LEVEL_ELEMENTS_PVT is referenced by five documented packages: OKS_ATTR_DEFAULTS_PVT, OKS_BILL_MIGRATION, OKS_BILL_SCH, OKS_BILL_UTIL_PUB, and OKS_INSERT_ROW_UPG, in addition to recursive references to itself. Practically, this means the package is invoked during service contract authoring in the Oracle Forms UI, during billing schedule generation, during legacy data migration, and within the public billing utility API. Custom code should never call the PVT package directly; instead, integrations must route through OKS_BILL_UTIL_PUB or other public APIs so that validation, concurrency control, and message handling remain consistent.