Search Results add_error_token

Overview

EAM_ERROR_MESSAGE_PVT is an Oracle E-Business Suite private PL/SQL package (owner APPS, API classification PVT) that provides the error-handling and message-management infrastructure for the Enterprise Asset Management (EAM) work-order processing framework. Its source file, EAMVWOES.pls, was first created in June 2002 and carries the header revision 120.1 — a lineage that predates and continues through EBS 12.1.1 and 12.2.2. The package is declared AUTHID CURRENT_USER, so it executes with the privileges of the calling session rather than those of its owner.

The package's central responsibility is to accumulate, categorize, and emit diagnostic messages generated while an EAM work-order or operation rebuild process executes. To support this, it defines a graded error-context model through named constants spanning sixteen structural levels (G_BO_LEVEL through G_REQUEST_TBL_LEVEL), covering business objects, work orders, operations, operation networks, resources, resource instances, sub-resources, resource usages, material requirements, direct items, work-order completions, quality, meter readings, completion rebuilds, MR reads, operation completions, and request tables. It likewise defines severity constants (warning, unexpected, error, fatal, not picked) and scope constants (all, record, siblings, children), allowing callers to tag each message with both its origin and its propagation scope. A record type, Error_Rec_Type, frames the stored error data.

Key Procedures and Functions

• TRANSLATE_AND_INSERT_MESSAGES — the routine the user searched for. It converts internal message tokens into user-facing, language-translated text and inserts the resulting messages into the package's internal message list.
• ADD_MESSAGE / ADD_ERROR_TOKEN — add a message or a substitution token to the current in-memory message list.
• GET_MESSAGE, GET_MESSAGE_LIST, GET_MESSAGE_COUNT, GET_ENTITY_MESSAGE — retrieve a single message, the full list, a count of pending messages, or messages associated with a specific entity.
• DELETE_MESSAGE / RESET / INITIALIZE — remove messages, clear the internal list, and initialize package state before a processing run.
• LOG_ERROR — records an error through the framework's standard logging path.
• SET_BO_IDENTIFIER / GET_BO_IDENTIFIER — store and retrieve the business-object identifier used to correlate messages with a processing context.
• OPEN_DEBUG_SESSION / CLOSE_DEBUG_SESSION / WRITE_DEBUG / DUMP_MESSAGE_LIST — manage a UTL_FILE-based debug session and dump accumulated messages, typically for diagnostics.

Tables Accessed

The documented references are UTL_FILE (the supplied package used for debug file output, exposed via a public synonym), PLITBLM (the PL/SQL message table used for message translation), and V$PARAMETER (the dynamic performance view read to determine the database character set or NLS setting influencing translation). No application data tables are directly named in the metadata; operational error state is held in PL/SQL memory and the Error_Rec_Type structure.

Usage Notes

As a PVT (private) package, EAM_ERROR_MESSAGE_PVT is not a published integration API. It is invoked internally by the EAM work-order, completion, and rebuild flows — the metadata records 79 other packages referencing it — and is called from concurrent programs and OA Framework/Forms-based EAM screens that require structured error capture. Custom code that must interact with the EAM message framework should call it only within an existing EAM processing context and should pair TRANSLATE_AND_INSERT_MESSAGES with RESET or INITIALIZE to avoid carrying stale messages between runs. Because it relies on PLITBLM for translation and on UTL_FILE for debug output, sessions invoking it require appropriate directory and file privileges when debug mode is active.