Search Results oks_pm_entitlements_pub




Overview
Explore in AI Chat

Overview

The APPS.OKS_PM_ENTITLEMENTS_PUB package body is a public PL/SQL API within the Oracle E-Business Suite Service (OKS) module, specifically belonging to the Enterprise Territory and Resource Management (ETRM) / Service Contracts functional area. It provides the externally callable interface for querying preventive maintenance (PM) entitlement information associated with service contracts. In Oracle EBS 12.1.1 and 12.2.2, this package serves as the public wrapper layer that exposes PM entitlement retrieval logic to forms, concurrent programs, and custom integrations, while delegating the substantive business logic to its private counterpart, OKS_PM_ENTITLEMENTS_PVT.

The package is classified as a PUB API, indicating it is intended for external consumption. Its status is VALID in the APPS schema, and it depends on foundational EBS infrastructure packages including FND_API, OKC_API, and OKS_ENTITLEMENTS_PUB, reflecting its role in standard API error handling and contract data retrieval.

Key Procedures and Functions

The documented public interface exposes the following procedures and functions:

  • GET_PM_CONTRACTS — Retrieves the preventive maintenance contracts applicable to a given entitlement or service context. This is the primary entry point for identifying which contracts carry PM coverage.
  • GET_PM_SCHEDULE — Returns the PM schedule information, representing the planned maintenance events derived from the applicable contract entitlements.
  • GET_PM_CONFIRMATION — Provides confirmation data relating to PM coverage, allowing callers to validate whether a specific entitlement includes confirmed preventive maintenance.
  • CHECK_PM_EXISTS — A boolean-style existence check that determines whether any preventive maintenance entitlement is present for the supplied criteria. This is typically used for conditional branching before invoking the heavier retrieval procedures.

The metadata lists five documented procedures/functions in total; the four above constitute the core retrieval and validation surface. Parameter lists are deliberately omitted here, as the package signature should be verified directly against the source in the target instance. All procedures follow standard EBS API conventions, returning status and message information through the FND_API error-handling framework.

Tables Accessed

The package body accesses the following tables through APPS synonyms:

  • OKC_K_HEADERS_B — The contract headers base table, which holds the master contract records. It is used to resolve the contract associated with a PM entitlement.
  • OKS_COV_TYPES_B — The coverage types base table, defining the categories of coverage (including PM) that a contract may include.
  • OKS_COV_TYPES_TL — The translatable (language-dependent) coverage types table, used to return coverage type descriptions in the user's language.

These tables support the join logic that links a contract header to its coverage type definitions, enabling the package to determine which contracts carry PM coverage and to return meaningful descriptive information.

Usage Notes

OKS_PM_ENTITLEMENTS_PUB is invoked when service applications or custom code need to determine PM entitlements for a service contract or covered item. Typical callers include Oracle Service forms, preventive maintenance scheduling logic, and customer-specific extensions that evaluate warranty or service coverage.

Because it is referenced by five other database objects, the package forms part of a broader dependency chain in the OKS entitlement stack; changes to its signature or behavior should be validated against all dependent objects. Custom code should call the PUB package rather than the PVT package to preserve upgrade safety. Callers must always check the returned API status before consuming fetched data, consistent with standard EBS API practice.