Search Results calculated_value

Overview

APPS.PAY_SG_EXC is an Oracle Payroll legislative package that encapsulates the expiry checking logic for Singapore (SG) balance dimensions. As documented in the package header comment, the module (pysgexch.pkb) contains the "expiry checking code associated with the SG balance dimensions," established as a packaged construct following Oracle's migration to latest balance functionality. That architectural change required expiry logic previously held in standalone constructs to be repositioned inside packaged procedures, and PAY_SG_EXC is the Singapore-specific realization of that pattern. The package is declared AUTHID CURRENT_USER, so its unqualified object references resolve against the invoking schema's privileges rather than the definer's, which is consistent with Oracle Payroll's balances architecture that runs under APPS with granular grants. The original implementation (dated 25/04/00) was modelled on the US equivalent, PAYUSEXC, reflecting the product's practice of deriving each legislation's expiry checker from a common template while varying only the balance dimension rules. In ETRM the package is classified under API classification OTHER, indicating that it is an internal Payroll engine component rather than a published business API exposed to integrators.

Key Procedures and Functions

• DATE_EC — The core expiry-check procedure. It receives both the owner (the payroll or assignment action that created the stored balance) and the user (the current run's payroll or assignment action), together with their respective effective dates and the balance dimension name. It returns an expiry flag through an OUT NOCOPY parameter. Two overloads exist: the original returns a number representing the dimension expired flag, and a version introduced under Bug 2797863 returns a date representing the dimension expiry date. These distinguish a simple "is this dimension expired" test from the requirement to know precisely when expiry occurs.
• GET_EXPIRY_DATE — A function that derives the expiry date for a given defined balance and the assignment action that created it, returning a DATE. It supplies the date-level answer consumed by the balances engine when constructing or evaluating retrieved balance values.
• CALCULATED_VALUE — A function that, given a defined balance and assignment action, determines the calculated value used in expiry evaluation. It provides the numeric basis against which expiry decisions are reached.

All four documented entries are private in the sense that the header lists no public functions; callers reach them through the legislation's balance dimension definition rather than as a supported external API.

Tables Accessed

The package reads the Payroll balances and action infrastructure through APPS synonyms:

• PAY_DEFINED_BALANCES and PAY_BALANCE_DIMENSIONS — the definitions and SG dimension metadata that the expiry rules evaluate.
• PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS — the owner and user action identifiers and their effective dates supplied to DATE_EC.
• PER_TIME_PERIODS — the payroll period calendar used to resolve effective and expiry dates.
• HR_ORGANIZATION_INFORMATION — organization-level payroll attributes consulted during expiry determination.

Usage Notes

PAY_SG_EXC is not invoked directly from Oracle Forms or from user-facing concurrent programs. It is called by the Oracle Payroll balances engine at run time whenever Singapore balance dimensions are retrieved, with the engine passing the owner/user action pairs that frame the expiry comparison. ETRM records it as referenced by two other packages, confirming that its entry points are consumed internally by dependent payroll legislation code. Custom or extension code should avoid calling these procedures directly, since their signatures are internal and have changed historically (as evidenced by the Bug 2797863 overload); integrations requiring Singapore balance expiry behaviour should instead drive standard payroll balance retrieval and allow the engine to resolve expiry through this package. Its presence is relevant to environments running the Singapore payroll legislation on EBS 12.1.1 or 12.2.2, where it must remain valid and compiled against the APPS schema for SG balances to evaluate correctly.