Results for “cn_worksheet_bonuses”

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

Overview

CN_WKSHT_BONUS_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified under the ETRM as an "OTHER" API. Its stated purpose, per the package header, is to serve as the table handler for the CN_WORKSHEET_BONUSES table. In the Oracle Incentive Compensation (formerly Oracle Sales Compensation / CN) module, this table stores bonus line entries associated with a payment worksheet — the working document compensation analysts use to review, adjust, and finalize incentive payments before they are paid.

The package exists to encapsulate the DML operations that the payment worksheet entry form performs against the bonus records, isolating validation and concurrency handling logic from the form's user-interface layer. It is a thin, form-oriented table handler rather than a business-processing engine: it does not calculate bonus amounts, run compensation plans, or produce payments. Instead, it persists the modifications an administrator makes while maintaining a payment worksheet.

Key Procedures and Functions

The package exposes four documented procedures, matching the four operations a block-based Oracle Forms screen requires.

• INSERT_ROW — The main insert procedure. It creates a new bonus record on a payment worksheet. Consistent with the CN_WORKSHEET_BONUSES schema, it accepts identifying keys such as the payrun, salesrep, quota, compensation plan, and salesrep plan assignment, together with the bonus amount itself, and the standard WHO columns (created_by and creation_date). It is the primary entry point used when a user adds a bonus line through the form.
• LOCK_ROW — Acquires a row-level lock once a form record has been modified. The header notes it is "only called from the form." It enforces optimistic concurrency control so that two users editing the same worksheet bonus line cannot silently overwrite each other's changes.
• UPDATE_ROW — Updates the salesrep payment plan assignment data for an existing bonus line. It carries the standard audit parameters (last_updated_by, last_update_login, last_update_date) and defaults the amount parameter to fnd_api.g_miss_num, which is the conventional Oracle API idiom for "leave this column unchanged."
• DELETE_ROW — Removes the salesrep payment plan line from the worksheet. The documentation excerpt is truncated, but the procedure's purpose is deletion of the bonus record identified by its composite worksheet/quota/plan keys.

Tables Accessed

• CN_WORKSHEET_BONUSES — The sole application table. All four procedures read, write, lock, or delete rows here. The table is the persistence target for the BONUSES block of the payment worksheet form.
• DUAL — Referenced via an APPS synonym, presumably for sequence-number retrieval, date comparison, or existence checks performed inside the procedural logic.

Usage Notes

The package is designed for invocation from the Oracle Forms application CNSBPS, block BONUSES — the payment worksheet bonus maintenance screen. Standard Forms integration means INSERT_ROW fires on record creation, LOCK_ROW fires on record modification (typically via a KEY-LOCK or ON-LOCK trigger), UPDATE_ROW fires on save, and DELETE_ROW fires on record removal. The AUTHID CURRENT_USER declaration means the package executes with the privileges of the calling schema rather than the definer, so effective privileges derive from the APPS user context under which the form session runs.

The change history shows only an initial creation in May 1999 and a header revision in October 2001, and ETRM reports zero other packages depending on it. The package is therefore stable, form-bound, and not intended as a general-purpose integration API. Custom code should prefer the public Incentive Compensation APIs rather than calling this handler directly, because its logic assumes the form's transaction and validation context.