Search Results oks_renew_pub




Overview
Explore in AI Chat

Overview

OKS_RENEW_PUB is the public renewal API within the Oracle Service Contracts (OKS) module of Oracle E-Business Suite. Its principal responsibility is to drive the business process of extending or regenerating a service contract line or contract so that coverage, pricing, and billing continue into a new effective period. Service contracts are time-bound instruments, and renewal is one of the most frequently executed lifecycle operations in the module; this package provides the supported entry point for performing that renewal programmatically rather than through the Service Contracts authoring forms.

The package is declared with AUTHID CURRENT_USER, meaning its SQL executes with the privileges of the calling schema rather than the defining APPS schema. Callers must therefore hold the appropriate grants on the underlying OKC and OKS objects. The header identifies the source as OKSPRENS.pls, version 120.2, dated 2005/08/11, with no ship flag, indicating a core production API rather than a one-off patch utility. The declared global constants — including G_PKG_NAME, G_APP_NAME (referencing OKC_API.G_APP_NAME), and the standard message tokens — reveal that the package reuses the shared Contracts message framework defined in OKC_API rather than defining its own message catalogue. This is significant because it means error and validation messages surfaced by renewal are consistent with those raised by the rest of the Contracts family.

Key Procedures and Functions

The ETRM metadata documents a single public procedure:

  • RENEW — Performs the renewal operation for the target service contract entity. It accepts the standard API parameter block (p_api_version, p_init_msg_list, and related arguments as partially shown in the extracted source) and follows the conventional EBS PL/SQL API contract for initialization, message list population, and commit handling.

The package also declares the global exception G_EXCEPTION_HALT_VALIDATION, which signals that validation processing should be abandoned and control returned to the caller. Callers should be prepared to handle this exception explicitly rather than treating it as an unexpected error.

Tables Accessed

The ETRM extract does not enumerate the base tables referenced by OKS_RENEW_PUB through APPS synonyms. Functionally, a renewal API of this class reads and writes the service contract line and header structures — principally the OKC contract tables that store the contract header and line records, and the OKS service line tables that hold coverage, pricing, and entitlement attributes — together with the associated status and version history that a renewal necessarily creates. The dependency metadata confirms that the package is referenced by one other package, meaning it participates in a wider call graph within the Contracts module rather than standing alone.

Usage Notes

OKS_RENEW_PUB is the publicly callable layer of the renewal functionality; the corresponding private (PRV) package holds the implementation detail. It is typically invoked from the Service Contracts renewal forms, from concurrent programs that batch-renew expiring contracts, and from custom extensions or integration code that needs to renew contracts without user interaction. When invoking it directly, callers should pass a correct API version, inspect the message list on return, and handle G_EXCEPTION_HALT_VALIDATION explicitly. The g_record_logically_deleted constant carried over from OKC_API indicates that the package can report the standard Contracts condition where a row has been logically deleted, so custom code should treat this as a distinct, recoverable validation outcome rather than a hard failure.