Search Results okc_cim_pvt




Overview
Explore in AI Chat

Overview

The APPS.OKC_CIM_PVT package body is a private (PVT classification) PL/SQL implementation within the Oracle E-Business Suite Contracts Intelligence / Contract Information Management (CIM) module. It encapsulates the low-level data-manipulation and version-handling logic for contract line items and related contract header structures. As a private API, it is not intended to be called directly from external code; instead it is consumed by public Contracts APIs, internal packages, and the Contracts forms. The package centralizes the insert, update, delete, lock, and validation behavior for contract item records, and provides the mechanisms for creating, restoring, and changing contract versions. The package is documented as VALID in the APPS schema under both 12.1.1 and 12.2.2, and it depends on OKC_API, OKC_VERSION_PVT, OKC_UTIL, OKC_P_UTIL, OKC_DATATYPES, OKC_DEBUG, and the standard EBS utility packages FND_API, FND_GLOBAL, FND_PROFILE, and APP_EXCEPTIONS. This dependency profile confirms its role as an internal engine layered beneath the public Contracts APIs.

Key Procedures and Functions

The ETRM metadata documents 16 program units, of which the following are named. Each is described by purpose rather than signature, since parameter lists are not enumerated in the documentation.

  • QC — a quality-control / consistency routine used internally to verify contract item data integrity before or after DML operations.
  • CHANGE_VERSION — transitions an existing contract version toward a new version state, coordinating version metadata.
  • API_COPY — copies contract item rows, typically when duplicating or propagating data between contract versions or templates.
  • INSERT_ROW — inserts a new row into the underlying contract item tables.
  • LOCK_ROW — acquires a row-level lock on a contract item record, enforcing concurrency control.
  • UPDATE_ROW — modifies an existing contract item row.
  • DELETE_ROW — removes a contract item row.
  • VALIDATE_ROW — applies business validation rules to a row before persistence.
  • INSERT_ROW_UPG — an upgrade-specific insert routine, used when migrating or seeding contract item data during patch or upgrade processing.
  • CREATE_VERSION — instantiates a new contract version, including the associated item and line records.
  • RESTORE_VERSION — reinstates a previously stored contract version, typically reversing an in-progress version change.

Additional unnamed program units complete the 16 total and support these core operations.

Tables Accessed

The package reads and writes the principal Contracts base and history tables through APPS synonyms:

  • OKC_K_ITEMS — the primary contract line/item entity, the main DML target.
  • OKC_K_ITEMS_H and OKC_K_ITEMS_V — the history and view counterparts used for versioning and query access.
  • OKC_K_HEADERS_ALL_B — the contract header base table, referenced to resolve header context.
  • OKC_K_LINES_B — the contract line base table, referenced for line-level structure.
  • OKC_LINE_STYLES_B and OKC_LINE_STYLE_SOURCES — line style definitions and sources that drive valid item populations.
  • PLITBLM — the standard EBS PL/SQL table type, used for in-memory row collections.

Reference lookups such as OKX_UNITS_OF_MEASURE_V and JTF_OBJECTS_VL supply unit-of-measure and object-registry validation.

Usage Notes

Because OKC_CIM_PVT is a private package and is referenced by 30 other database objects while itself referencing none outside the Contracts and standard EBS utility packages, it is normally invoked indirectly. The Contracts forms, the public OKC_API, and version-management routines such as OKC_VERSION_PVT call into this package to perform row-level DML, locking, validation, and version create/restore/change operations. Custom extensions should not call the private routines directly; they should use the supported public Contracts APIs, which in turn delegate to this body. Direct invocation is appropriate only for Oracle-patched internal flows or carefully controlled upgrade scripts such as those exercising INSERT_ROW_UPG.