Results for “optimize_index”

50+ results




Overview
Explore in AI Chat

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

EDR_INDEXED_XML_UTIL is a utility PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified as a UTIL API within the ETRM (E-Business Suite Technical Reference Manual) repository. Its primary business function is the administration and optimization of Oracle Text indexes used to search indexed XML content stored by the EDR (Electronic Document Repository / XML document indexing) subsystem. The package encapsulates DDL-level operations performed against the Oracle Text (CTXSYS) index infrastructure, exposing them through callable PL/SQL interfaces suitable for concurrent program registration.

The package header carries the revision marker EDRGIXES.pls 120.0.12000000.1, indicating it was shipped as part of the standard EBS file system in January 2007 (2007/01/18) by user appldev. The presence of bug references (bug 2979172) within the header comments confirms the package was introduced or revised specifically to support synchronization and optimization of the index through concurrent programs, replacing earlier ad-hoc invocation patterns.

Key Procedures and Functions

  • CREATE_INDEX — A procedure that creates the Oracle Text index required by the EDR indexed-XML search feature. It returns standard concurrent-program out parameters (ERRBUF and RETCODE) so that it can be registered and run as a concurrent executable and report success or failure back to the concurrent manager.
  • SYNCHRONIZE_INDEX — A procedure added per bug 2979172 to synchronize the Oracle Text index with pending DML changes. It also exposes ERRBUF and RETCODE out parameters, allowing it to be driven from a concurrent program and to report its outcome.
  • OPTIMIZE_INDEX — A procedure that optimizes the Oracle Text index. In addition to the standard ERRBUF/RETCODE output parameters, it accepts an optimization level and a duration, permitting the caller to control how aggressively and for how long the optimization runs. The header comment explicitly notes removal of the parameter name in a prior signature so that the value set could be defined.
  • GET_WF_PARAMS — A function that returns a VARCHAR2 value given a parameter name (p_param_name) and an event GUID (p_event_guid), used to retrieve workflow-related parameters associated with an indexed XML document event. This is the object targeted by the search term get_wf_params and serves to bridge Oracle Workflow event context with the EDR indexed-XML structures.

Tables Accessed

The package operates against a small set of documented objects, accessed through APPS synonyms:

  • CTX_DDL — The Oracle Text (CTXSYS) procedural package supplying the index administration primitives (create, sync, optimize) that EDR_INDEXED_XML_UTIL wraps.
  • EDR_IDX_XML_ELEMENT_B — The base EDR table holding indexed XML element definitions; the indexed content this package maintains is derived from this table.
  • DBA_TABLES — The dictionary view consulted to validate the existence or state of underlying tables before index operations are attempted.

Usage Notes

EDR_INDEXED_XML_UTIL is intended to be invoked from concurrent programs rather than from Forms-based UI. The ERRBUF and RETCODE out parameters on CREATE_INDEX, SYNCHRONIZE_INDEX, and OPTIMIZE_INDEX follow the standard concurrent program calling convention, and the header explicitly states that the synchronization and optimization procedures were reworked so they could be used in a concurrent program. Administrators therefore schedule these procedures via the Concurrent Programs and Request Set frameworks to periodically build, synchronize, and optimize the Oracle Text index underlying EDR indexed-XML search.

GET_WF_PARAMS, by contrast, is a lookup function likely called by Oracle Workflow function activities or by custom PL/SQL code that needs to resolve workflow parameters against a specific EDR event GUID. The package is referenced by nine other packages, so customizations should avoid modifying its specification, and any extension should use the documented signatures exactly as shipped in release 12.1.1 / 12.2.2.