Search Results oks_pm_entitlements_pvt




Overview
Explore in AI Chat

Overview

The OKS_PM_ENTITLEMENTS_PVT package is a private PL/SQL API within the Oracle E-Business Suite Service (OKS) module, classified under the APPS schema as a PVT (private) API. Its principal business function is to expose preventive maintenance (PM) entitlement information to callers, bridging service contract data held in the OKC contract schema with the service entitlement logic maintained in OKS. In practical terms, the package resolves, for a given service contract or customer, which preventive maintenance activities and schedules a product or customer is entitled to receive, and it formats that information for downstream presentation.

Because this is a private package, it is not intended to be called directly by external integrators. It exists as an internal implementation layer supporting the public counterpart OKS_PM_ENTITLEMENTS_PUB, which is the only documented object that references this package. The package is marked VALID and depends on several foundational APIs, including FND_API (for the standard EBS API return-status conventions), OKC_API (contract authoring operations), and OKS_ENTITLEMENTS_PUB and OKS_ENTITLEMENTS_PVT for entitlement processing.

Key Procedures and Functions

The documented package exposes six procedures and functions. Descriptions follow from their names and the ETRM metadata; no parameter signatures are asserted.

  • GET_PMCONTRACTS_02_FORMAT — Returns preventive maintenance contract information in a presentation-ready layout. It likely wraps or reformats the data produced by GET_PMCONTRACTS_02 for consumption by a form, OAF page, or reporting layer.
  • GET_PMCONTRACTS_02 — Retrieves the set of PM contracts associated with a given context. The "_02" suffix suggests a versioned variant retained for backward compatibility, a common pattern in OKS APIs.
  • GET_PM_CONTRACTS — The general-purpose accessor that returns preventive maintenance contract records for a customer, product, or entitlement context.
  • GET_PM_SCHEDULE — Returns the preventive maintenance schedule (due dates, frequencies, and planned PM visits) derived from the underlying OKS_PM_SCHEDULES data.
  • GET_PM_CONFIRMATION — Confirms PM entitlement, returning whether a specific PM service or activity is covered under an existing service contract.
  • CHECK_PM_EXISTS — A Boolean-style existence check that indicates whether any PM entitlement or PM activity exists for the supplied criteria, typically used to gate further processing.

Tables Accessed

The package references core service contract and status tables through APPS synonyms, reflecting its hybrid contract-plus-entitlement role:

  • OKC_K_HEADERS_B / OKC_K_HEADERS_ALL_B — Contract headers, providing the parent contract identity and version.
  • OKC_K_ITEMS, OKC_K_LINES_B — Contract line and item data identifying the covered products or services.
  • OKC_K_PARTY_ROLES_B — Contract party roles, used to resolve the customer or covered party.
  • OKC_STATUSES_B — Contract statuses, ensuring only active/valid contracts are considered.
  • OKS_K_LINES_B — The service-specific extension of contract lines that carries entitlement attributes.
  • OKS_PM_ACTIVITIES, OKS_PM_SCHEDULES — The preventive maintenance activity definitions and generated schedules.
  • PLITBLM — A standard Oracle EBS PL/SQL index-by table of varchar2 used for passing lists/collections between procedures.

Usage Notes

OKS_PM_ENTITLEMENTS_PVT is normally invoked indirectly. The documented reference graph shows it is called by OKS_PM_ENTITLEMENTS_PUB, which is the sanctioned entry point for forms, OAF-based service pages, concurrent programs, and custom code that need PM entitlement data. It in turn calls OKS_ENTITLEMENTS_PVT and OKS_ENTITLEMENTS_PUB to layer entitlement resolution over the raw contract data.

Typical invocation scenarios include the Service Contracts and Preventive Maintenance forms, service workbench entitlement lookups, and concurrent programs that regenerate PM schedules against active contracts. Applications developers should not call this private package directly; because PVT packages carry no backward-compatibility guarantee, direct dependencies risk breakage during patching or upgrades between 12.1.1 and 12.2.2. When integrating PM entitlement logic, use the public wrapper and observe the FND_API return-status convention.