Search Results prv_message_type

Overview

ARP_DEBUG is a diagnostic utility package owned by the APPS schema in Oracle E-Business Suite, shipped under the Oracle Receivables product family. Its business function is to provide a controlled, centralized debugging and message-capture facility for PL/SQL code executed within the Receivables application. Unlike functional APIs that create or modify business transactions, ARP_DEBUG exists to support development, troubleshooting, and support diagnosis by allowing developers and administrators to emit debug lines to a file and to inspect messages generated through the Oracle Forms messaging layer.

The package body is substantially larger than the public specification suggests. Beyond the documented entry points, the specification defines the internal data structures that make the diagnostic capture possible, notably the record type PRV_MESSAGE_TYPE and the record type PROFILE_TYPE. The PRV_MESSAGE_TYPE record mirrors the parameters passed to FND_MESSAGE calls, storing the message name plus four token/value pairs (t1/v1 through t4/v4, each token and value being VARCHAR2). A package-level variable previous_msg of this type holds the most recently issued message so that a calling PL/SQL block can retrieve the same message and tokens and determine which processing steps are required. This is the construct users reference when searching for "prv_message_type". Package-level variables also include sysparm (typed against AR_SYSTEM_PARAMETERS%ROWTYPE), profile, application_id, and g_msg_module.

Key Procedures and Functions

The documented public interface comprises three procedures:

• DEBUG — Writes a debug line. It accepts the debug text plus optional parameters for a message prefix (defaulting to 'plsql'), a message module, and a message level, allowing output to be tagged and filtered by module and severity. This is the primary routine called throughout Receivables PL/SQL for instrumentation.
• ENABLE_FILE_DEBUG — Activates debug output directed to an operating-system file. It accepts a path name identifying the target file location, after which DEBUG calls are persisted to that file rather than discarded.
• DISABLE_FILE_DEBUG — Turns off file-based debug output, returning the package to its default state in which debug lines are not written to the file.

Parameter lists are not reproduced here; the names above reflect the documented callable interface only.

Tables Accessed

The package references two objects through APPS synonyms. AR_SYSTEM_PARAMETERS is read to load the package variable sysparm, giving debug output access to Receivables system-level settings such as operating unit context. UTL_FILE, the Oracle-supplied PL/SQL file I/O package, is the mechanism through which ENABLE_FILE_DEBUG and DEBUG write diagnostic lines to the file system. No business transaction tables are inserted, updated, or deleted by this package; all access is either read-only configuration or external file output.

Usage Notes

ARP_DEBUG is an internal diagnostics utility rather than a published integration API, and ETRM classifies it as OTHER. It is invoked from custom PL/SQL, Receivables concurrent programs, and other Receivables packages — the metadata records that it is referenced by twenty-four other packages. Typical use is to instrument code during development or to capture trace output when diagnosing a production issue: a developer calls ENABLE_FILE_DEBUG with a valid directory path, executes the code path under investigation, calls DISABLE_FILE_DEBUG, and then reviews the resulting file. Because file output depends on UTL_FILE and a valid database directory, appropriate directory grants and the UTL_FILE initialization parameter must be configured before enabling file debug. The PRV_MESSAGE_TYPE record and the previous_msg variable are used internally by dependent code to inspect the last message issued, so custom code that wraps FND_MESSAGE can leverage the same pattern. As with all diagnostic facilities, this package should not be relied upon by production business logic, as its behavior and specification are subject to change.