Search Results request_sync_set_index

Overview

CS_KB_SYNC_INDEX_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the Oracle Knowledge Base (Knowledge Management) module within the Service (CS) application family. Its principal business function is to maintain the integrity and freshness of the Knowledge Base search index. When solutions, solution sets, categories, or their associated attributes change, the searchable index must be synchronized so that end users retrieve accurate results. The package coordinates incremental and full re-indexing by marking affected index entries as stale and by submitting concurrent requests that perform the actual search-engine synchronization. It also manages content caches used when rendering or searching solution content, including attachments.

The package is a foundational internal utility: ETRM records it as referenced by six other packages, including CS_KB_SOLUTION_PVT, CS_KB_SECURITY_PVT, CS_KB_SOLN_CATEGORIES_PVT, CS_KB_CONC_PROG_PKG, CS_KB_ELEMENTS_AUDIT_PKG, and CS_KNOWLEDGE_AUDIT_PVT, as well as by itself. This dependency pattern confirms that index synchronization is triggered from solution maintenance, security/visibility changes, category maintenance, and audit operations.

Key Procedures and Functions

Eighteen documented procedures and functions are recorded. They fall into three functional groups.

• Index request procedures: REQUEST_SYNC_KM_INDEXES, REQUEST_SYNC_SET_INDEX, and REQUEST_SYNC_ELEMENT_INDEX submit index synchronization work for solutions, solution sets, and elements respectively.
• Marking procedures: MARK_IDXS_ON_PUB_SOLN and MARK_IDXS_ON_OBS_SOLN mark index entries when solutions are published or obsoleted; MARK_IDXS_ON_GLOBAL_STMT_UPD handles global statement updates; MARK_IDXS_FOR_MULTI_SOLN marks multiple solutions in a single operation; REQUEST_MARK_IDX_ON_SEC_CHANGE marks indexes when security changes occur.
• Visibility and category marking: MARK_IDX_ON_ADD_VIS, MARK_IDX_ON_REM_VIS, and MARK_IDX_ON_CHANGE_CAT_VIS address visibility changes; MARK_IDX_ON_ADD_CAT_TO_CAT_GRP, MARK_IDX_ON_REM_CAT_FR_CAT_GRP, and MARK_IDX_ON_CHANGE_PARENT_CAT address category group and hierarchy changes.
• Content caching: POPULATE_SOLN_CONTENT_CACHE and POP_SOLN_ATTACH_CONTENT_CACHE build cached representations of solution content and attachment content for indexing or display.

The package additionally references the JTF_NUMBER_TABLE collection type, used to pass sets of numeric identifiers to these operations.

Tables Accessed

The package reads and writes Knowledge Base entities through APPS synonyms. CS_KB_SOLN_CATEGORIES_B holds solution-to-category assignments, which determine which index entries must be invalidated when category membership changes. CS_KB_SETS_B and CS_KB_SETS_TL store solution set definitions and translations, while CS_KB_SET_CATEGORIES, CS_KB_SET_ELES, and CS_KB_ELEMENTS_B/TL store set-category relationships, set elements, and element definitions with translations. CS_KB_VISIBILITIES_B stores visibility rules that govern which users can see which solutions, and therefore which index entries require marking when security changes. FND_APPLICATION, FND_CONCURRENT_PROGRAMS, FND_CONCURRENT_REQUESTS, and FND_LANGUAGES support submission of concurrent index synchronization programs and language-specific processing. DBMS_LOB, DBMS_UTILITY, and PLITBLM provide LOB handling, utility routines, and PL/SQL table manipulation used during cache population.

Usage Notes

CS_KB_SYNC_INDEX_PKG is an internal package and is not intended as a public API for custom development. It is invoked indirectly when users create, update, publish, obsolete, or reclassify solutions and categories through the Oracle Knowledge Base forms, and when visibility or security attributes are modified. Its REQUEST_SYNC_* procedures submit concurrent requests (typically Oracle Knowledge Base index synchronization concurrent programs) recorded in FND_CONCURRENT_REQUESTS. Administrators may also schedule full index synchronization manually through the standard concurrent program interface. Because the marking procedures are called from numerous dependent packages across 12.1.1 and 12.2.2, direct invocation from custom code is discouraged; customizations should instead rely on the documented Knowledge Base public APIs such as CS_KB_SOLUTION_PVT, which in turn call this package to keep the index synchronized.