Search Results cz_debug_pub




Overview
Explore in AI Chat

Overview

APPS.CZ_DEBUG_PUB is a public PL/SQL package body within the Oracle E-Business Suite ETRM (Engineering and Trading) module. Its documented purpose is to provide a centralized utility for capturing, accumulating, and persisting debug and diagnostic messages generated during ETRM processing—particularly network API and batch validation activity. The package header is classified as PUB, indicating it is a public API intended for invocation by other ETRM packages and custom extensions rather than being restricted to a single internal caller. According to the ETRM 12.2.2 metadata, the package is referenced by one other package, confirming its role as a shared logging service. The package exists in both Oracle EBS 12.1.1 and 12.2.2; the embedded source header revision (115.5, dated 2002/11/27) reflects its long-standing presence in the applications schema. Its design separates message collection from message persistence, allowing callers to buffer messages in a PL/SQL collection before writing them to the database in a single transactional unit.

Key Procedures and Functions

  • POPULATE_DEBUG_MESSAGE — Accumulates a single debug entry into an in-memory PL/SQL collection (typed as msg_text_list). It accepts the message text, the calling routine identifier, and an associated code, trims and truncates the message to the supported length, and appends a new record to the collection. This procedure is the primary mechanism through which callers stage diagnostic information prior to logging.
  • INSERT_INTO_LOGS — Flushes the accumulated collection to the persistent log table. It is declared with PRAGMA AUTONOMOUS_TRANSACTION, so log writes commit independently of the caller's transaction and survive rollbacks of the main business process. It obtains a run identifier, constructs a timestamped log user value, inserts one row per buffered message, then clears the collection and commits. Error handling rolls back the logging transaction and raises the exception to the caller.
  • GET_BATCH_VALIDATE_MESSAGE — Decodes a numeric message status returned by batch validation processing into a human-readable message string. It maps the supplied status code to the corresponding output text, allowing callers to present meaningful validation feedback rather than raw status numbers.

Tables Accessed

  • CZ_DB_LOGS — The destination log table. INSERT_INTO_LOGS writes logtime, loguser, caller, statuscode, message, creation_date, and run_id columns for each buffered debug entry. Messages are truncated to 2000 characters on insert.
  • CZ_XFR_RUN_INFOS_S — The sequence backing the transfer run identifier. INSERT_INTO_LOGS calls its NEXTVAL to obtain a unique run_id, grouping all messages from one logging invocation under a common identifier.
  • DUAL — Used to select the sequence next value during run identifier generation.
  • PLITBLM — A standard Oracle EBS table referenced by the package, typically associated with multi-lingual or message text handling utilities.

Usage Notes

CZ_DEBUG_PUB is typically invoked from ETRM network API processing, batch validation routines, and custom code that requires structured diagnostic output. The normal calling pattern is to invoke POPULATE_DEBUG_MESSAGE repeatedly during processing to buffer messages, then call INSERT_INTO_LOGS once to persist the accumulated set. Because INSERT_INTO_LOGS runs autonomously, debug records are retained even when the surrounding business transaction fails and rolls back, which is essential for troubleshooting failed transfers. GET_BATCH_VALIDATE_MESSAGE is used where batch validation returns numeric statuses that must be translated for display or error reporting. The package is not exposed through standard ETRM forms or concurrent programs; it is a programmatic utility invoked from PL/SQL. Developers extending ETRM should use the package header (CZ_DEBUG_PUB) rather than calling the body directly, and should note the 2000-character message limit enforced during population and insertion.