Search Results okc_article_keyword_pvt




Overview
Explore in AI Chat

Overview

The APPS.OKC_ARTICLE_KEYWORD_PVT package is a private (PVT) PL/SQL package within the Oracle E-Business Suite Contracts (OKC) module, responsible for managing the keyword and contextual search infrastructure associated with contract articles. In Oracle EBS 12.1.1 and 12.2.2, contracts authored through the Contracts Core module generate article text that must be indexed for full-text retrieval. This package coordinates that indexing lifecycle by leveraging Oracle Text (the CTXSYS schema and its CTX_* dictionary views), synchronizing and optimizing the underlying Oracle Text indexes that back article keyword searches.

The package declares AUTHID CURRENT_USER, meaning its procedures execute with the privileges of the invoking user rather than the definer, which is consistent with its role as a DDL/DML orchestration utility invoked from concurrent programs. Its presence in the APPS schema and its PVT API classification indicate that it is not intended as a public integration surface but rather as an internal support package. The ETRM metadata confirms it is referenced by zero other packages, reinforcing its role as a leaf-level utility invoked directly by concurrent program definitions or forms rather than being called from other PL/SQL units.

Key Procedures and Functions

  • SYNC — Synchronizes the article keyword index structure, ensuring the Oracle Text index reflects the current state of article data. This is the core indexing entry point.
  • OPTIMIZE — Performs index optimization, a maintenance operation that consolidates the Oracle Text index to improve query performance and reclaim fragmentation.
  • ARTICLE_TITLE — A function returning a VARCHAR2 value, given an article version identifier. It resolves and returns the human-readable title associated with a specific article version.
  • SYNC_CTX — A concurrent-program-style wrapper around SYNC, accepting standard errbuf and retcode OUT parameters for submission from the Concurrent Manager.
  • OPTIMIZE_CTX — The concurrent-program-style wrapper around OPTIMIZE, likewise exposing errbuf and retcode. This is the procedure most directly associated with the "optimize_ctx" search term.
  • CREATE_CTX — Creates the Oracle Text index and related context objects, accepting an optional index parallel-degree parameter for controlling the degree of parallelism during index build.
  • CRT — A short-form helper, likely complementing CREATE_CTX for context creation or initialization.

Tables Accessed

The package references several tables via APPS synonyms. OKC_ARTICLES_ALL and OKC_ARTICLE_VERSIONS supply the article and version data that is indexed. CTX_OBJECTS and CTX_PARAMETERS are Oracle Text dictionary views used to inspect and validate the index configuration. AD_CTX_DDL supports the DDL operations required to create or alter the text index. Concurrent program metadata is read from FND_CONCURRENT_PROGRAMS and FND_CONCURRENT_REQUESTS, and DBMS_APPLICATION_INFO provides session-level instrumentation. The V$INSTANCE and V$PARAMETER views are consulted to detect instance configuration—likely to verify that Oracle Text is enabled or to determine parameter-driven behavior. These accesses confirm the package's role as a bridge between the Contracts data model and the Oracle Text subsystem.

Usage Notes

Because the package is classified PVT and referenced by no other packages, it is typically invoked through concurrent programs registered in the Contracts module—most notably an index optimization program mapping to OPTIMIZE_CTX and an index synchronization program mapping to SYNC_CTX. Administrators seeking to "optimize_ctx" within an EBS environment would schedule the corresponding concurrent program, which in turn calls OPTIMIZE_CTX. The errbuf/retcode signatures on SYNC_CTX, OPTIMIZE_CTX, and CREATE_CTX confirm Concurrent Manager compatibility. Direct invocation from custom code is discouraged given the PVT classification, though DBAs may call these procedures manually during index rebuild or troubleshooting. Regular optimization is advisable to maintain article search responsiveness as contract volume grows.