Results for “pay_hours_by_rate”

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

Overview

PAY_HOURS_BY_RATE is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite, classified under the ETRM API category "OTHER." Its header comment identifies it as an Oracle Corporation UK Ltd. development originating in Chertsey, England, with a version string of payhoursbyrate.pkb 120.1 dated 13-APR-2006. The package belongs to the Oracle Payroll (PAY) product family and performs element-level calculation logic used to derive hours worked and pay amounts from rate-based input values.

Functionally, the package addresses the requirement to convert a rate-based element input into a monetary amount for payroll processing. The change list records a single evolution: version 115.0 (01-FEB-2005) created the object, and version 115.1 (13-APR-2006) added logic "to get amount and return." This indicates the original package resolved an input value identifier, and a later revision extended the logic to retrieve the associated result amount. In the Oracle EBS 12.1.1 and 12.2.2 file systems, the package body resides under the PAY product directory and is typically compiled during the standard application patching and compilation cycle.

Key Procedures and Functions

ETRM documents one function for this package: GET_RESULT_VALUE. The excerpt shows its declaration beginning at line 51, with parameters for a run result identifier, an element type identifier, and a mode string, returning a NUMBER. The function is the primary public entry point of the package and represents the functionality added in the 115.1 revision.

The excerpt also reveals a second, supporting function, GET_INPUT_VALUE, which accepts an element type identifier and an input value name and returns a NUMBER. Although ETRM lists only GET_RESULT_VALUE as the documented procedure, GET_INPUT_VALUE is defined earlier in the same package body at line 31 and is used to resolve the input value identifier through the PAY_INPUT_VALUES_F table. GET_RESULT_VALUE then uses that identifier to look up the corresponding value in PAY_RUN_RESULT_VALUES. Together they form a two-step resolution chain: name to input value identifier, then input value identifier to result amount.

Tables Accessed

The package reads two tables, both accessed through APPS synonyms. PAY_INPUT_VALUES_F holds element input value definitions; the package queries it by input value name and element type identifier to obtain the INPUT_VALUE_ID. PAY_RUN_RESULT_VALUES holds the per-assignment run result values generated during payroll processing; the package queries it by run result identifier and input value identifier to return the RESULT_VALUE.

Both tables are core Oracle Payroll tables. PAY_INPUT_VALUES_F is date-effective and is normally queried using an effective date context, while PAY_RUN_RESULT_VALUES stores the results of a specific payroll run for a specific assignment. The package performs read-only access against both tables and does not insert, update, or delete rows.

Usage Notes

PAY_HOURS_BY_RATE is referenced by one other package, indicating it is consumed internally by payroll calculation logic rather than being called directly from a form. It is most likely invoked from a payroll formula function or from another payroll calculation package during the run process, when an element requires conversion of a rate-based input into a payable amount. Custom code integrating with this package should respect the effective-dating and run context requirements of the underlying tables, and developers should be aware that only GET_RESULT_VALUE is formally documented, so GET_INPUT_VALUE should not be treated as a stable public interface.