Search Results gms_error_pkg




Overview
Explore in AI Chat

Overview

GMS_ERROR_PKG is a shared utility package in the APPS schema that provides centralized error handling, message resolution, and diagnostic logging for the Oracle E-Business Suite Grants Management (GMS) module. In Oracle EBS 12.1.1 and 12.2.2, the package body implements the logic behind a specification that standardizes how GMS application code raises, formats, and reports errors to end users and to the concurrent manager log. Rather than allowing individual GMS programs to construct ad hoc error text, the package funnels messages through Oracle Application Object Library (AOL) infrastructure — FND_MESSAGE, FND_MSG_PUB, and FND_LOG — so that errors are translatable, consistently formatted, and captured in the standard EBS logging framework. The object is documented with a status of VALID and is classified under the ETRM API classification OTHER, indicating it is an internal support package rather than a public integration API. Its dependencies on FND_FILE, FND_GLOBAL, FND_PROFILE, and GMS_LOOKUPS confirm its role as a cross-cutting services layer used by Grants Management programs for output, context resolution, and lookup-driven message assembly.

Key Procedures and Functions

The package body documents six procedures and functions:

  • GMS_MESSAGE — Resolves and emits a GMS error or informational message, typically using the AOL message dictionary so that the text can be translated and presented through standard EBS message handling.
  • GMS_DEBUG — Writes diagnostic output when debug mode is enabled, allowing developers and support analysts to trace package execution without altering production message behavior.
  • GMS_EXCEPTION_HEAD_PROC — Emits the header portion of an exception report or log entry, establishing the context (program, request, and error identifier) before detail lines are written.
  • GMS_EXCEPTION_LINES_PROC — Emits the detail lines associated with an exception, complementing the header procedure to produce a complete, readable error block.
  • GMS_OUTPUT — Provides a controlled output routine for writing text to the concurrent program output file via FND_FILE, used for report and log formatting.
  • SET_DEBUG_CONTEXT — Initializes or updates the debug context (for example, from a profile option read through FND_PROFILE) so that subsequent calls to GMS_DEBUG behave consistently within a session.

No parameter lists are exposed in the documented metadata; the descriptions above reflect the functional role of each routine as named.

Tables Accessed

The ETRM metadata for this package body lists no direct table references through APPS synonyms. Instead, it depends on the GMS_LOOKUPS package, implying that lookup value resolution is delegated there rather than performed by direct SQL against FND_LOOKUPS or GMS lookup tables. All other dependencies are programmatic: FND_FILE for concurrent output, FND_GLOBAL for application context, FND_LOG for the EBS logging framework, FND_MESSAGE and FND_MSG_PUB for message retrieval and the message stack, and FND_PROFILE for profile option values. The STANDARD package from SYS is referenced for PL/SQL built-in behavior. The absence of base table access is consistent with the package's design as a message and logging utility rather than a data-processing program.

Usage Notes

GMS_ERROR_PKG is positioned as an internal service layer. It is invoked from within other GMS packages and concurrent programs rather than directly from Oracle Forms, and the metadata records that it is referenced by 25 other packages while itself being referenced by no database object. Typical invocation patterns include:

  • PL/SQL exception handlers in GMS concurrent programs calling GMS_MESSAGE and the exception head/line procedures to produce standardized error output in the request log.
  • Development and support diagnostics invoking SET_DEBUG_CONTEXT followed by GMS_DEBUG to enable verbose tracing controlled by a profile option.
  • Report-style programs using GMS_OUTPUT to write formatted text through FND_FILE to the concurrent manager output file.
  • Custom GMS extensions reusing the package to obtain consistent, translatable error text instead of hard-coded strings.

Because the package is not a published API and carries no direct table dependencies, it may be changed by Oracle in patches and upgrades; custom code should treat it as an internal, non-guaranteed interface and prefer documented public APIs where available.