Search Results stop_optimize

Overview

The CTXSYS.CTX_ADM package is the administrative interface for Oracle Text (formerly Oracle interMedia Text) within an Oracle E-Business Suite 12.1.1 or 12.2.2 database. Although it is owned by the CTXSYS schema rather than by APPS, it is a foundational component that EBS relies upon whenever text indexes, text preferences, or text-based search functionality are used by applications such as Oracle iStore, Oracle Knowledge Management, Oracle Advanced Product Catalog, and various document-management and attachment features. The package exposes a small set of procedures that control the lifecycle of the Oracle Text data dictionary, adjust system-level Text parameters, and clean up the Text objects that belong to a given schema. Because EBS stores large volumes of unstructured content — attachments, knowledge articles, catalog descriptions, and notes — the CTX_ADM procedures are effectively the maintenance and recovery toolkit for the underlying Text infrastructure that supports searching and indexing of that content.

Key Procedures and Functions

• SHUTDOWN — Documented as obsolete. It is retained only to prevent invalidation of older customer code that may still reference it, and it performs no meaningful administration on current releases.
• RECOVER — Recovers the Oracle Text data dictionary. This is the primary corrective procedure when the Text dictionary has become inconsistent or damaged.
• SET_PARAMETER — Sets a system-level Oracle Text parameter, taking a parameter name and value. It is the supported mechanism for adjusting Text defaults at the database level rather than per index.
• TEST_EXTPROC — Tests invocation of the external procedure (extproc) agent. A successful execution confirms that extproc can be called, which is essential for features such as user-defined indexing and file-based data sources.
• MARK_FAILED — Marks a text index whose status is INPROGRESS as FAILURE, allowing a subsequent ALTER INDEX to run. It is documented as unpublished, indicating it is intended for internal or support-driven use.
• DROP_USER_OBJECTS — Drops all Oracle Text objects (preferences and related objects) belonging to the specified user. It is invoked during a database DROP USER operation, and it raises no errors if the user or objects do not exist.
• RESET_AUTO_OPTIMIZE_STATUS — Resets the automatic optimization status tracked for Text indexes, used to re-baseline optimization processing.
• STOP_OPTIMIZE — Halts an in-progress optimization of a Text index.

Tables Accessed

The ETRM metadata records only DUAL as a referenced table, which is consistent with administrative and control-flow procedures of this type — they primarily manipulate package state, system parameters, and the Oracle Text dictionary rather than querying application data directly. The substantive work of CTX_ADM is performed against the internal CTXSYS dictionary structures rather than against EBS application tables, and the EBS-facing references are reached through APPS synonyms where applicable.

Usage Notes

CTX_ADM is not normally invoked from an EBS form or concurrent program directly. In the EBS 12.1.1 and 12.2.2 context it is most often called from SQL*Plus or another DBA session during Oracle Text troubleshooting and maintenance: recovering a corrupted Text dictionary, tuning Text system parameters, verifying extproc availability, or clearing a stuck index so that a rebuild can proceed. The DROP_USER_OBJECTS procedure is invoked implicitly by the database during user removal. Custom code in EBS should treat these procedures as privileged DBA operations and restrict execution to the CTXSYS or a suitably authorized schema. The package is referenced by three other packages within the documented dependency set, so changes to it can have a related impact on dependent Text administrative routines; always validate such dependencies before modification.