Search Results okc_k_articles_pvt




Overview
Explore in AI Chat

Overview

OKC_K_ARTICLES_PVT is a private PL/SQL package in the APPS schema that serves as the core data-access and processing layer for contract articles within Oracle E-Business Suite's Enterprise Contracts (OKC / formerly ETRM) module. Articles represent the authored clause and boilerplate text that comprise the body of a contract, and this package encapsulates the procedural logic required to create, maintain, version, and delete that article content. As a "PVT" classified API, it is not intended for direct external invocation; instead, it operates as the private engine consumed by the group-level packages (OKC_K_ARTICLES_GRP), the public API (OKC_K_ARTICLE_PUB), and the terms-processing utilities. It relies on FND_API for the standard Oracle EBS API return-status conventions (success, error, unexpected error), making it consistent with the broader Applications API programming model in release 12.1.1 and 12.2.2.

Key Procedures and Functions

The ETRM metadata documents eleven procedures and functions that together manage the full lifecycle of an article record:

  • INSERT_ROW — Inserts a new article row into the underlying base tables, establishing the initial article definition.
  • UPDATE_ROW — Modifies an existing article row.
  • DELETE_ROW — Deletes a single named article row.
  • DELETE_SET — Deletes a set of article rows in a single operation, used for bulk removal.
  • LOCK_ROW — Acquires a row-level lock on an article, supporting concurrency control during edits.
  • VALIDATE_ROW — Performs validation of article data prior to commit, enforcing business and data-integrity rules.
  • GET_REC — Retrieves an article record for read access.
  • CREATE_VERSION — Creates a new version of an article, part of the versioning behavior supported by the contracts data model.
  • RESTORE_VERSION — Restores a prior article version, allowing reversion of content.
  • DELETE_VERSION — Removes a specific article version.

The version-oriented procedures (CREATE_VERSION, RESTORE_VERSION, DELETE_VERSION) reflect the versioning architecture in which article content is tracked in a separate version table while the base definition is held in the _B / _B_S tables. The package also references the OKC_K_ARTICLES_PVT code itself, indicating recursive or shared internal helper routines.

Tables Accessed

Via APPS synonyms, the package reads and writes the following documented tables:

  • OKC_K_ARTICLES_B — Base table holding the core article definition.
  • OKC_K_ARTICLES_BH — History/archive table capturing prior states of base article rows.
  • OKC_K_ARTICLES_B_S — Sequence/primary-key generation source for base article rows.
  • OKC_ARTICLE_VERSIONS — Stores article version content, supporting the version procedures.
  • OKC_ARTICLES_ALL — The multi-org, entity-visible view over article content.
  • OKC_SECTIONS_B — Sections table, defining the structural hierarchy to which articles belong.
  • DUAL — Used for single-row utility queries (e.g., sequence/date lookups).

Usage Notes

Because OKC_K_ARTICLES_PVT is a private package, it is not called directly from Oracle Forms or concurrent programs. It is invoked indirectly through OKC_K_ARTICLES_GRP (the group layer), OKC_K_ARTICLE_PUB (the public, published API), OKC_TERMS_UTIL_PVT, OKC_TERMS_VERSION_PVT, and OKC_K_ENTITY_LOCKS_GRP, all of which reference it. Customizations and extensions should therefore target the public API (OKC_K_ARTICLE_PUB) rather than this private layer, since the private signature and internals may change between patch levels and are not covered by Oracle's external API guarantee. In both 12.1.1 and 12.2.2, the dependency chain confirms that article creation, versioning, and deletion flows from the Contracts authoring UI or the public contracts APIs ultimately resolve to these routines.