Results for “pqp_fedhr_uspay_int_utils”

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

Overview

APP.PQP_FEDHR_USPAY_INT_UTILS is a valid PL/SQL package body in the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 environments, owned by the APPS schema. It belongs to the payroll product family (PQP), and specifically supports the U.S. Federal HR and U.S. Payroll integration domain. Its functional role is to provide utility routines that bridge federal HR payroll element configuration and the salary basis structures used during payroll processing, scripted data conversions, or seeded data upgrades.

The package is classified as OTHER within the ETRM 12.2.2 metadata, indicating that it is not exposed as a public, customer-facing API but rather functions as an internal utility helper. Despite this, it is highly active in the dependency chain: it is referenced by 23 other database objects, meaning it is invoked indirectly by higher-level concurrent programs, packages, and potentially Oracle Forms or OAF pages that manage U.S. Federal payroll element definitions and conversions.

The package body is documented as VALID, and it is not a dependent object of any other database object. It therefore acts as a foundational utility layer that other components rely upon.

Key Procedures and Functions

ETRM documents seven procedures and functions within this package. Five named routines are explicitly documented:

• RETURN_NEW_ELEMENT_NAME — Returns the new (converted or target) payroll element name used when migrating or mapping federal payroll elements. It supports the renaming logic applied during element conversion.
• RETURN_OLD_ELEMENT_NAME — Returns the legacy (source) element name. It provides the inverse mapping of RETURN_NEW_ELEMENT_NAME and is used to identify elements before conversion.
• IS_SCRIPT_RUN — Determines whether a specific conversion or setup script has already been executed. This is a guard routine that prevents duplicate execution of one-time data migration logic.
• IS_ELE_LINK_EXISTS — Checks whether an element link already exists for a given element, typically within an assignment or business group context. It is used to avoid duplicate link creation during setup.
• PAY_BASIS_TO_SAL_BASIS — Performs a mapping conversion between a payroll basis value and a salary basis value. This is the core transformation routine that aligns federal payroll basis constructs with HR salary basis definitions.

The remaining two documented routines follow the same utility pattern (existence checks and name/value translations) implied by the five named above. Exact parameter lists are not exposed in the ETRM documentation and should be derived from the deployed package source in the target environment.

Tables Accessed

The package reads from and writes to the following documented tables (all accessed through APPS synonyms):

• PAY_ELEMENT_TYPES_F — Provides the element type definitions and names that the naming routines resolve.
• PAY_ELEMENT_LINKS_F — Used by IS_ELE_LINK_EXISTS to determine whether a link is already defined.
• PAY_INPUT_VALUES_F — Supplies input value metadata associated with elements, needed when evaluating element configuration.
• PER_ALL_ASSIGNMENTS_F — Provides assignment context for element link checks and basis resolution.
• PER_PAY_BASES — The source of payroll basis definitions used by PAY_BASIS_TO_SAL_BASIS.
• PQP_CONFIGURATION_VALUES — Stores configuration parameters that drive the utility behavior, such as whether scripts have run.
• PLITBLM — A PL/SQL internal table type used for in-memory collections within the package logic.

Additional referenced objects include GHR_GENERAL, HR_UTILITY, and PER_BUSINESS_GROUPS, which provide general HR utility functions and business group context.

Usage Notes

PQP_FEDHR_USPAY_INT_UTILS is not intended for direct customer invocation. It is typically called from higher-level federal HR/payroll processes, including seeded data conversion scripts, concurrent programs that set up U.S. Federal payroll elements, and Oracle Forms or OAF-based payroll setup pages. Because the package is referenced by 23 other objects, it functions as a shared utility layer.

When troubleshooting U.S. Federal Payroll element setup or conversion issues in EBS 12.1.1 or 12.2.2, this package is often a starting point for tracing how element names and pay bases are translated.