Search Results oks_contract_hdr_pub




Overview
Explore in AI Chat

Overview

The PL/SQL package body APPS.OKS_CONTRACT_HDR_PUB is the primary public application programming interface for managing service contract headers within the Oracle E-Business Suite Service (OKS) module. It belongs to the ETRM (Enterprise Contract and Service) family of modules and forms part of the contract lifecycle infrastructure shared with the OKC schema. The package is classified as a PUB (public) API, meaning it is designed for invocation by external callers, including Oracle Forms, concurrent programs, and custom extensions, rather than being restricted to internal package-to-package use. Its status is VALID in the APPS schema.

The package encapsulates the business logic required to create, modify, version, lock, and delete service contract headers. By exposing a controlled public interface, it shields calling applications from the underlying data model complexity distributed across the OKS_K_HEADERS and OKS_K_LINES tables. It relies on foundational utilities such as FND_API for the standard API error and message handling framework, OKC_API and OKC_DATATYPES for common contract operations, and OKS_COVERAGES_PUB for coverage-related processing.

Key Procedures and Functions

The documented interface exposes 23 procedures and functions. The core header operations include:

  • CREATE_HEADER — Creates a new service contract header record.
  • UPDATE_HEADER — Modifies attributes of an existing contract header.
  • DELETE_HEADER — Removes a contract header.
  • LOCK_HEADER — Applies locking semantics to prevent concurrent modification.
  • VALIDATE_HEADER — Performs validation against business rules prior to persistence.

Version-management procedures support the contract versioning model:

Upgrade-related routines include INSERT_ROW_UPG and CREATE_HDR_VERSION_UPG, which support data migration and upgrade scenarios. These procedures are documented by name and purpose only; parameter lists are intentionally not reproduced here.

Tables Accessed

The package reads and writes the core service contract tables through APPS synonyms:

  • OKS_K_HEADERS_B and OKS_K_HEADERS_BH — Base and history tables for contract headers, holding the primary contract attributes.
  • OKS_K_LINES_B, OKS_K_LINES_BH, OKS_K_LINES_TL, and OKS_K_LINES_TLH — Base, history, translation, and translation-history tables for contract lines, ensuring multi-language support and auditability.
  • OKC_K_VERS_NUMBERS — Supplies version numbering used by the version-management procedures.
  • PLITBLM — A PL/SQL index-by table utility used for bulk processing.

Usage Notes

OKS_CONTRACT_HDR_PUB is typically invoked from the Service Contracts forms, from concurrent programs that process contracts in batch, and from custom PL/SQL code that integrates with the service contract data model. It is referenced by 13 other database objects, confirming its role as a central dependency in the OKS/OKC call stack. Because it is a PUB API, developers should call its documented procedures rather than manipulating the underlying OKS_K_HEADERS and OKS_K_LINES tables directly. All error handling follows the FND_API convention, so callers must inspect the returned success and message flags. The package behaves consistently across EBS 12.1.1 and 12.2.2, as it is not dependent on the multi-organization or online patching changes introduced between those releases.