Search Results run_gratuity_formula

Overview

PAY_AE_GENERAL is a PL/SQL package owned by APPS in the Oracle E-Business Suite Payroll (PAY) module, classified as OTHER within the ETRM repository. Its header revision (pyaegenr.pkh 120.2) dates to November 2005 and is marked "noship," indicating it is a non-shipped, country-specific utility built to support payroll legislative requirements — in this case the United Arab Emirates, as reflected by the "AE" (United Arab Emirates) prefix in the package name. The package serves as a general-purpose helper library for UAE payroll processing, exposing functions that resolve local nationality rules, sector classification, message text, table-band lookups, assignment validation, and gratuity computation. It does not represent a business API in the conventional sense but rather an internal support toolkit consumed by UAE payroll formula functions and related PAY packages. The documented metadata lists 24 procedures and functions, and the package is referenced by one other package within the ETRM inventory.

Key Procedures and Functions

The documented functions fall into several functional clusters:

• Nationality utilities: LOCAL_NATIONALITY_NOT_DEFINED, LOCAL_NATIONALITY_MATCHES, GET_LOCAL_NATIONALITY, and GET_PERSON_NATIONALITY resolve whether a person's nationality is defined and whether it matches the local (UAE) nationality at a given earned date.
• Sector and parameter resolution: GET_SECTOR returns the sector classification for a tax unit, while GET_PARAMETER retrieves configuration values.
• Messaging: GET_MESSAGE produces localized message text, accepting up to three substitution tokens.
• Table band lookups: GET_TABLE_BANDS returns band values (numeric) from a named user table for a given earned date, supporting progressive calculation rules.
• Assignment validation: CHK_MULTIPLE_ASSIGNMENTS, GET_COUNT, GET_TOTAL_SUM, GET_CREDIT_SUM, GET_DEBIT_SUM, and CHK_TRAN_CODE validate and aggregate assignment-level and transactional data.
• Contract and gratuity processing: GET_CONTRACT, GET_CONTRACT_EXPIRY_STATUS, GET_PROBATION_PERIOD, and GET_TERMINATION_INITIATOR retrieve contract-related attributes and lifecycle states. USER_GRATUITY_FORMULA_EXISTS and RUN_GRATUITY_FORMULA manage end-of-service gratuity formula execution.

The user search term "get_contract" corresponds directly to the documented GET_CONTRACT function, which is central to UAE gratuity and contract-related payroll calculations.

Tables Accessed

The package references HR and PAY tables through APPS synonyms. PER_ALL_ASSIGNMENTS_F provides assignment records for nationality matching and multiple-assignment checks. HR_ALL_ORGANIZATION_UNITS, HR_ORGANIZATION_INFORMATION, and HR_SOFT_CODING_KEYFLEX supply organizational and key flexfield context for sector and parameter resolution. PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS support assignment and payroll action validation. PAY_ELEMENT_TYPES_F, PAY_RUN_RESULTS, and PAY_PRE_PAYMENTS are used for balance and run-result aggregation behind the sum functions. The user-table infrastructure — PAY_USER_TABLES, PAY_USER_COLUMNS, PAY_USER_COLUMN_INSTANCES_F, and PAY_USER_ROWS_F — backs GET_TABLE_BANDS. FF_DATABASE_ITEMS and FF_USER_ENTITIES link the package to Fast Formula definitions, particularly for gratuity formulas.

Usage Notes

PAY_AE_GENERAL is typically invoked from UAE payroll Fast Formulas, which call these helper functions to resolve nationality rules, sector classification, and gratuity calculations during payroll runs. It may also be called by concurrent programs and custom PL/SQL extensions performing UAE-specific payroll validation or reporting. As a "noship" object, it is not part of the standard shipped product and should be treated as a supporting internal package; direct custom calls are possible but carry upgrade risk since the package is not formally published. The 500-word scope here is grounded strictly in the documented ETRM metadata.