Search Results okc_renew_pvt




Overview
Explore in AI Chat

Overview

OKC_RENEW_PUB is the public (PUB) API package in the Oracle E-Business Suite Contracts (OKC) module responsible for driving contract renewal and auto-renewal processing. It is the externally callable interface for the renewal engine and operates under AUTHID CURRENT_USER, meaning it executes with the privileges of the calling user rather than its owner. The package exposes the renewal lifecycle to forms, concurrent programs, and custom code while delegating core validation and persistence logic to its private implementation counterpart, OKC_RENEW_PVT, whose record and table subtypes (renew_in_parameters_rec, renew_in_parameters_tbl, renew_out_parameters_rec, renew_out_parameters_tbl) are re-exposed through the public package for use by callers.

In the context of the user search terms "Refresh Offer" and "Cancel," this package is relevant because renewal processing refreshes offer and contract data and includes cancellation-aware validation paths. Its is_renew_allowed and is_already_not_renewed checks determine whether a contract or offer is eligible for renewal, which is directly affected when an offer or contract has been canceled.

Key Procedures and Functions

  • AUTO_RENEW — Top-level procedure that performs automatic renewal of contracts. It accepts contract, duration, and UOM parameters and a flag indicating whether the call originated from the UI, and returns standard concurrent-program style errbuf and retcode outputs so it can be registered as a concurrent program.
  • IS_RENEW_ALLOWED — Boolean function that evaluates whether renewal is permitted for a given contract ID and status code.
  • PRE_RENEW — Pre-processing procedure that accepts the renewal input parameter table and returns an output parameter table, using standard API versioning and message-list conventions (x_return_status, x_msg_count, x_msg_data).
  • RENEW — Core renewal procedure that executes the renewal transaction.
  • VALIDATE_LINE — Validates individual renewal lines prior to processing.
  • CREATE_RENEWED_CONTRACT — Creates the new (renewed) contract header and associated structures.
  • POST_RENEWED_CONTRACT — Performs post-creation processing and updates after the renewed contract is written.
  • VALIDATE — General validation routine for the renewal process.
  • UPDATE_PARENTS_DATE_RENEWED — Updates parent contract records to reflect the date renewed.
  • IS_ALREADY_NOT_RENEWED — Determines whether a contract has already been marked as not renewed.

Tables Accessed

  • OKC_K_HEADERS_ALL_B and OKC_K_HEADERS_B — The contract header base and all tables, read and written to create and update the renewed contract header.
  • OKC_RULES_B and OKC_RULE_GROUPS_B — Contract rules and rule groups that govern renewal behavior and terms.
  • OKC_SUBCLASSES_B — Contract subclass definitions used to classify and control renewal rules.
  • FND_USER — Referenced for user context and audit purposes.
  • PLITBLM — The standard EBS temporary/message table used for message-list handling in API processing.

Usage Notes

OKC_RENEW_PUB is typically invoked from the Contracts forms when a user initiates renewal or refresh of an offer or contract, and from concurrent programs via the AUTO_RENEW entry point, which is structured with errbuf/retcode to support concurrent-manager registration. Because it is classified as a PUB API, custom extensions and integrations may call it directly, observing the standard API conventions: p_api_version, p_init_msg_list, and the x_return_status / x_msg_count / x_msg_data output pattern. The package is referenced by four other packages within APPS, indicating it is a reusable component in the renewal and cancellation workflow. Callers should check IS_RENEW_ALLOWED before invoking renewal, particularly where offers may have been canceled or already processed, since the package explicitly provides IS_ALREADY_NOT_RENEWED to guard against duplicate or invalid renewal attempts.