Search Results cn_purge_pkg




Overview
Explore in AI Chat

Overview

CN_PURGE_PKG is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite Release 12.1.1 and 12.2.2. It belongs to the Oracle Incentive Compensation (OIC) module, where the CN prefix designates objects belonging to the Compensation/Commission application family. The package is documented with a status of VALID and is classified under the ETRM API classification "OTHER," indicating that it is an internal utility package rather than a public, supported application programming interface.

The business function of CN_PURGE_PKG is to provide controlled purge (deletion) processing for transactional and setup data maintained by Oracle Incentive Compensation. Purge operations in EBS are typically performed to remove obsolete or historical data from the operational tables, thereby reducing storage consumption and preserving the performance of high-volume incentive compensation processing. Because incentive compensation generates large volumes of transactional records — transactions, transaction lines, sales lines, commission headers and lines, payment worksheets, and summary period/period quota records — a dedicated package is required to enforce the correct deletion sequence across the related tables and to maintain referential integrity in the absence of physical foreign key constraints on some of these relationships.

Key Procedures and Functions

The documented package interface exposes a single procedure:

  • PURGE — the sole documented procedure in the package specification. Its purpose is to execute purge processing. The ETRM metadata does not document a parameter list for this procedure, and no parameter signature is asserted here. Functionally, the procedure drives the deletion of the target incentive compensation records, coordinating the removal of dependent rows and parent rows in the correct order. Applications typically invoke it with selection criteria that scope the purge to a particular period, batch, or date range, but the precise parameters cannot be confirmed from the available documentation.

The package consists of both a specification ([Package]) and a package body ([Package Body]), and the ETRM extract also records SQL statement and dependency information. The only external dependency identified is SYS.STANDARD, meaning the package relies on standard PL/SQL language constructs rather than on other application-level packages. No other package is documented as referencing CN_PURGE_PKG, which is consistent with it being an internal or administrative utility invoked directly rather than through a layered API.

Tables Accessed

The package references the following tables through APPS synonyms, grouped by functional area:

These references indicate that the purge routine spans the full incentive compensation data model, from source transactions and not-transacted records, through commission calculations and interface staging, to payment worksheets, pay runs, summary quota structures, and the associated ledger journal entries. The inclusion of API-named interface tables (CN_COMM_LINES_API, CN_PAYMENT_API) suggests the purge also clears staged interface records that would otherwise be reprocessed.

Usage Notes

CN_PURGE_PKG is an internal administrative utility. It is not a documented public API, and the ETRM classification of "OTHER" should be treated as a caution against depending on it from custom extensions. Because the package is not referenced by any other documented package, invocation is expected to occur directly — either from an application-level maintenance or purge process, from system administration tooling, or from a concurrent program that accepts user-entered purge criteria. Customers considering retention or archiving policies in Oracle Incentive Compensation should evaluate this package in conjunction with Oracle's documented purge and archive guidance for the module. Any custom invocation should be preceded by a full backup, executed during a maintenance window, and tested in a non-production environment, since the deletions performed are physical and irreversible.