Search Results cn_pay_approval_flow_s

Overview

The APPS.CN_PAY_APPROVAL_FLOW_PVT package body is a private (PVT-classified) PL/SQL API within the Oracle E-Business Suite Incentive Compensation module. It encapsulates the business logic that governs the approval workflow for payment worksheets and pay runs. Its purpose is to enforce the internal controls that determine whether a compensation payment worksheet may be submitted, approved, or rejected, and whether a pay run may proceed to payment. By isolating this logic in a private package body, Oracle ensures that approval routing, security validation, and period-status checks occur consistently and cannot be bypassed by external callers. The package depends on the public CN_PAY_APPROVAL_FLOW_PKG and the underlying CN_PAY_APPROVAL_FLOW table to persist workflow state, while delegating row-level security checks to CN_PAYMENT_SECURITY_PVT. The ETRM metadata records the object as VALID in the APPS schema and confirms it is not referenced by any other database object, indicating it is invoked exclusively from application-tier code.

Key Procedures and Functions

The package body exposes four documented procedures, each corresponding to a stage in the payment approval lifecycle:

• SUBMIT_WORKSHEET — Initiates the approval workflow for a payment worksheet. It validates the worksheet against security and period constraints and establishes the approval routing records required for subsequent approval actions.
• APPROVE_WORKSHEET — Advances a submitted worksheet through its approval hierarchy, recording the approver's decision and updating the worksheet's workflow status when final approval is granted.
• REJECT_WORKSHEET — Returns a worksheet to its originator by recording a rejection decision, allowing the worksheet to be corrected and resubmitted.
• PAY_PAYRUN — Executes the final payment action on an approved pay run, performing the validation necessary to confirm that all approval prerequisites have been satisfied before disbursement.

Tables Accessed

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

• CN_PAYMENT_WORKSHEETS — the primary worksheet entity whose status and contents are acted upon.
• CN_PAYRUNS — the pay run records validated and paid by PAY_PAYRUN.
• CN_PAY_APPROVAL_FLOW and CN_PAY_APPROVAL_FLOW_S — store the approval-flow definition and its translated (MLS) description columns used to resolve routing and display rules.
• CN_PERIOD_STATUSES — confirms that the compensation period is open for payment activity.
• JTF_RS_GROUP_USAGES, JTF_RS_REP_MANAGERS, and JTF_RS_RESOURCE_EXTNS — the CRM resource tables used to resolve approver identity, reporting hierarchy, and resource attributes for the approval chain.
• DUAL — used for single-row evaluations, typically to call FND_API, FND_GLOBAL, FND_MESSAGE, and FND_MSG_PUB routines for error handling and message retrieval.

Usage Notes

Because CN_PAY_APPROVAL_FLOW_PVT is a private package, it is not intended as a public integration point. It is normally invoked indirectly through the public wrapper CN_PAY_APPROVAL_FLOW_PKG, which Oracle Incent Compensation forms and concurrent programs call when an administrator submits, approves, or rejects a payment worksheet or releases a pay run. The internal calls to CN_PAYMENT_SECURITY_PVT ensure that only authorized users can act on a given worksheet, while the calls to the FND_API/FND_MSG_PUB stack return standardized error messages to the calling form. Customizations should target the public package rather than this private body, since Oracle may change private signatures during patching. When troubleshooting approval or payment failures in EBS 12.1.1 or 12.2.2, the signature can often be traced to a closed period in CN_PERIOD_STATUSES or a missing reporting relationship in the JTF resource tables.