Search Results oks_headers
Overview
OKC_CONTRACT_PVT is the core private API package for Oracle Contracts (OKC) in Oracle E-Business Suite. It encapsulates the internal business logic used to create, maintain, validate, lock, and delete contract structures, including contract headers, contract lines, governance records, and ancestry relationships that tie contracts together. The package is the private counterpart to the public OKC_CONTRACT API, which is the supported external entry point for programmatic contract manipulation.
Because it is classified as a private (PVT) package, it is not intended for direct invocation by customer extensions. It is called internally by the public API layer and by other OKC packages to perform the low-level DML and validation work against the contract schema. The package is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the calling schema rather than the owner, which is typical for internal Apps packages layered beneath public APIs. It also declares a number of subtype aliases drawn from sibling private packages such as OKC_CHR_PVT, OKC_CLE_PVT, and OKC_CAC_PVT, reflecting its role as an orchestration layer across contract header, line, and component structures.
A user who searches for oks_headers is likely working with the contract header data model. OKC_CONTRACT_PVT is the package that ultimately populates and maintains the header information that surfaces through that view. The package also exposes a GENERATE_CONTRACT_NUMBER procedure, which produces contract numbers based on a source code and modifier, and an UPDATE_ALLOWED function, which determines whether a given contract header may be modified based on its current status.
Key Procedures and Functions
The package exposes 69 documented procedures and functions. The principal groups are:
- Contract header operations — CREATE_CONTRACT_HEADER, UPDATE_CONTRACT_HEADER, DELETE_CONTRACT_HEADER, LOCK_CONTRACT_HEADER, VALIDATE_CONTRACT_HEADER. These manage the primary contract record and enforce locking and validation rules.
- Contract number and status utilities — GENERATE_CONTRACT_NUMBER and UPDATE_ALLOWED, used to assign contract numbers and to gate modifications based on contract state.
- Ancestry operations — CREATE_ANCESTRY and DELETE_ANCESTRY, which maintain the hierarchical relationships between contract records.
- Contract line operations — CREATE_CONTRACT_LINE, UPDATE_CONTRACT_LINE, DELETE_CONTRACT_LINE, FORCE_DELETE_CONTRACT_LINE, LOCK_CONTRACT_LINE, VALIDATE_CONTRACT_LINE. These manage the line-level structure beneath a header, including a forced deletion path for restricted lines.
- Governance operations — CREATE_GOVERNANCE, UPDATE_GOVERNANCE, DELETE_GOVERNANCE, LOCK_GOVERNANCE, VALIDATE_GOVERNANCE, which maintain governance rules attached to contracts.
The remaining documented procedures follow the same create/update/delete/lock/validate pattern applied to other contract sub-entities, providing a consistent internal API surface across the OKC data model.
Tables Accessed
The package reads and writes a broad set of OKC and FND tables through APPS synonyms, including:
- OKC_K_HEADERS_B and OKC_K_HEADERS_ALL_B — the base header tables storing contract header information, including the contract number and status referenced by the oks_headers view.
- OKC_K_LINES_B — contract lines beneath each header.
- OKC_ANCESTRYS — hierarchical relationships among contracts.
- OKC_GOVERNANCES — governance records associated with contracts.
- OKC_K_ACCESSES and OKC_CLASS_OPERATIONS — access control and permitted operations by contract class.
- OKC_K_PARTY_ROLES_B, OKC_CONTACTS, OKC_K_SALES_CREDITS, OKC_ASSENTS — party, contact, credit, and assent data tied to contracts.
- OKC_K_ITEMS, OKC_K_PROCESSES, OKC_K_REL_OBJS — line items, process state, and related object references.
- FND_ATTACHED_DOCUMENTS — attachments linked to contract records.
Usage Notes
OKC_CONTRACT_PVT is invoked internally by the public OKC_CONTRACT API and by 12 other documented packages. Customer code should call the public OKC_CONTRACT API rather than this private package. Typical internal callers include the Contracts forms and concurrent programs that create, amend, or terminate contracts. Because the package is AUTHID CURRENT_USER and private, direct calls from custom code are unsupported and may break across patches or upgrades.