Search Results get_msg_text

Overview

ENG_CHANGE_TEXT_PVT is a private PL/SQL package owned by the APPS schema in Oracle E-Business Suite, residing in the Oracle Engineering (ENG) product family. Its primary business function is to build and maintain the Oracle Text index that supports full-text searching of engineering change order (ECO) descriptive text and related documentation. In ETRM terminology a package classified as "PVT" denotes a private, internal implementation unit — it is not part of the published, supported API surface and is intended to be called only by other EBS modules rather than by external integrations. The header identifies the underlying source file as ENGVIDXS.pls (version 120.0, dated 2005/05/26), confirming that this object has remained stable across the 12.1.1 and 12.2.2 releases. The package encapsulates the logic required to synchronize engineering change text with an Oracle Text (interMedia) index so that users can locate changes using word-based or phonetic queries.

Key Procedures and Functions

• SET_LOG_MODE — Overloaded as both a function and a procedure. It controls the diagnostic logging level used by the package, enabling or disabling trace output during index construction. The dual signature allows callers to either set the mode for its side effect or retrieve the resulting mode value.
• LOG_LINE — A utility procedure that writes a caller-supplied buffer to the package log. It is invoked internally to record progress and errors during indexing operations.
• BUILD_CHANGE_TEXT_INDEX — The principal worker procedure. It drives the creation, population, or refresh of the Oracle Text index over engineering change text. It accepts a runtime action parameter (p_Action) and returns standard concurrent-program output parameters (ERRBUF and RETCODE) following the EBS concurrent manager convention. This is the only substantive business routine exposed within the package body.
• GET_MSG_TEXT — A function returning the most recent message text produced by the package, allowing callers to surface a meaningful status or error string.

The specification also declares a set of standard package-level constants (G_RETCODE_SUCCESS, G_RETCODE_WARNING, G_RETCODE_ERROR, G_STATUS_SUCCESS, G_STATUS_WARNING, G_STATUS_ERROR, G_STATUS_UNEXP_ERROR), missing-value placeholders (G_MISS_NUM, G_MISS_CHAR, G_MISS_DATE), and two predefined exceptions (G_EXC_ERROR, G_EXC_UNEXPECTED_ERROR). These follow the conventional EBS private-package template.

Tables Accessed

• CTX_OUTPUT, CTX_PARAMETERS — Oracle Text runtime views used to emit index-build feedback and to read indexing configuration settings.
• AD_CTX_DDL — The Oracle Text DDL repository used to execute index creation and modification statements.
• ALL_INDEXES, ALL_TABLES — Data dictionary views consulted to verify the existence, name, and status of the target index and its base table before building.
• PLITBLM — An Oracle Text system table holding the index metadata and preference information.
• V$PARAMETER — The dynamic performance view read to confirm database initialization parameters that affect Oracle Text indexing.

Usage Notes

ENG_CHANGE_TEXT_PVT is invoked internally by the Oracle Engineering application rather than called directly by end users. It is referenced by exactly one other package per the ETRM metadata, meaning its public entry points are wrapped by a higher-level engineering routine. In practice the index-build procedure is most commonly launched in the context of a concurrent program, since the ERRBUF/RETCODE output signature matches the standard concurrent-manager interface. Site administrators responsible for maintaining engineering change search performance may schedule index rebuilds during low-activity windows. Because the package is classified PVT and is not documented as a supported API, customizations should avoid invoking it directly; any requirement to rebuild or tune engineering change text indexing should instead be routed through the supported Oracle Engineering menu functions or the concurrent program that wraps it. The presence of CTX_* and Oracle Text dictionary references indicates a hard dependency on Oracle Text being installed and configured in the database.