Search Results print_success

Overview

PSP_MESSAGE_S is an Oracle E-Business Suite PL/SQL messaging utility package owned by the APPS schema and classified under the ETRM "OTHER" API category. It belongs to the Oracle HRMS/Enterprise Resource Planning payments and payroll-adjacent messaging infrastructure and is declared with AUTHID CURRENT_USER, meaning that its SQL statements execute under the privileges of the calling schema rather than the defining schema. The package provides a centralized, lightweight mechanism for capturing, storing, formatting, and retrieving API messages — both errors and success notifications — generated during PL/SQL processing. Its central role is to standardize how validation and processing outcomes are surfaced to end users and to calling code, so that developers across Oracle EBS modules do not re-implement message handling logic. The header comment shows a last change stamp of 2002, indicating the package is a long-standing, stable component of the applications stack, and the ETRM confirms that it is referenced by 17 other packages, underlining its position as a shared foundation utility within the EBS 12.1.1 and 12.2.2 codebase.

Key Procedures and Functions

• Get — A function returning a VARCHAR2 message payload for a supplied message index, with an optional encoding flag defaulting to FND_API.G_TRUE. It retrieves the stored message text corresponding to the internal message index held by the calling session.
• Print_Error — Prints accumulated error messages according to a supplied mode, optionally including a header. It is the primary debugging and user-facing diagnostic output routine.
• Insert_Error — Inserts an error record into the package's internal message store. It accepts the source process, a process identifier, a message count, the message data, and a description-sequence indicator. It is documented as commented-out in the header, meaning it is retained for compatibility but not formally declared in the current signature block.
• Print_Success — Emits the success message associated with the current processing context, used to confirm normal completion to the user.
• Get_Error_Message — An OUT-parameter procedure that returns the accumulated error message string, optionally prefixed with a header. The NOCOPY hint on the OUT parameter avoids copying overhead for large strings.
• Get_Success_Message — An OUT-parameter procedure that returns the success message string for the current context. This is the routine most often located by developers searching for "get_success_message", and it is the counterpart to Get_Error_Message in the package's symmetric error/success design.

Tables Accessed

The ETRM metadata does not enumerate any tables referenced through APPS synonyms. The package operates principally on in-memory PL/SQL state and, where persistence is required, on standard FND message infrastructure accessed indirectly through FND_API. No direct base-table reads or writes are documented.

Usage Notes

PSP_MESSAGE_S is typically invoked from PL/SQL APIs, concurrent program logic, and forms-based code that need to either record and print errors or confirm successful completion. The conventional pattern is for the driving routine to call Insert_Error (or the FND equivalent) as errors accumulate, then call Print_Error or Get_Error_Message when the process finishes; on success, Print_Success or Get_Success_Message is called instead. Because the package is declared AUTHID CURRENT_USER and is referenced by 17 other packages, customizations should call it using the standard APPS.PSP_MESSAGE_S prefix and should not assume any persistent storage beyond what FND provides. When extending or debugging existing code, developers should treat the documented six routines as the supported interface and avoid relying on the commented-out Insert_Error signature, since the active declaration may differ in later patch levels of 12.2.2.