Results for “edr_indexed_xml_util”

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

Overview

EDR_INDEXED_XML_UTIL is a utility package body in the APPS schema that manages Oracle Text indexing for the EDR (Electronic Document Repository / E-Records) indexed XML framework in Oracle E-Business Suite. Its role is to administer the searchable index built over XML documents stored in the EDR indexed XML element tables, so that users performing XML-based search in EDR can retrieve documents efficiently. The package abstracts the underlying Oracle Text (CTXSYS) index management APIs and the EDR metadata tables behind a small set of stable, callable operations, allowing other EDR components and customer extensions to create, synchronize, optimize, and configure XML indexes through standard EBS utilities rather than raw DDL.

In both release 12.1.1 and 12.2.2 the object is documented as VALID and is classified in ETRM as a UTIL (utility) API. It is referenced by nine other database objects, indicating that it is a foundational building block consumed across the EDR indexing stack rather than an entry point invoked directly by end users.

Key Procedures and Functions

• CREATE_INDEX — Creates the Oracle Text index (or associated index objects) required to make EDR indexed XML content searchable. It encapsulates the index definition and preference setup so that the correct columns, preferences, and parameters are applied consistently for the EDR XML structures.
• SYNCHRONIZE_INDEX — Synchronizes pending index changes with the base tables. Oracle Text indexes are maintained asynchronously, and this procedure flushes outstanding DML into the index so that newly inserted or changed XML elements become searchable.
• OPTIMIZE_INDEX — Runs index optimization to reclaim fragmented index space and improve query performance. This is typically executed periodically as a maintenance activity rather than on every transaction.
• GET_WF_PARAMS — Retrieves parameters used in the Workflow-enabled (WF) invocation path, allowing index operations to be driven from workflow or concurrent request contexts rather than solely by direct PL/SQL calls.

No public parameter lists are exposed in the ETRM metadata; the procedures should be treated as internal utility entry points and referenced only where the EDR framework itself does so.

Tables Accessed

• EDR_IDX_XML_ELEMENT_B — The base table holding the indexed XML element definitions. It maps indexed elements to the Oracle Text datastore and is the primary structure against which indexing metadata is created and maintained.
• EDR_IDX_XML_ELEMENT_VL — The translation (VL) view over the element table, resolving language-specific display values for XML element definitions used during index setup and maintenance.
• CTX_DDL — The Oracle Text DDL package. Calls into CTX_DDL from within this package body carry out index creation, preference management, and optimization routines.
• DBA_TABLES — Used for existence and structural checks before creating or synchronizing index objects, ensuring operations are idempotent and safe against missing or already-defined objects.

Additional supporting dependencies include FND_DATE, FND_TIMEZONES, FND_MESSAGE, FND_FILE, and FND_PROFILE, which provide date/time formatting, message handling, log output, and profile option retrieval, confirming the package is designed as a logged, message-producing EBS utility.

Usage Notes

EDR_INDEXED_XML_UTIL is not referenced by any database object per the dependency metadata, and there is no documented public API classification beyond UTIL. It is therefore intended for internal use by the EDR indexing framework and by workflow-driven processes: GET_WF_PARAMS exists specifically to support invocation from Workflow/Concurrent Program contexts. Typical invocations include initial setup of the XML search index for EDR, scheduled or event-driven synchronization of index contents, periodic optimization to maintain search performance, and any custom or extension code that must manage the same index in a supported manner.

Because the index lifecycle is asynchronous, administrators should expect CREATE_INDEX to be a one-time or configuration-change activity, SYNCHRONIZE_INDEX to run regularly to expose new documents to search, and OPTIMIZE_INDEX to run during maintenance windows. Direct ad hoc calls to underlying CTX_DDL procedures should be avoided in favor of this package so that EDR element metadata remains consistent with the physical index.