Search Results start_purge

Overview

The APPS.OZF_BASELINESALES_LIFT_PVT package is a private (PVT-classified) PL/SQL API within the Oracle E-Business Suite Trade Management (formerly Oracle Trade Management / OZF schema) module. Its primary business function is to purge baseline sales data and promotional lift factor data from the ETRM data model. Baseline sales represent the expected unit or revenue volume a product would have achieved absent promotional activity, while promotional lift factors quantify the incremental volume attributable to a trade promotion. Both data sets are computationally intensive to generate and are retained on a rolling basis; over time they accumulate significantly. This package provides the mechanism by which stale baseline and lift records are removed, preserving database performance and supporting data retention policies.

The package is compiled with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than the defining owner. The header comment identifies the source file as ozfvbsls.pls (version 120.0), consistent with the ETRM 12.x code line. It exposes a single documented public procedure, confirming its role as a focused purge utility rather than a general-purpose baseline calculation engine.

Key Procedures and Functions

• START_PURGE — The sole documented procedure. Its declared purpose is to "Purge Baseline Sales and Promotional Lift Factor Data." It accepts a standard concurrent-program output convention (an error buffer and a numeric return code) alongside several input parameters that scope the purge operation: a data source, a data type, a current-versus-historical indicator, a record type, and an as-of date. These inputs allow the caller to target a specific slice of baseline or lift data for deletion rather than purging the entire repository. The as-of date parameter in particular supports date-bounded retention logic, enabling deletion of records older than a specified cutoff. The ERRBUF and RETCODE parameters follow the standard Oracle EBS concurrent manager reporting contract, indicating the procedure is designed to be registered as a concurrent program executable.

Tables Accessed

The ETRM metadata for this object documents no table references through APPS synonyms. As an underscore-suffixed private package, OZF_BASELINESALES_LIFT_PVT would conventionally be invoked by a public wrapper package (typically OZF_BASELINESALES_LIFT_PUB) or directly by a concurrent program, with the actual DML performed against the underlying baseline sales and promotional lift base tables within the OZF schema. The absence of documented table references in the extract should be treated as incomplete metadata rather than evidence that the procedure performs no data manipulation, since a purge routine by definition performs deletes against persistent storage.

Usage Notes

The START_PURGE procedure is most typically invoked as an Oracle EBS concurrent program. The presence of the ERRBUF OUT NOCOPY VARCHAR2 and RETCODE OUT NOCOPY NUMBER signature is the standard convention for PL/SQL procedures registered as concurrent program executables, allowing the concurrent manager to capture log output and determine completion status. Administrators schedule it to run periodically—often nightly or weekly—to enforce data retention limits on baseline sales and lift factor history.

The metadata records zero packages referencing this object, reinforcing its position as a terminal consumer invoked from outside the PL/SQL package call graph (i.e., from a concurrent program definition or an external caller). Custom code should not call this procedure directly without careful consideration, because the operation is destructive and irreversible. Before invoking it, administrators should confirm the correct values for the data source, data type, current/historical indicator, record type, and as-of date parameters to avoid purging data still required for trade promotion analysis, lift reporting, or baseline recalculation. Database backups or export snapshots are advisable prior to large purge runs.