Search Results reject_worksheet

Overview

The APPS.CN_PAY_APPROVAL_FLOW_PVT package is a private PL/SQL API belonging to the Oracle Incentive Compensation (CN) module, delivered as part of the Oracle E-Business Suite 12.1.1 and 12.2.2 technology stacks. Its principal business purpose is to manage the approval workflow lifecycle for payment worksheets and payruns generated by the incentive compensation engine. The package encapsulates the state transitions that a worksheet must traverse — submission, approval, and rejection — before a payrun can be processed and released for payment to sales representatives and channel partners. Because it is declared as a private (PVT) API with the AUTHID CURRENT_USER directive, it is intended for internal use by the Incentive Compensation application logic rather than as a documented public interface for external integrations. The AUTHID CURRENT_USER clause ensures that database privilege checks are evaluated against the invoking schema, which is significant in multi-org and delegated administration scenarios.

Key Procedures and Functions

The ETRM metadata documents four callable units within the package. Each follows the Oracle EBS API conventions established by FND_API, including the standard p_api_version input and the x_return_status, x_msg_count, and x_msg_data output parameters.

• SUBMIT_WORKSHEET — Submits a payment worksheet for approval. The procedure accepts a worksheet identifier and drives the worksheet from a draft or editable state into the approval queue, validating that the worksheet is eligible for submission.
• APPROVE_WORKSHEET — Approves a submitted worksheet. This procedure advances the approval flow to its approved state and is the counterpart action performed by an authorized approver or manager.
• REJECT_WORKSHEET — Rejects a submitted worksheet, returning it to a state where the originating compensation analyst can revise and resubmit the data.
• PAY_PAYRUN — Processes a payrun for payment. This procedure corresponds directly to the search term pay_payrun, and is the terminal action in the approval flow, executing the payment of an approved payrun against the worksheets it contains.

Each procedure is declared with default values for p_init_msg_list, p_commit, and p_validation_level, consistent with the standard EBS PL/SQL API template.

Tables Accessed

The package reads and writes a defined set of application tables through APPS synonyms:

• CN_PAYMENT_WORKSHEETS — the primary worksheet entity whose lifecycle is being managed.
• CN_PAYRUNS — the payrun records acted upon by PAY_PAYRUN.
• CN_PAY_APPROVAL_FLOW and CN_PAY_APPROVAL_FLOW_S — the approval flow definition and its translated (secure) counterpart, establishing the sequence of approval steps.
• CN_PERIOD_STATUSES — validates that the compensation period is open and eligible for the requested action.
• JTF_RS_GROUP_USAGES, JTF_RS_REP_MANAGERS, and JTF_RS_RESOURCE_EXTNS — Resource Manager tables used to derive the approval hierarchy, resolve managers, and identify the resources involved in the flow.
• DUAL — used for single-row PL/SQL constructs and default derivations.

Usage Notes

Because CN_PAY_APPROVAL_FLOW_PVT is classified as a private API, it is not intended to be called directly by customers or integrators. It is invoked internally by the Incentive Compensation payment worksheet and payrun forms, by concurrent programs that drive bulk submission and approval, and by the one other package documented as referencing it. Custom code requiring equivalent behavior should preferentially call the public Incentive Compensation APIs or the standard CN_PAY_*_PUB interfaces; direct invocation of this private package risks incompatibility across patch levels, since the header reflects a version (115.1) far older than the current 12.2.2 code line. Developers diagnosing the pay_payrun process should trace execution through this package to understand how approval flow records and payrun status transitions are applied.