Results for “hr_ca_ff_udfs”

50+ results




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

Overview

APPS.HR_CA_FF_UDFS is a PL/SQL package that supplies user-defined functions (UDFs) for Oracle EBS Payroll fast formulas, specifically the Canadian localization of the UDF library. According to the source header, the file is the Canadian counterpart to pyusudfs.pkh, and its earliest iteration dates to May 1999, with subsequent releases tracked through version 115.7 in November 2006. The package is classified as OTHER under the Oracle E-Business Suite API classification scheme and is owned by APPS.

The business purpose of HR_CA_FF_UDFS is to expose reusable computation logic that fast formulas can call by name when deriving payroll run results, element entry values, and statutory deductions. Rather than embedding hour calculations, frequency conversion, and jurisdiction lookups directly in each formula, the payroll engine centralizes them here so that Canadian payroll formulas remain declarative and maintainable. The package therefore sits between the fast formula execution engine and the underlying payroll and HR tables.

Key Procedures and Functions

ETRM documents sixteen callable units in the package. Their roles are as follows.

  • CALCULATE_PERIOD_EARNINGS — derives earnings amounts for a given payroll period; its signature was extended in version 115.6 to accept additional parameters.
  • STANDARD_HOURS_WORKED — returns the standard hours a work schedule implies for a period.
  • CONVERT_PERIOD_TYPE — translates one payroll period frequency into another; also extended in version 115.6.
  • WORK_SCHEDULE_TOTAL_HOURS — aggregates total hours across a work schedule definition.
  • CHAINED_ELEMENT_EXISTS — tests whether a chained element is present, historically the first function documented in the US lineage (originally pychaind.sql, 1993).
  • US_JURISDICTION_VAL — resolves the jurisdiction value used by US and related tax formulas; inherited from the US UDF set and retained in the Canadian package.
  • GET_PROCESS_RUN_FLAG — reads a flag indicating the state of a payroll process run.
  • CHECK_DEDN_FREQ — validates that a deduction frequency is consistent.
  • SEPARATE_CHECK_SKIP — determines whether a separate check should be bypassed.
  • OTHER_NON_SEPARATE_CHECK — handles the non-separate check case.
  • OT_BASE_RATE — computes the base rate used for overtime calculations.
  • DEDN_FREQ_FACTOR — returns the deduction frequency factor, introduced in 1994 (bug G542).
  • ARREARAGE — supports arrears processing, added in 1994 (bug G815).
  • ADDR_VAL — supplies address-related values, added in 1994 for VERTEX formula use.
  • GET_EARNINGS_AND_TYPE — returns earnings together with their classification, added in 2006 (bug 5097793).
  • date_earned — the change history records the date_earned parameter being retyped from VARCHAR2 to DATE in 2000, reflecting date handling within these calculations.

Tables Accessed

The package reads and writes through APPS synonyms. Payroll definition tables supply element and frequency metadata: PAY_ELEMENT_TYPES_F, PAY_ELEMENT_CLASSIFICATIONS, PAY_ELEMENT_LINKS_F, PAY_FREQ_RULE_PERIODS, PAY_ELE_PAYROLL_FREQ_RULES, PAY_INPUT_VALUES_F, and PAY_STATUS_PROCESSING_RULES_F. Run-time results are drawn from PAY_RUN_RESULTS and PAY_RUN_RESULT_VALUES, with entries and their values in PAY_ELEMENT_ENTRIES_F and PAY_ELEMENT_ENTRY_VALUES_F. Formula definitions come from FF_FORMULAS_F, and session context from FND_SESSIONS. HR information is retrieved from HR_ORGANIZATION_INFORMATION, HR_SOFT_CODING_KEYFLEX, and, for jurisdiction and address values, organization and location data accessed via those structures.

Usage Notes

HR_CA_FF_UDFS is invoked indirectly rather than called by end users or by standard forms. Fast formulas reference these functions by name, so the package executes inside the Oracle Payroll run and QuickPay processing paths whenever a formula calls one of the listed UDFs. It is also referenced by one other package, and the header notes that database driver (dbdrv) lines were added in 2002 for GSCC, indicating the package is installed through the standard AD patch driver mechanism. Developers extending Canadian payroll formulas, or customizing seed data, should treat this package as the supported extension point for UDF logic. Because signatures changed across versions — most notably the additional parameters in CALCULATE_PERIOD_EARNINGS and CONVERT_PERIOD_TYPE — custom formulas must be validated after any upgrade to confirm compatibility with the installed package version.