Search Results log_rules

Overview

OKS_RENEW_UTIL_PVT is a private (PVT) PL/SQL utility package body in the APPS schema that supports the Oracle Service (OKS) contract renewal process. It is not a public API and is not intended for direct customer invocation; rather, it provides the internal logic used by the contract renewal framework and by public renewal-related packages within Oracle E-Business Suite Release 12.1.1 and 12.2.2. The package supplies the plumbing that determines whether a service contract can be renewed, applies renewal defaults and business rules, resolves template and language information for renewal documents, and records diagnostic information during processing. Because the renewal cycle depends on attributes of the original contract, the customer party roles, payment terms, and profile options, OKS_RENEW_UTIL_PVT acts as the centralized point where those disparate sources are read and validated. It carries the PVT classification to signal that its signatures may change between patches, and that callers should rely on the public OKS renewal APIs rather than invoking these procedures directly.

Key Procedures and Functions

The documented interface contains twelve procedures and functions that together cover renewal rule evaluation, contract editability, and document infrastructure lookups.

• GET_RENEW_RULES — Retrieves the renewal rules applicable to a contract, forming the rule set used to drive subsequent renewal decisions.
• LOG_RULES — Writes diagnostic detail about the evaluated renewal rules, supporting troubleshooting and audit of rule outcomes.
• UPDATE_RENEWAL_STATUS — Persists the renewal status on the contract, reflecting the result of renewal processing.
• CAN_UPDATE_CONTRACT — Evaluates whether the contract is in a state that permits update, gating further renewal activity.
• GET_PAYMENT_TERMS — Returns payment term information needed when pricing or defaulting a renewed contract.
• GET_PERIOD_DEFAULTS — Supplies period-related defaults used to construct renewal terms.
• GET_TEMPLATE_SET, GET_TEMPLATE_SET_ID, and GET_TEMPLATE_LANG — Resolve the template set, its identifier, and the appropriate template language for generating renewal output documents.
• EVALUATES — Performs the central evaluation of renewal conditions, consolidating the checks applied to the contract.
• GET_FUNCTION_ACCESS — Determines function-level access, typically consulting FND_FUNCTION, to control which renewal actions are available.
• GET_LANGUAGE_INFO — Returns language information used for document and message rendering.

No parameter lists are asserted here; naming and purpose only are documented.

Tables Accessed

The package reads and writes through APPS synonyms, drawing on both OKS and shared OKC contract tables.

• OKS_K_HEADERS_B and OKC_K_HEADERS_ALL_B — The contract header records whose renewal status and attributes are evaluated and updated.
• OKC_K_PARTY_ROLES_B — Party roles used to identify the customer and other parties relevant to renewal.
• OKS_K_DEFAULTS — Defaulting information applied when constructing renewal terms, including period and payment defaults.
• OKS_TEMPLATE_SET and XDO_TEMPLATES_B — Template set and template definitions resolved for renewal document generation.
• FND_LANGUAGES — Language definitions supporting multilingual template and message handling.
• PLITBLM — The standard PL/SQL table used internally for message or token handling.

Additional dependencies include FND_API, FND_MSG_PUB, FND_MESSAGE, FND_PROFILE, FND_LOG, OKC_API, OKC_CHR_PVT, OKC_CONTRACT_PUB, OKS_CONTRACT_HDR_PUB, OKS_KHR_PVT, and OKS_TEMPLATE_SET_PUB.

Usage Notes

OKS_RENEW_UTIL_PVT is invoked indirectly by the Service Contracts renewal flows, by public renewal and contract APIs, and by concurrent programs that mass-process or generate renewal documents. It is referenced by fourteen other packages, confirming its role as shared internal infrastructure. Direct custom invocation is discouraged because the PVT designation means signatures are not guaranteed across releases; customizations should call the supported public OKS or OKC APIs, which in turn delegate to this logic. Administrators typically encounter this package only through its runtime effects on renewal eligibility, status updates, and template resolution.