Results for “cn_calc_rollup_pvt”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

CN_CALC_ROLLUP_PVT is a private PL/SQL package in the APPS schema that supports the Oracle E-Business Suite Trade Management (formerly Oracle Incentive Compensation / ETRM) calculation engine. Its name reflects its role: "CN" is the application short name for Trade Management, "CALC" denotes calculation, and "ROLLUP" refers to the aggregation of transaction-level results into higher-level commission or incentive summaries. The "PVT" suffix indicates that the package is classified as a private API — it is not intended for direct invocation by external or customer-written code, but rather functions as an internal implementation layer consumed by the public calculation and transaction-loading APIs within the same application.

Functionally, the package participates in the batch calculation lifecycle. After individual commission lines and transaction records have been processed by the calculation engine, a rollup step consolidates those results into the submission and process batch structures so that downstream reporting, crediting, and payment routines operate against summarized data rather than raw transaction rows. This separation of detailed calculation from aggregation improves both performance and data integrity within large calculation runs.

Key Procedures and Functions

The documented metadata identifies a single public-facing procedure within the package specification: ROLLUP_BATCH. Based on its name and the package's classification, ROLLUP_BATCH is responsible for executing the aggregation logic for a given calculation batch. It typically receives an identifier for the batch or batch group being processed, then iterates across the associated commission headers and lines, summarizing amounts and quantities into the submission batch tables used by subsequent processing stages.

Because CN_CALC_ROLLUP_PVT is a private package, the exact parameter signature of ROLLUP_BATCH is not exposed in the public API documentation. The metadata confirms only the procedure's existence and its position as the sole documented entry point. The package body may contain additional internal helper routines that are not published in the specification and are therefore not enumerated in the ETRM documentation.

Tables Accessed

The package reads and writes a range of Trade Management tables, all referenced through APPS synonyms. The primary work tables include CN_CALC_SUBMISSION_BATCHES_ALL, which stores the batch definitions produced by the calculation submission process, and CN_PROCESS_BATCHES_ALL, which tracks batch-level processing state. Detail and summary commission data flows through CN_COMMISSION_HEADERS, CN_COMMISSION_HEADERS_ALL, CN_COMMISSION_HEADERS_S, CN_COMMISSION_LINES_ALL, and CN_COMMISSION_LINES_S — the _S variants being sequence-backed tables used for surrogate key generation.

Supporting configuration and context tables include CN_COMP_PLANS (compensation plan definitions), CN_SRP_PLAN_ASSIGNS (plan assignments to sales representatives), CN_SRP_INTEL_PERIODS_ALL (period definitions governing when calculations apply), CN_REPOSITORIES_ALL (repository metadata), and CN_NOTIFY_LOG_ALL (notification logging for workflow and alerting). PLITBLM is an Oracle-supplied PL/SQL table type used for passing collections of identifiers into and out of the aggregation logic.

Usage Notes

CN_CALC_ROLLUP_PVT is referenced by three other packages: CN_PROC_BATCHES_PKG, CN_TRANSACTION_LOAD_PKG, and CN_TRANSACTION_LOAD_PUB. This dependency pattern confirms that the rollup logic is triggered from the batch-processing layer and from both the private and public faces of the transaction load API. In practice, ROLLUP_BATCH is invoked as part of concurrent program execution — most commonly the calculation batch process — rather than from an Oracle Forms UI.

Because the package is classified as PVT, Oracle does not guarantee its interface across releases or patches. Customers and partners should not call ROLLUP_BATCH directly; instead, they should invoke the public calculation or transaction-load concurrent programs that internally reach this package. The package depends on FND_API, the standard Oracle Application Object Library API package, which supplies error-handling and message-buffer utilities used during rollup execution.