Results for “build_doc_text_index”
8 results
AI-generated from documented ETRM metadata — verify critical details on the linked pages.
Overview
APPS.DOM_DOC_TEXT_PVT is a private (PVT classification) PL/SQL package within the Oracle E-Business Suite DOM (Document Management) module. It provides the internal text-handling infrastructure used by the Document Management family of packages, most notably the public-facing DOM_DOC_TEXT_UTIL package. The package encapsulates the low-level plumbing required to build, index, and retrieve textual content associated with documents managed by Oracle EBS, along with diagnostic logging utilities that support troubleshooting of those operations.
As a private package, DOM_DOC_TEXT_PVT is not intended to be invoked directly by customer extensions or by standard EBS forms and concurrent programs. It is a supporting library called from within the DOM_DOC_TEXT_UTIL layer and, according to the ETRM dependency metadata, from itself. The package body is documented as VALID in the APPS schema, and its only external schema-level dependency is on SYS-owned objects (STANDARD) and on the V$PARAMETER dynamic performance view via an APPS synonym.
Key Procedures and Functions
The ETRM metadata documents five procedures and functions within this package:
- SET_LOG_MODE — Establishes the logging behavior for the package. It governs whether diagnostic output is captured during document text operations, allowing callers to enable or suppress log generation as appropriate for the environment.
- LOG_LINE — Writes an individual diagnostic message to the package's logging mechanism. It works in conjunction with SET_LOG_MODE and is used throughout the package and by DOM_DOC_TEXT_UTIL to record processing milestones and errors.
- BUILD_DOC_TEXT_INDEX — The core functional routine. It constructs the text index for a document, assembling and indexing the textual content so that it can be searched and retrieved efficiently by the Document Management application.
- GET_MSG_TEXT — Retrieves the message text associated with a given condition or error, providing a centralized mechanism for resolving message strings used in exception handling and user-facing diagnostics.
No public call specifications are documented in the ETRM extract; the procedures are consumed internally by the DOM_DOC_TEXT_UTIL package.
Tables Accessed
The documented table reference for this package is limited to V$PARAMETER, accessed through an APPS synonym. This dynamic performance view exposes database initialization parameters. In this context it is most plausibly read to determine database-level settings (for example, character set, NLS configuration, or text-related initialization parameters) that influence how document text is indexed and stored. The ETRM metadata does not document any application tables such as FND_DOCUMENTS or FND_LOBS being referenced directly by this private layer; document-text persistence is handled at the DOM_DOC_TEXT_UTIL layer or through other DOM packages.
Usage Notes
Because DOM_DOC_TEXT_PVT is classified as a private package, Oracle does not support direct invocation from custom code, and its specification may change without notice between releases. In practice it is reached only through DOM_DOC_TEXT_UTIL, which is itself referenced by ETRM-documented objects. Standard EBS forms and concurrent programs that manage documents cause the DOM text routines to execute indirectly.
It is important to note that this documentation reflects the ETRM 12.2.2 metadata. Behavior in 12.1.1 is expected to be functionally similar, but the 12.1.1 package body may differ in implementation details. Developers requiring document text functionality should target DOM_DOC_TEXT_UTIL rather than this private package, and any diagnostic logging performed through SET_LOG_MODE and LOG_LINE should be treated as internal-only behavior subject to change.