Search Results set_line

Overview

AS_MESSAGE is an Oracle Application Object Library utility package owned by APPS and classified as an OTHER API within ETRM. Its purpose, stated in the package header, is to allow messages — both for reporting and debugging — to be written to a database table or to memory by PL/SQL programs executed on the server. When program control is returned to the client, the accumulated messages can be retrieved and used in a report, log file, or similar output structure. The package therefore provides a generic, server-side message stack and output abstraction that predates and complements standard concurrent program logging facilities.

The package history documents an evolution beginning in January 1994, when it was created by R Lee. Early modifications routed messages to the table AS_CONC_REQUEST_MESSAGES, renamed Put_DB_Error to Set_Error, and separated the output buffers for normal and debugging messages so each can be controlled independently. In March 1994 Set_Line was added to replace Put_Line, and references to AS_REPORT_ENTRIES were redirected to AS_CONC_REQUEST_MESSAGES. Support for retrieving the last message sequence was added in April 1994, and in October 1994 calls to FND_PROFILE for WHO information were replaced with calls to FND_GLOBAL.

Key Procedures and Functions

The documented API surface comprises fourteen procedures and functions. INITIALIZE establishes the package state, including which output buffers (database table or memory) are used for normal versus debugging messages. SET_LINE and PUT_LINE write messages to the buffer; SET_LINE was introduced to supersede PUT_LINE. These are the routines most closely associated with the “set_line” search term. DEBUG writes debugging-class messages subject to the independently controlled debugging buffer. SET_NAME and SET_TOKEN associate an identifier and a token with the message context. GET retrieves buffered messages for return to the client, and MESSAGE_COUNT reports how many messages are currently held. SET_ERROR and PUT_DB_ERROR record error messages, with PUT_DB_ERROR representing the earlier naming referenced in the history. FLUSH empties or commits the message buffer, CLEAR resets package state, PURGE_MESSAGES removes persisted messages, and LAST_MESSAGE_SEQUENCE returns the sequence value assigned to the most recently written message.

Tables Accessed

The package reads and writes AS_CONC_REQUEST_MESSAGES and its sequence object AS_CONC_REQUEST_MESSAGES_S through APPS synonyms. AS_CONC_REQUEST_MESSAGES is the persistent store for messages associated with a concurrent request; the sequence supplies the message sequence values exposed by LAST_MESSAGE_SEQUENCE. Messages are written to this table when the output buffer is configured for database output, and to an in-memory PL/SQL table when configured for stack output, as controlled by the private G_Output_Code variable and the INITIALIZE routine.

Usage Notes

AS_MESSAGE is invoked directly by PL/SQL executed on the server, typically from concurrent program logic or other server-side code that needs to capture reporting or debugging output. A caller generally invokes INITIALIZE to select output buffers, writes messages through SET_LINE or PUT_LINE, uses DEBUG for diagnostic output, and then retrieves accumulated messages with GET once control returns to the client. Because the package is referenced by zero other documented packages, it functions as a leaf utility rather than a dependency of other APIs. It is important to note that the header date (2002) and class history indicate a long-standing utility; in 12.1.1 and 12.2.2 environments, custom code should prefer the standard FND logging facilities where equivalence permits, but AS_MESSAGE remains available for legacy code paths requiring SET_LINE-style message stacking.