Search Results sync_element_index




Overview

The APPS.CS_KB_CTX_INDEX_CONC_PKG package body is a concurrent-program support package within the Oracle E-Business Suite Service (CS) module. It belongs to the knowledge base (KB) schema objects and is classified under the generic API classification OTHER, indicating it is not an exposed business API but an internal utility invoked by concurrent processing. Its primary purpose is to synchronize Oracle Text indexes (or "SYNC" context indexes) associated with knowledge base translation tables in the CS schema.

The header comment ($Header: csksynib.pls 115.0 2000/02/29 ...) indicates the package originated as a standalone PL/SQL script that was later deployed as a concurrent program unit. The name itself, CS_KB_CTX_INDEX_CONC_PKG, combines "CS" (Service), "KB" (knowledge base), "CTX" (Oracle Text/Context), "INDEX", and "CONC" (concurrent), precisely describing its role: rebuilding text indexes for knowledge base entities through a concurrent request. The user search term sync_element_index maps directly to SYNC_ELEMENT_INDEX, one of the chief procedures within the package that drives this synchronization.

Key Procedures and Functions

The package body exposes five documented procedures:

  • SYNC_ALL_INDEX — The top-level driver procedure. It sequentially calls SYNC_ELEMENT_INDEX, SYNC_SET_INDEX, and SYNC_FORUM_INDEX, and then sets the return code to zero on success. It accepts the standard concurrent program ERRBUF and RETCODE out parameters.
  • SYNC_ELEMENT_INDEX — Rebuilds the Oracle Text indexes CS.CS_KB_ELEMENTS_TL_N1 and CS.CS_KB_ELEMENTS_TL_N2 using the ALTER INDEX ... REBUILD parameters ('SYNC') syntax. On failure, it drops both indexes and re-raises the exception.
  • SYNC_SET_INDEX — Rebuilds the text indexes CS.CS_KB_SETS_TL_N1, CS.CS_KB_SETS_TL_N2, and CS.CS_KB_SETS_TL_N3, applying the same error-handling pattern of dropping indexes and re-raising on failure.
  • SYNC_FORUM_INDEX — Rebuilds the text index associated with CS.CS_FORUM_MESSAGES_TL, continuing the same iterative rebuild-dispose pattern.
  • CS_KB_DEL_CONC_PROG — A supporting concurrent program routine, documented in the ETRM metadata, that handles deletion-related processing for knowledge base concurrent operations.

No parameter lists must be inferred for the latter procedures beyond what the metadata documents; the rebuild procedures consistently accept the concurrent-program out parameters on the top-level call.

Tables Accessed

The package operates indirectly on the knowledge base translation tables through their Oracle Text indexes. The vetted tables referenced are:

  • CS.CS_KB_ELEMENTS_TL — the translated elements table for knowledge base articles; indexed by N1 and N2.
  • CS.CS_KB_SETS_TL — the translated knowledge base sets table; indexed by N1, N2, and N3.
  • CS.CS_FORUM_MESSAGES_TL — the translated forum messages table used as the forum content source.

The package does not perform conventional DML against these tables; its interaction is through DDL index rebuild operations executed via EXECUTE IMMEDIATE. The _TL suffix consistently denotes translatable entities, which is why each table carries multiple language-specific text indexes requiring periodic synchronization.

Usage Notes

This package is designed to run as a concurrent program. It is most commonly scheduled or submitted from the Service responsibilities when knowledge base text search behavior degrades or after bulk content loads, so that Oracle Text indexes reflect current data. Because SYNC_ALL_INDEX wraps three sub-procedures, a single concurrent request performs a complete index synchronization across elements, sets, and forum messages.

Operational caution is warranted: the exception handler deliberately drops the affected indexes if the rebuild fails, then re-raises the error. This means index availability is at risk until the program is rerun successfully, and Oracle Text index rebuilding should be scheduled during low-activity windows. The package is referenced by zero other PL/SQL packages, confirming it is invoked exclusively as a concurrent program entry point rather than as a callable API. Administrators monitoring the concurrent manager should watch for RETCODE = 2 errors, which signal index rebuild failures. The absence of any documented public API classification reinforces that this is an internal maintenance utility, not an integration interface.