Search Results eam_text_index_pvt




Overview
Explore in AI Chat

Overview

APPS.EAM_TEXT_INDEX_PVT is a private PL/SQL package in the Oracle E-Business Suite Enterprise Asset Management (EAM) module. It belongs to the PVT (private) API classification, meaning it is an internal implementation package not intended for direct invocation by external or customer-written code. Its principal business function is the construction and maintenance of Oracle Text indexes over EAM descriptive and attribute data, enabling full-text search across asset definitions, asset descriptions, and related maintenance objects. The package acts as a thin coordination layer between EAM application logic and the Oracle Text (interMedia) infrastructure, driving the CTX DDL and output utilities that physically create, populate, and optimize text indexes.

Because the package is classified as private, its procedures support higher-level EAM flows — such as asset definition setup, asset number and description searches, and concurrent index maintenance — rather than exposing a supported public interface. The package remains VALID and depends on AD_CTX_DDL and STANDARD in the SYS/APPS namespaces.

Key Procedures and Functions

  • BUILD_TEXT_INDEX — The core routine responsible for creating or rebuilding the Oracle Text index associated with EAM text-searchable columns. It orchestrates the underlying CTX_DDL calls that define preferences, sections, and index parameters, then initiates index population. This procedure is the primary entry point for (re)generating the text index after schema or data changes.
  • OPTIMIZE_INDEX — Performs index optimization against an existing Oracle Text index. Optimization consolidates fragmented index data, reclaims space, and improves query performance. It is typically scheduled or triggered after bulk data loads, purges, or significant asset record creation.
  • SET_LOG_MODE — Controls the logging behavior of the package. It allows the caller to enable, disable, or adjust the verbosity of diagnostic output during index build and optimization operations, which is useful for troubleshooting long-running index jobs.
  • LOG_LINE — Writes a single diagnostic message to the package's log output. It is the internal logging primitive used by the other procedures to record progress, errors, and status messages. Its behavior depends on the mode established by SET_LOG_MODE.

The ETRM metadata documents five procedures/functions in total; the described routines represent the documented functional surface of the package.

Tables Accessed

  • AD_CTX_DDL — The Oracle Text DDL package used to create and configure index preferences and index definitions. Central to BUILD_TEXT_INDEX.
  • CTX_OUTPUT — Oracle Text output/logging package; used to emit progress and error messages during index operations.
  • CTX_PARAMETERS — Provides Oracle Text configuration parameters consulted when building or optimizing an index.
  • ALL_INDEXES — Data dictionary view queried to determine whether the target text index already exists and to retrieve its attributes.
  • ALL_TABLES — Data dictionary view used to confirm the existence and ownership of the base table being indexed.
  • V$PARAMETER — Instance parameter view used to check database-level settings that influence Oracle Text behavior.

These references confirm the package's role as an Oracle Text provisioning and maintenance utility; it reads dictionary and configuration metadata and issues DDL through the CTX APIs rather than manipulating EAM business tables directly.

Usage Notes

Because EAM_TEXT_INDEX_PVT is a PVT package, it is not part of Oracle's public, supported API surface and is referenced by zero other packages per the documented dependency data. Invocation therefore occurs only from within Oracle's own EAM implementation code, such as EAM setup or index-maintenance concurrent programs that require creation, population, or optimization of Oracle Text indexes. Custom code and extensions should avoid calling this package directly, since signatures and behavior may change without notice across patch levels or between EBS 12.1.1 and 12.2.2.

Administrators encountering text-index issues in EAM should rely on Oracle-supported concurrent programs (for example, index build or optimization requests surfaced through the EAM responsibility) rather than direct calls. When the package is executed, SET_LOG_MODE and LOG_LINE provide diagnostic visibility, and appropriate database privileges on CTX_DDL, CTX_OUTPUT, and the Oracle Text dictionary views are required. Because dependencies include SYS-owned objects such as AD_CTX_DDL, the package must be executed in a context where APPS has the necessary synonym and privilege grants. Changes to Oracle Text parameters in V$PARAMETER can affect BUILD_TEXT_INDEX and OPTIMIZE_INDEX outcomes, so these should be reviewed before large index rebuilds.