Search Results build_item_text_index

Overview

EGO_ITEM_TEXT_PVT is a private PL/SQL package in the Oracle E-Business Suite (EBS) Applications (APPS) schema, delivered as part of the Oracle Product Information Management (EGO) module. Its central responsibility is the construction and maintenance of the Oracle Text index associated with item descriptive text, which underlies the item search and catalog browsing capabilities exposed through the Item Catalog and related EGO user interfaces. The package is declared with AUTHID CURRENT_USER and carries the source header EGOVIDXS.pls, indicating its origin in the EGO "Item Text Index" utility. Because the package is classified as PVT (private), it is not intended as a public integration API; it provides internal services invoked by other EGO packages and by concurrent processing logic. Two other packages in the EBS codebase reference it, confirming its role as a shared internal utility. The package contains global constants for return codes, status flags, and missing-value sentinels, together with two predefined exceptions used for error propagation.

Key Procedures and Functions

• SET_LOG_MODE — An overloaded utility exposed both as a function and a procedure that controls the verbosity of diagnostic logging emitted by the package during index build runs. It allows callers to enable or suppress logging output.
• LOG_LINE — Writes a diagnostic message buffer to the logging destination established by SET_LOG_MODE. This supports traceability of long-running index operations.
• BUILD_ITEM_TEXT_INDEX — The primary entry point of the package. It accepts an action parameter that directs the index build, and returns an error buffer and numeric return code through OUT NOCOPY parameters for programmatic error handling. This procedure performs the substantive work of creating, synchronizing, or optimizing the Oracle Text index over item text data.
• GET_MSG_TEXT — A function that returns the text of the most recent message generated by the package, enabling callers to retrieve a human-readable status or error description.

Tables Accessed

The package references a focused set of dictionary and Oracle Text tables through APPS synonyms. CTX_DDL, CTX_OUTPUT, and CTX_PARAMETERS are Oracle Text dictionary/utility objects used to create, configure, and report on the text index; AD_CTX_DDL provides the EBS wrapper over the same facility. FND_DESCRIPTIVE_FLEXS and FND_ID_FLEX_STRUCTURES supply descriptive flexfield and key flexfield structure metadata, which is needed to determine which item attributes carry searchable text. ALL_INDEXES and ALL_TABLES are consulted to verify the existence and state of the underlying index and its base table, allowing the build logic to decide between initial creation and incremental maintenance. V$PARAMETER is read to inspect database initialization parameters (for example, those governing Oracle Text behavior), and PLITBLM is used as a temporary PL/SQL index-by table structure. Together these references show that BUILD_ITEM_TEXT_INDEX performs discovery, validation, and DDL execution against the Oracle Text index in a controlled sequence.

Usage Notes

EGO_ITEM_TEXT_PVT is normally invoked indirectly. In a standard EBS deployment the BUILD_ITEM_TEXT_INDEX procedure is driven by a concurrent program in the EGO module responsible for building or rebuilding the item text index; administrators schedule it after significant item master changes, after Oracle Text index corruption, or during implementation of the Item Catalog. Because the package is private, custom code should not call it directly where a supported public API exists. Where direct invocation is unavoidable, callers must declare the OUT NOCOPY error buffer and numeric return code, inspect the return code against the documented constants (success, warning, error), and use GET_MSG_TEXT to obtain diagnostic detail. Logging should be enabled via SET_LOG_MODE when troubleshooting failures, since index build operations against large item populations can be long-running and the log output is the primary means of diagnosis. The action parameter on BUILD_ITEM_TEXT_INDEX governs the specific operation requested, and its permissible values should be confirmed against the deployed release before use.