Results for “work_schedule_total_hours”

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

Overview

APPS.HR_CA_FF_UDFS is a Canadian localization utility package body (source file pycaudfs.pkb) that supplies reusable user-defined functions (UDFs) to Oracle FastFormula processing within Oracle Payroll. The package encapsulates common payroll calculation logic — period conversion, earnings proration, work schedule totals, deduction frequency checks, and rate derivation — so that individual formulas do not have to embed this logic directly. Its documented origin traces to a copy of the US equivalent (pyusudfs.pkb) taken in May 1999, followed by localization adjustments for flexible dates, multi-radix conversion (11.5 compatibility), and translation-safe handling of date tables. The package is classified as OWNER APPS with API classification "OTHER", indicating it is primarily an internal support library rather than a public integration interface. It exposes sixteen documented procedures and functions and is referenced by one other package. The persistent theme across the change history is defensive coding: replacing row/column lookups with numeric day-of-week logic, using session dates instead of SYSDATE, and converting identifiers to character for safe comparison against descriptive flexfield segments.

Key Procedures and Functions

The documented routines fall into several functional groups. Earnings and period logic is handled by CALCULATE_PERIOD_EARNINGS, CONVERT_PERIOD_TYPE (which maps a period type to a period quantity, including fiscal-year-sensitive handling driven by session date), and WORK_SCHEDULE_TOTAL_HOURS and STANDARD_HOURS_WORKED, which derive normal hours from the work schedule for a given day. Element and rate support is provided by OT_BASE_RATE — the routine associated with the "ot_base_rate" search term — which derives a base rate for overtime calculations from the defined earnings and element setup, and by GET_EARNINGS_AND_TYPE, which returns an earning amount together with its classification. Deduction and frequency logic is covered by CHECK_DEDN_FREQ, DEDN_FREQ_FACTOR, SEPARATE_CHECK_SKIP, and OTHER_NON_SEPARATE_CHECK, which together determine whether a deduction applies in a given period and to which pay frequency. ARREARAGE supports retrospective payment calculations. CHAINED_ELEMENT_EXISTS tests whether a chained element relationship is defined for an entry, GET_PROCESS_RUN_FLAG reads a processing flag for the current run, US_JURISDICTION_VAL and ADDR_VAL return jurisdiction and address attributes used in Canadian payroll rules. Parameter lists are not reproduced here; callers should reference the live package specification in the target instance.

Tables Accessed

The package reads and writes data across payroll, element, and session tables through APPS synonyms. FastFormula and element definition metadata is read from FF_FORMULAS_F, PAY_ELEMENT_TYPES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_CLASSIFICATIONS, PAY_INPUT_VALUES_F, and PAY_ELE_PAYROLL_FREQ_RULES with PAY_FREQ_RULE_PERIODS. Run-time payroll results are read from PAY_RUN_RESULTS and PAY_RUN_RESULT_VALUES, with entries and their values from PAY_ELEMENT_ENTRIES_F and PAY_ELEMENT_ENTRY_VALUES_F. FND_SESSIONS holds the effective/session date that the package uses in place of SYSDATE, consistent with the documented change to use set_effective_date. HR_ORGANIZATION_INFORMATION supplies organization-level attributes, HR_SOFT_CODING_KEYFLEX is queried for account segment values (with the tax unit identifier cast to character), and PAY_STATUS_PROCESSING_RULES_F provides status processing rules.

Usage Notes

HR_CA_FF_UDFS is invoked indirectly, as a callable library from Canadian payroll FastFormula definitions and from other PL/SQL packages (the metadata records one referencing package). It is not presented to end users through a form. Typical invocation occurs during payroll run processing, element entry validation, and deduction or overtime rate evaluation, where a formula calls the appropriate UDF rather than reimplementing the logic. Because the package depends on FND_SESSIONS for effective dating, custom code that calls it should establish the correct session date first. All calls should be made through the package specification and validated against the installed version in the target EBS 12.1.1 or 12.2.2 environment, since behavior around period conversion and deduction frequency has changed across patch levels.