Search Results cn_pmtplan_pvt




Overview
Explore in AI Chat

Overview

The APPS.CN_PMTPLAN_PVT package is a private PL/SQL API within the Oracle E-Business Suite Incentive Compensation (also known as Channel Revenue Management / Trade Management) module. It belongs to the CN application family and resides in the APPS schema. The package encapsulates the core business logic for creating, maintaining, and removing payment plans — the incentive structures that define how compensation is calculated, scheduled, and disbursed to sales representatives, channel partners, and other payees.

The _PVT naming convention indicates that this is a private API. It is not intended for direct invocation by external consumers; instead, it is wrapped and exposed through the corresponding public API, CN_PMTPLAN_PUB. The private package performs the actual data manipulation, validation, and referential-integrity enforcement, while the public package provides the stable, supported interface. This layered design is a standard Oracle EBS pattern that isolates implementation detail from the public contract and allows Oracle to refactor internal logic without breaking integrations.

The package was documented with a status of VALID, confirming that it compiled successfully and that its dependencies resolve correctly against the ETRM schema objects.

Key Procedures and Functions

The ETRM metadata documents three procedures within this package. No parameter signatures are published, and only their stated purposes are described here.

  • CREATE_PMTPLAN — Inserts a new payment plan record. This procedure validates the incoming plan attributes — including the associated credit type and interval type — and persists the header information into the payment plan base table and its supporting intersection tables. It is the primary entry point for establishing a new incentive compensation payment structure.
  • UPDATE_PMTPLAN — Modifies an existing payment plan. The procedure applies changes to plan attributes, re-validates the referenced credit and interval types, and maintains the associated child records such as role assignments and payment plan schedules.
  • DELETE_PMTPLAN — Removes a payment plan and its dependent records. The procedure is responsible for cleaning up the related rows in the intersection and schedule tables so that no orphaned references remain.

Tables Accessed

The package reads and writes several base and translation tables, accessed through APPS synonyms:

  • CN_PMT_PLANS and CN_PMT_PLANS_S — The base payment plan table and its primary key sequence/synonym, holding the plan header record.
  • CN_CREDIT_TYPES_ALL_TL and CN_CREDIT_TYPES — Credit type definitions and their translated descriptions, used to validate the credit type assigned to the plan.
  • CN_INTERVAL_TYPES_ALL_TL and CN_INTERVAL_TYPES — Interval type definitions and translations, used to validate the accrual or payout interval associated with the plan.
  • CN_ROLE_PMT_PLANS and CN_SRP_PMT_PLANS — Intersection tables linking payment plans to roles and to sales representatives (SRPs), supporting plan assignment and eligibility.
  • DUAL — Used for standard single-row PL/SQL and SQL operations.

Usage Notes

CN_PMTPLAN_PVT is normally invoked indirectly. The public package CN_PMTPLAN_PUB references it and delegates the actual DML work to it. The package also references itself, reflecting internal helper calls, and is referenced by the concurrent-program worksheet package CN_PMTPLAN_PVT_W. Typical invocation paths include:

  • Incentive Compensation setup forms, where administrators define and maintain payment plans through the EBS UI.
  • Concurrent programs that seed, copy, or bulk-maintain payment plan data.
  • Custom integrations that should call CN_PMTPLAN_PUB rather than this private package, preserving upgrade safety.

Because the procedures are private and undocumented at the parameter level, direct calls to CN_PMTPLAN_PVT are unsupported and may break during patching or upgrade between 12.1.1 and 12.2.2.