Search Results oks_coverages_pub




Overview
Explore in AI Chat

Overview

OKS_COVERAGES_PUB is the public (PUB) API package for Oracle Service Contracts (OKS) coverage processing within Oracle E-Business Suite releases 12.1.1 and 12.2.2. It exposes a formally published, version-tolerant interface through which other Oracle modules and customer extensions create, modify, version, and delete service contract coverages without touching the underlying private package OKS_COVERAGES_PVT directly. In the layered ETRM architecture, OKS_COVERAGES_PUB acts as the thin public façade that validates inputs, resolves defaults through OKS_SETUP_UTIL_PUB, and delegates the substantive business logic to OKS_COVERAGES_PVT, wrapping each call in the standard FND_API error-handling and savepoint conventions. The package status is VALID in the APPS schema, and the documented metadata classifies it as a PUB API, confirming that it is intended for supported external invocation rather than internal-only use.

Key Procedures and Functions

The ETRM metadata documents thirteen procedures and functions in OKS_COVERAGES_PUB:

  • CREATE_ACTUAL_COVERAGE — Creates a live coverage record against a contract line, establishing the actual (realized) coverage instance used for entitlement and billing.
  • CREATE_ADJUSTED_COVERAGE — Creates a coverage that reflects adjusted terms, typically used when an existing entitlement must be modified rather than replaced.
  • INSTANTIATE_COVERAGE — Materializes coverage rows from coverage templates defined at the service contract line level.
  • UPDATE_COV_EFF — Updates the effective dates of an existing coverage, controlling the entitlement window.
  • DELETE_COVERAGE — Removes a coverage record.
  • DELETE_HISTORY — Purges historical coverage versions.
  • DELETE_SAVED_VERSION — Removes a stored coverage version snapshot.
  • VERSION_COVERAGE — Creates a new version of an existing coverage, preserving the prior state for audit and rollback.
  • RESTORE_COVERAGE — Reinstates a previously saved coverage version.
  • UNDO_HEADER — Reverses coverage-level (header) processing.
  • UNDO_LINE — Reverses coverage processing at the contract line level.
  • CHECK_COVERAGE_MATCH — Validates whether a candidate coverage matches existing coverage criteria, supporting duplicate and eligibility checks.
  • OKS_BILLRATE_MAPPING — Resolves the billing rate mapping associated with a coverage, linking entitlement to the pricing and billing stream.

No parameter lists are reproduced here; only documented purpose is described, consistent with the ETRM dependency extract.

Tables Accessed

The documented dependency list shows OKS_COVERAGES_PUB referencing the APPS synonyms OKC_K_ITEMS and OKC_K_LINES_B. OKC_K_ITEMS stores contract line items and OKC_K_LINES_B holds the base-table contract line definitions, so the package reads contract structure to resolve the parent line and item under which a coverage is created, updated, versioned, or undone. Write activity against these tables during coverage creation and undo flows is mediated through OKS_COVERAGES_PVT and OKC_API. The package additionally references OKX_SYSTEM_ITEMS_V for item validation and OKS_SETUP_UTIL_PUB for setup and profile defaults; FND_API provides the standard message, savepoint, and error-stack infrastructure.

Usage Notes

OKS_COVERAGES_PUB is invoked by eleven other database objects, and the ETRM metadata records no object that references it, confirming it sits at the top of the call stack for coverage operations. It is typically called from Service Contracts forms, from concurrent programs that mass-create or version coverages during contract authoring and renewal, and from custom PL/SQL extensions that need supported coverage maintenance. Because the package depends on FND_API, callers should follow the standard pattern of initializing the FND message stack, checking the returned API status, and issuing rollback on failure. Direct DML against the underlying OKC and OKS tables should be avoided in favor of these published entry points to preserve versioning, undo, and billing-rate integrity.