Search Results ozf_tp_util_pvt




Overview
Explore in AI Chat

Overview

OZF_TP_UTIL_PVT is a private (PVT) PL/SQL utility package in the Oracle EBS Applications (APPS) schema, owned by APPS and declared with AUTHID CURRENT_USER. It belongs to the Oracle Trade Management / Trade Promotion (OZF) product family, which manages trade promotions, offers, and related "time load" processing. The package header, dated and versioned in its $Header string, exposes a small set of general-purpose helper routines rather than business transactions. Its stated purpose is to initialize variables used for logging and other utility functions, to standardize debug and output messaging, and to provide timing instrumentation for OZF time-load processing and similar batch jobs.

In practical terms, the package centralizes three cross-cutting concerns: logging/out-file setup (for both concurrent-manager and non-concurrent execution), conditional debug output driven by a debug profile option, and elapsed-time measurement. It is a private package and is not intended as a supported public API; it is referenced internally by three other packages. Customers and implementers generally encounter it in the context of trade management batch processes rather than through direct calls.

Key Procedures and Functions

  • INITIALIZE — Sets up the logging environment. It determines the directory and file names for the log and out files (used when the program is not run through the concurrent manager) and establishes the debug flag from the debug profile setting. Defaults are provided for the log file name, out file name, and directory.
  • DEBUG_LINE — Emits a debug message when the debug flag is enabled, prefixing the text with "DEBUG: ". Messages are suppressed when debugging is off.
  • PUT_LINE — Writes a line of output; per the header comment, it is essentially a wrapper over the FND_FILE utility used to write to the concurrent manager log or output file.
  • PUT_TIMESTAMP — Prints the supplied text together with the current timestamp, useful for marking progress in a long-running load.
  • START_TIMER — Starts the package's internal timer used to measure elapsed processing time.
  • STOP_TIMER — Stops the running internal timer. This is the routine associated with the user's "stop_timer" search; it is the counterpart to START_TIMER and captures the end point for a timing measurement.
  • PRINT_TIMER — Reports the elapsed time recorded between START_TIMER and STOP_TIMER, allowing the caller to log how long a processing step took.
  • GET_SCHEMA_NAME — Returns the current schema name, used to qualify references or to identify the execution context.
  • GET_UTL_FILE_DIR — Returns the configured UTL_FILE directory, supporting direct file I/O when the routine is not executed via the concurrent manager.

Tables Accessed

The package is documented as referencing V$PARAMETER (accessed through an APPS synonym). This dynamic performance view exposes database initialization parameters, and it is read most plausibly to determine an operating-system directory or parameter needed by GET_UTL_FILE_DIR and the file-logging logic in INITIALIZE. No application data tables are documented as being read or written by this package. It does, however, write log and output content through FND_FILE via PUT_LINE and related routines, and writes physical files when a UTL_FILE directory is supplied.

Usage Notes

OZF_TP_UTIL_PVT is invoked internally rather than directly. Because it is classified as a private package and is referenced by three other OZF packages, its routines are typically called at the start of a trade-promotion batch program to initialize logging and debugging, at intervals to record progress with PUT_LINE and PUT_TIMESTAMP, and around expensive operations using START_TIMER, STOP_TIMER, and PRINT_TIMER to capture performance data. STOP_TIMER has no meaningful effect unless the corresponding START_TIMER was issued in the same session.

Behavior depends on configuration. Debug output appears only when the debug profile is set at the user or site level, and direct file logging applies only when the program runs outside the concurrent manager; under normal concurrent processing, output flows to the request log and output file. Because the package uses AUTHID CURRENT_USER and a UTL_FILE directory, privileges are resolved at runtime from the calling schema, meaning the executing schema must hold appropriate directory access. Custom code calling these routines should treat them as unsupported internals and design for change across EBS 12.1.1 and 12.2.2, where the observed behavior and procedure list are consistent.