Search Results okc_ca_util_pvt




Overview
Explore in AI Chat

Overview

OKC_CA_UTIL_PVT is a private (PVT) PL/SQL utility package in the Oracle Contracts (OKC) application, owned by APPS and declared with AUTHID CURRENT_USER. In Oracle EBS 12.1.1 and 12.2.2, it supports the Contract Authoring (CA) search and article-assembly infrastructure used by the Contracts Core and related modules. The package provides the low-level plumbing behind article search results: it inserts candidate articles into a search staging area, removes results from that staging area, and resolves article, version, organization, and document-type attributes for display on contract authoring forms. It also exposes lookup helpers that translate internal foreign keys into human-readable values, such as document type names, negotiation supplier party names, and order/blanket transaction subtype names.

Key Procedures and Functions

The package contains two procedures and twelve functions, all documented in the ETRM metadata.

  • INCLUDE_ARTICLES — Populates a search result set for a given search identifier, applying filters for alternates, adoptions, all versions, and non-standard articles.
  • REMOVE_RESULTS — The procedure most directly matching the user's search term "remove_results." It clears the staged search results associated with a search identifier, typically to reset the working set before a new query is run.
  • REMOVE_INCLUDED — Removes only those results that were explicitly included, preserving the surrounding result set.
  • ARTICLE_TITLE — Returns the title of an article version.
  • DISPLAY_NAME — Returns a display name derived from the article title for UI presentation.
  • ARTICLE_VERSION_NUMBER — Returns the version number for a supplied article version identifier.
  • ARTICLE_ID — Derives the parent article identifier from an article version identifier.
  • ORG_ID — Returns the operating unit (organization) identifier associated with an article version.
  • LATEST_ARTICLE_VERSION_ID — Resolves the most recent article version for a given article and organization.
  • DOC_TYPE — Translates a business document type code into its translated name.
  • NEG_SUPPLIER — Returns the supplier party name for a negotiation.
  • BSA_SUBTYPE and SO_SUBTYPE — Return the transaction type names for blanket sales agreements and sales orders, respectively.
  • ARTICLE_NUMBER — Returns the article number for a supplied article identifier.

Tables Accessed

The package works across OKC, OE, PO, and HZ synonyms. OKC_ARTICLES_ALL, OKC_ARTICLE_VERSIONS, OKC_ARTICLE_ADOPTIONS, and OKC_ARTICLE_RELATNS_ALL hold article master, version, adoption, and relationship data used by the search and include logic. The global temporary tables OKC_CA_ART_VERSIONS_GT and OKC_CA_DOCUMENTS_GT hold transient search results manipulated by INCLUDE_ARTICLES, REMOVE_RESULTS, and REMOVE_INCLUDED. OKC_BUS_DOC_TYPES_TL supplies translated document type names for DOC_TYPE. OE_TRANSACTION_TYPES_ALL and OE_TRANSACTION_TYPES_TL, together with OE_BLANKET_HEADERS_ALL and OE_ORDER_HEADERS_ALL, support BSA_SUBTYPE and SO_SUBTYPE lookups. PON_BID_HEADERS supports negotiation context, HZ_PARTIES provides supplier party names, and HR_ORGANIZATION_INFORMATION resolves organization details for ORG_ID.

Usage Notes

Because the package is classified PVT and reference metadata shows it is referenced by zero other packages, it is an internal implementation helper rather than a public integration API. It is most commonly invoked indirectly from Contract Authoring forms and the Contracts repository search behavior, where REMOVE_RESULTS is called to purge a prior search result set before re-running a query. Custom extensions that manipulate article search results should call the package cautiously, since it is unsupported for external use. Authorizations rely on AUTHID CURRENT_USER, so invocation is subject to the calling user's privileges on the underlying OKC, OE, PO, and HZ objects. No formal parameter lists beyond those documented should be assumed.