Search Results set_extract_globals

Overview

APPS.PQP_GB_CPX_EXTRACT_FUNCTIONS is a payroll extraction utility package body shipped as part of the Oracle HRMS/Payroll module in Oracle E-Business Suite 12.1.1 and 12.2.2. Its principal purpose is to support the generation of statutory and legislative extract files for the United Kingdom, specifically the legislative payroll data required for HM Revenue & Customs reporting (historically associated with the Inland Revenue and the "CPX" — Contractor/Contracted-out Payment Extract — family of outputs). The package encapsulates the business logic needed to assemble, derive, and format the values that appear in those extract records from the underlying payroll run results and balance data.

The package body (source file pqpgbcpx.pkb, version 120.8.12010000.3) is owned by APPS and classified as OTHER in the ETRM repository. It exposes 63 documented procedures and functions and, notably, is not referenced by any other database package, indicating it is called directly by a client layer — most commonly a concurrent program or a report — rather than being reused internally by the payroll engine.

Key Procedures and Functions

The documented entry points fall into several functional groups:

• Global initialization: SET_EXTRACT_GLOBALS and SET_PERIODIC_RUN_DATES establish the session-level context (extract parameters, payroll period boundaries, and run dates) used by the remaining calls. This is the anchor point most commonly searched for, since it must execute before any data-fetching routine.
• Identifier resolution: GET_INPUT_VALUE_ID, GET_PAY_BAL_ID, GET_UDT_ID, GET_USER_COLUMN_ID, GET_USER_COLUMN_NAME, and GET_PAY_ELE_IDS_FROM_BAL translate human-readable or business identifiers into the internal surrogate keys used by the payroll data model.
• Balance and remuneration retrieval: GET_BALANCE_VALUE, GET_ASG_BAL_VALUE, GET_PERSON_BAL_VALUE, and GET_REMUNERATION_FROM_BAL return aggregated or point-in-time amounts for an assignment or person, and are the core value suppliers for the extract layout.
• Element entry interrogation: GET_ELE_ENTRY_VALUE, GET_NI_CONT_OUT_ELE_DETAILS, and FETCH_CPX_UDT_DETAILS read element entry and user-defined table data relevant to National Insurance and contracted-out schemes.
• Personal and employment attributes: CHK_IS_EMPLOYEE_A_STARTER, GET_ASG_EMPLOYMENT_CAT, GET_PART_TIME_INDICATOR, GET_MARITAL_STATUS, and GET_NI_INDICATOR classify the employee for statutory reporting flags.
• Debugging utilities: three overloaded DEBUG procedures emit trace messages (VARCHAR2, NUMBER, and DATE variants) via hr_utility.TRACE and hr_utility.set_location, supporting development and diagnosis.

Tables Accessed

The package reads through APPS synonyms across the payroll and benefits schemas. Balance and feed data come from PAY_BALANCE_TYPES and PAY_BALANCE_FEEDS_F. Element definitions are sourced from PAY_ELEMENT_TYPES_F, PAY_ELEMENT_CLASSIFICATIONS, PAY_ELEMENT_LINKS_F, PAY_INPUT_VALUES_F, and PAY_ELEMENT_ENTRIES_F/PAY_ELEMENT_ENTRY_VALUES_F. Payroll execution context is derived from PAY_RUN_RESULTS, PAY_PAYROLL_ACTIONS, and PAY_ASSIGNMENT_ACTIONS. Benefits extract metadata is read from BEN_EXT_DFN, BEN_EXT_RCD, BEN_EXT_RCD_IN_FILE, and BEN_EXT_RSLT_DTL. All access is effectively read-only for extraction purposes.

Usage Notes

The package is intended to be invoked in a defined sequence: global setup first (SET_EXTRACT_GLOBALS, SET_PERIODIC_RUN_DATES), followed by the retrieval routines that supply each extract field. It is typically driven by a concurrent program or a custom PL/SQL wrapper developed for UK legislative reporting, and is not called by other seeded packages. Because it depends on APPS synonyms and HR_UTILITY, it must run within an APPS-initialized session with FND global context set. Debug output can be enabled for troubleshooting by exercising the DEBUG overloads.