Search Results oks_extwarprgm_pvt




Overview
Explore in AI Chat

Overview

OKS_IHD_PVT is a private PL/SQL package in the APPS schema that encapsulates the persistence and validation logic for Oracle E-Business Suite service contracts installation history detail records (OKS_INST_HIST_DETAILS). Classified as a PVT (private) API within the ETRM framework, it is not intended as a public integration surface; instead it provides the internal row-level operations that other service contracts packages delegate to when creating, copying, changing, locking, or maintaining installation history detail rows. The package serves as the single point of control for keeping the installation history detail table and its associated view consistent with the service history model used by Service (formerly TeleService and Depot Repair) contract processing.

The user search term "oks_extwarprgm_pvt" identifies one of the packages that depends on OKS_IHD_PVT. OKS_EXTWARPRGM_PVT (external warranty program private API) references OKS_IHD_PVT when processing warranty entitlement and coverage creation, which typically results in new installation history detail rows being recorded against an installed base instance. This dependency confirms the place of OKS_IHD_PVT in the warranty and extended warranty flow of the service contracts module.

Key Procedures and Functions

ETRM documents eighteen procedures and functions in the package. The following are individually named in the metadata, and their purposes are described only in functional terms; parameter signatures are not enumerated.

  • QC — A quality control routine used to assert package-level consistency or preconditions before the main data operations proceed.
  • CHANGE_VERSION — Manages the version identifier on an installation history detail record, supporting version-aware updates and concurrency control.
  • API_COPY — Performs a copy of an existing installation history detail row, used when duplicating coverage or history records across related entities.
  • INSERT_ROW — Creates a new installation history detail record, applying the standard attribute defaults and derived column values.
  • LOCK_ROW — Acquires a lock on the target row, ensuring that concurrent updates through other callers cannot modify the record mid-transaction.
  • UPDATE_ROW — Applies changes to an existing installation history detail record.
  • DELETE_ROW — Removes an installation history detail record, subject to the package's referential rules.
  • VALIDATE_ROW — Executes row-level validation logic, checking required columns and business rules before an insert or update is committed.

These operations follow the standard EBS private API pattern, in which validation, locking, and DML are separated into discrete entry points so that calling packages can compose them within a single transaction.

Tables Accessed

Via APPS synonyms, the package reads and writes OKS_INST_HIST_DETAILS, the base table that stores individual installation history detail lines. The dependency listing also shows references to the OKS_INST_HIST_DETAILS_V view, which is used for query access to the same data. In addition, the metadata lists PLITBLM, the standard Oracle Applications PL/SQL integer table type, used for bulk or multi-row processing parameters. The package further depends on the shared service contracts infrastructure packages FND_API and OKC_API, which supply the common API error handling, message stack, and contract core utilities used throughout the OKS and OKC product families.

Usage Notes

OKS_IHD_PVT is invoked indirectly rather than by end users. The dependency metadata shows it is referenced by OKS_EXTWARPRGM_PVT, OKS_IBINT_PUB, OKS_IHD_PVT, OKS_MASS_UPDATE_PVT, and OKS_OCINT_PUB. Practically, this means the package is called during installation history maintenance flows, mass update of installed base records, warranty program processing, and installed base and order capture integrations. Forms in the Service contracts and installed base areas, concurrent programs that maintain installation history, and custom extensions that need to create or amend history details should normally call the appropriate public API rather than OKS_IHD_PVT directly, because the PVT layer bypasses the higher-level validation and security checks implemented by its callers. The package is valid in both Oracle EBS 12.1.1 and 12.2.2; as with all private APIs, direct references in custom code carry upgrade risk and should be avoided in favor of the documented public interfaces.