Search Results okc_atn_pvt




Overview
Explore in AI Chat

Overview

OKC_ATN_PVT is a private PL/SQL package in the APPS schema that manages the article transaction (or "attachment") records associated with Oracle Contracts. The suffix _PVT classifies it as a private API package: it is not intended for direct invocation by external programs, and its procedures assume that callers have already performed the necessary validations and locking appropriate to the surrounding business flow. Its function is to provide the low-level data manipulation and versioning logic for rows in OKC_ARTICLE_TRANS, the table that stores article and attachment transactions tied to contract headers, lines, and rules.

Within the Contracts (OKC) module, articles represent documents, notes, attachments, or similar textual and binary content attached to a contract or one of its components. OKC_ATN_PVT supplies the mechanism by which these article records are inserted, updated, deleted, locked, versioned, and copied. It therefore underpins higher-level public APIs and the multi-versioning framework used by Oracle Contracts. The package is documented as VALID in both EBS 12.1.1 and 12.2.2, and its dependency metadata shows it is a heavily reused internal building block.

Key Procedures and Functions

The documented interface comprises fifteen procedures and functions:

  • QC — A quality-control / initialization routine that no-ops gracefully when the API is called in a disabled state, a convention used across Oracle EBS private APIs.
  • CHANGE_VERSION — Changes the version context of subsequent operations, so that later calls act against the specified version of the article record.
  • API_COPY — Copies article transaction records, typically used when duplicating a contract or a set of articles.
  • INSERT_ROW — Inserts a new article transaction row into OKC_ARTICLE_TRANS.
  • LOCK_ROW — Locks an existing article transaction row to serialize concurrent modifications.
  • UPDATE_ROW — Applies changes to an existing article transaction row.
  • DELETE_ROW — Removes an article transaction row (or marks it deleted, consistent with the Contracts model).
  • VALIDATE_ROW — Validates the attribute values for a row before insertion or update.
  • CREATE_VERSION — Creates a new version of an article transaction as part of the Contracts versioning framework.
  • RESTORE_VERSION — Restores a previously created version of an article transaction.

Tables Accessed

The package reads and writes the following objects, referenced through APPS synonyms:

  • OKC_ARTICLE_TRANS — The primary table holding article transaction records; the target of insert, update, delete, and versioning operations.
  • OKC_ARTICLE_TRANS_H — The history/_H table that preserves prior versions of article transactions, used by CREATE_VERSION and RESTORE_VERSION.
  • OKC_ARTICLE_TRANS_V — A view over the article transaction data, used for validation and read-back of resolved values.
  • OKC_K_ARTICLES_B — The base table of contract articles, providing article definitions and identifiers.
  • OKC_K_HEADERS_B and OKC_K_LINES_B — The contract header and line base tables, supplying the owning contract context for each article transaction.
  • OKC_RULES_B — The contract rules base table, used when article transactions relate to rules rather than headers or lines.
  • PLITBLM — A standard Oracle EBS PL/SQL index-by table type used for internal collections.

Usage Notes

OKC_ATN_PVT is an internal dependency rather than an entry point. Its documented dependents include OKC_COPY_CONTRACT_PVT, OKC_K_ARTICLE_PVT, OKC_K_ARTICLE_PUB, OKS_COPY_CONTRACT_PVT, and OKS_RENCPY_PVT. This pattern indicates that it is invoked indirectly whenever contracts are created, copied, renewed, or edited through the Contracts and Service Contracts applications, and whenever users attach or modify articles in the Contracts forms or via the public OKC_K_ARTICLE_PUB API.

Custom code should not call OKC_ATN_PVT directly. The supported integration path is the public OKC_K_ARTICLE_PUB API, which in turn delegates to this private package. Direct invocation bypasses the validation, security, and versioning conventions that the public layer establishes, and Oracle does not guarantee the stability of private API signatures across patches or release upgrades.