Search Results okc_cat_pvt




Overview
Explore in AI Chat

Overview

OKC_CAT_PVT is a private PL/SQL package in the APPS schema that supports the Oracle Contracts (OKC) module's clause and article catalog functionality. Clauses and articles are reusable contract terms maintained in a central repository and later incorporated into individual contract documents. OKC_CAT_PVT supplies the internal programmatic machinery for creating, versioning, and copying these catalog entries. The package is classified as PVT (private), meaning it is intended for internal consumption by other OKC packages and public APIs rather than direct invocation by end users or external integrations. It depends on the FND_API error-handling framework, the OKC_API common utilities package, and the OKC_K_ARTICLES_B and OKC_K_ARTICLES_TL tables plus their views. Its presence in a 12.1.1 and 12.2.2 environment is consistent with the standard Contracts (OKC/OKS/OKE/OKL) application footprint.

Key Procedures and Functions

The documented interface exposes 17 procedures and functions, of which the following are named:

  • QC — A generic quality-control/assertion utility; typically used to validate or enforce internal precondition rules within catalog processing.
  • CHANGE_VERSION — Transitions a catalog article record between versions, supporting the version lifecycle required for clause revision control.
  • API_COPY — Copies an existing catalog article, creating a new record that replicates the source content for reuse or localization.
  • ADD_LANGUAGE — Adds a translated-language row for a catalog article, working against the TL table.
  • INSERT_ROW, UPDATE_ROW, DELETE_ROW — Core DML operations for creating, amending, and removing catalog article records.
  • LOCK_ROW — Applies a database lock to a catalog article record to serialize concurrent edits.
  • VALIDATE_ROW — Checks that a catalog article row satisfies mandatory attribute and reference constraints before commit.
  • INSERT_ROW_UPG — A variant insert used during upgrade processing, likely to preserve versioning or historical consistency.
  • CREATE_VERSION — Establishes a new version of an article within the version-tracking schema (referencing OKC_STD_ART_VERSIONS_B).
  • RESTORE_VERSION — Reverts an article to a previously stored version, supporting audit and rollback requirements.

No parameter lists are documented; callers should consult the package specification in the APPS schema for exact signatures.

Tables Accessed

The package reads and writes several core OKC tables via APPS synonyms:

  • OKC_K_ARTICLES_B and OKC_K_ARTICLES_TL — Base and translation tables holding clause/article catalog content.
  • OKC_K_ARTICLES_BH and OKC_K_ARTICLES_TLH — History shadow tables populated by version and copy operations.
  • OKC_STD_ART_VERSIONS_B — Stores standard article version definitions used by CREATE_VERSION and RESTORE_VERSION.
  • OKC_K_HEADERS_B and OKC_K_LINES_B — Header and line tables providing context for article association.
  • FND_LANGUAGES — Language lookup supporting ADD_LANGUAGE.
  • DBMS_LOB and PLITBLM — Oracle-supplied packages for large-object manipulation and PL/SQL index-by tables.

Usage Notes

OKC_CAT_PVT is not invoked directly by end users. It is referenced by eleven other packages, including OKC_CONTRACT_PVT, OKC_COPY_CONTRACT_PUB, OKC_COPY_CONTRACT_PVT, OKC_K_ARTICLE_PUB, OKC_K_ARTICLE_PVT, OKE_CONTRACT_PUB, OKL_ARTICLE_PUB, OKS_CONTRACTS_PUB, OKS_COPY_CONTRACT_PVT, OKS_RENCPY_PVT, and OKL_OKC_MIGRATION_A_PVT. These callers span Contracts Core, Service Contracts, Leasing, and Purchasing contract features, confirming that catalog article maintenance is a shared capability. Typical invocation occurs through the Contract Terms and Clauses setup forms and through contract copy, renewal, and migration concurrent programs. Customizations should generally call the public wrapper packages (for example OKC_K_ARTICLE_PUB) rather than OKC_CAT_PVT, since the private interface may change between patch levels. When troubleshooting catalog-related errors, OLTP activity on OKC_K_ARTICLES_B and its history tables, combined with the FND_API error stack, usually identifies whether OKC_CAT_PVT is the originating package.