Search Results get_consolidation_set

Overview

PAY_AC_UTIL is a utility package owned by the APPS schema within the Oracle E-Business Suite Oracle Payroll module. It is classified as a UTIL (utility) API, indicating that it is not a business-facing process in its own right but rather a shared library of helper routines used by other payroll components. Its principal functional role is to support the US Payroll Archive and Balance View (PAYBV) extraction and reporting programs, as well as related payroll processing logic. The package status is documented as VALID in ETRM for both 12.1.1 and 12.2.2.

The package abstracts common lookup and formatting tasks that would otherwise be duplicated across archive extractors and validation code. By centralizing these operations, PAY_AC_UTIL ensures consistent handling of legislative parameters, jurisdiction names, date formatting, and balance definitions across multiple payroll archive programs.

Key Procedures and Functions

ETRM documents nine callable units within the package. These are:

• GET_LEGIS_PARAMETER — Retrieves a legislative parameter value, allowing callers to resolve country-specific payroll configuration without hard-coding legislative constants.
• GET_JURISDICTION_NAME — Returns the descriptive name of a jurisdiction, typically used when rendering tax or reporting extracts by jurisdiction.
• GET_STATE_ABBREV — Resolves a state abbreviation, supporting US payroll reporting where two-letter state codes are required.
• GET_FORMAT_VALUE — Returns a value formatted according to a defined format mask, centralizing output formatting for archive files.
• GET_CONSOLIDATION_SET — Returns consolidation set information, used to resolve the set under which a payroll is grouped for reporting.
• GET_PAYROLL_NAME — Returns the descriptive name of a payroll given its identifier.
• FORMAT_TO_DATE — Converts an input value into a date, applying the appropriate date format convention.
• GET_DEF_BAL_FOR_SEEDED_BAL — Maps a seeded balance to its corresponding defined balance, supporting balance extraction logic.
• GET_VALUE — A general-purpose lookup utility for retrieving configured values.

Exact parameter lists are not documented in the ETRM metadata and should be verified against the installed package body.

Tables Accessed

PAY_AC_UTIL references eleven tables through APPS synonyms. The payroll core tables include PAY_ALL_PAYROLLS_F (payroll definitions), PAY_PAYROLL_ACTIONS (payroll run actions), PAY_CONSOLIDATION_SETS (consolidation groupings), PAY_BALANCE_TYPES and PAY_DEFINED_BALANCES and PAY_BALANCE_DIMENSIONS (balance definition and dimensionality). US-specific reference tables include PAY_US_STATES, PAY_US_CITY_NAMES, and PAY_US_COUNTIES, which support jurisdiction and state abbreviation lookups. HR_ORGANIZATION_INFORMATION supplies organization-level attributes such as statutory or legislative information. PLITBLM is the Oracle Applications PL/SQL index-by table structure used for passing multi-row values.

Usage Notes

PAY_AC_UTIL is primarily invoked by the PAYBV archive packages: PAYBV_EMPLOYEE_ARCHIVE, PAYBV_US_CITY_ARCHIVE, PAYBV_US_COUNTY_ARCHIVE, PAYBV_US_LOCAL_ARCHIVE, and PAYBV_US_SCHOOL_ARCHIVE. These programs generate archived payroll data files for US tax and regulatory reporting, and rely on PAY_AC_UTIL for name resolution, parameter retrieval, and date formatting. The package is also self-referencing. Custom code or concurrent programs performing similar archive or balance extraction tasks can call these utilities, but should treat the package as internal and subject to change between patch levels. Developers should confirm signatures directly from the database before invoking these routines from custom code.