Search Results get_db_version_str




Overview
Explore in AI Chat

Overview

APPS.DOM_DOC_TEXT_UTIL is a utility package in the Oracle E-Business Suite that supports the Oracle Documents (DOM) module, specifically the storage, retrieval, and full-text indexing of document content. The package is classified as a UTIL API, meaning it is not intended as a public business API but rather as an internal helper package invoked by other DOM components. Its source header (DOMUIMTS.pls, version 120.1, dated 2006) indicates it has been part of the DOM schema for many releases and remains documented through EBS 12.1.1 and 12.2.2.

The central business function of this package is to manage document text held in LOB columns and to keep the Oracle Text index synchronized with that content. Because DOM stores uploaded or generated documents as CLOB or VARCHAR2 data, those documents cannot be searched with ordinary SQL predicates. The package bridges that gap by exposing procedures that extract document text for display and that maintain the underlying Oracle Text (interMedia) index. The optimize_index search term that leads users to this object relates directly to one of its documented procedures, OPTIMIZE_INDEX, which drives index maintenance for the DOM document text index.

Key Procedures and Functions

The package declares ten documented procedures and functions, all operating within an AUTHID DEFINER context so that they execute with the privileges of the APPS owner:

  • SET_CONTEXT — Establishes session-level context required by the subsequent document text operations.
  • GET_DOC_TEXT — Retrieves the text of a document identified by ROWID, returning the content into an output CLOB or VARCHAR2 buffer according to a supplied output type.
  • PRINT_LOB — Writes the contents of a CLOB to the output stream for display or debugging.
  • SYNC_INDEX — Synchronizes the Oracle Text index with pending document text changes.
  • SYNC_INDEX_FOR_FORMS — A Forms-oriented variant of index synchronization, used when index maintenance is driven from an EBS form.
  • OPTIMIZE_INDEX — Optimizes the specified Oracle Text index, optionally accepting an index name; a NULL value applies the operation to the default index. This is the procedure associated with the optimize_index search term.
  • GET_PROD_SCHEMA — Returns the product schema name used for index and text operations.
  • GET_DB_VERSION_NUM — Returns the database version as a numeric value.
  • GET_DB_VERSION_STR — Returns the database version as a character string.
  • INSERT_UPDATE_DOC — Inserts or updates document text records maintained by the package.

Tables Accessed

The package references database objects through APPS synonyms. AD_CTX_DDL provides the Oracle Text DDL interface used by SYNC_INDEX, SYNC_INDEX_FOR_FORMS, and OPTIMIZE_INDEX to create, synchronize, and optimize the text index. DBMS_LOB supplies the LOB read and write primitives used by GET_DOC_TEXT and PRINT_LOB. DBMS_UTILITY and V$NLS_PARAMETERS support the version-detection and NLS-dependent helper functions. Because the package is a utility rather than a data-entry API, its direct table access is limited to these infrastructure objects plus the DOM document text tables manipulated by INSERT_UPDATE_DOC.

Usage Notes

DOM_DOC_TEXT_UTIL is normally invoked indirectly. Oracle Forms in the DOM module call GET_DOC_TEXT to render document content and SYNC_INDEX_FOR_FORMS when index synchronization is required during a form session. Concurrent programs and scheduled jobs typically call SYNC_INDEX for batch synchronization and OPTIMIZE_INDEX for routine index maintenance, since Oracle Text indexes require periodic optimization to control fragmentation and preserve search performance. GET_DB_VERSION_NUM and GET_DB_VERSION_STR are used internally to branch behavior across database releases, including the 11g and 12c databases underlying EBS 12.1.1 and 12.2.2. The package is referenced by one other package, confirming its role as a shared helper rather than a standalone interface. Custom code should treat these procedures as internal utilities; direct calls are advisable only when replicating standard DOM index maintenance behavior.