Search Results fps_hash

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

Overview

PAY_GB_FPS_NI_AND_OTHERS is a United Kingdom-specific Oracle Payroll package that supports Real Time Information (RTI) reporting under HM Revenue & Customs' Full Payment Submission (FPS) regime. The package is delivered under the APPS schema and is classified as an OTHER API within the ETRM repository. Its stated purpose is to fetch live data and National Insurance (NI) balances required by FPS RTI processes, including the aggregation of employee and employer NI contributions and the preparation of BACS-related submission data.

The package was created in May 2012, coinciding with the introduction of RTI in the United Kingdom, and the version history embedded in the header demonstrates an intense period of iterative correction through 2012 and into early 2013. Changes addressed assignment action logic, BACS changes, duplicate Rank 1 handling, retrieval of correct NI reporting flags, period-level NI Arable values, and the relocation of random digit generation from FETCH_RANDOM_DIGIT_BACS into FPS_BACS_PREPROCESS to avoid premature hash code generation and insertion into PAY_GB_FPS_DETAILS. The package is UK legislative payroll code and should not be modified or customised without Oracle guidance.

Key Procedures and Functions

• GET_NI_BALANCES_FOR_ASG — Retrieves NI balances for a given assignment, forming the core balance extraction routine used by the FPS process.
• GET_NI_BAL_PAYE_AGGR_FOR_ASG — Returns aggregated NI and PAYE balance values for an assignment, supporting the aggregated FPS case handling introduced in version 115.3.
• GET_NI_ONLY_AGG_BAL_FOR_ASG — Retrieves NI-only aggregated balances for an assignment.
• GET_NI_ONLY_AGG_BAL_SUM_ASG — Produces a summed NI-only aggregated balance for an assignment.
• GET_NI_ONLY_BAL_RTI_RPT — Supplies NI-only balance figures specifically formatted for RTI reporting.
• FPS_BACS_SHA_256 — Generates a SHA-256 hash value used in BACS submission processing.
• BACS_RANDOM_DIGIT — Produces random digit values required by BACS processing.
• FETCH_RANDOM_DIGIT_BACS — Fetches the random digit BACS data; random digit generation was later migrated to FPS_BACS_PREPROCESS.
• FETCH_HASH_FPS_ASG — Fetches hash values at assignment level for FPS purposes.
• FETCH_HASH_FPS_PER — Fetches hash values at person level for FPS purposes.
• FPS_HASH — General FPS hashing routine supporting submission integrity.
• FPS_BACS_PREPROCESS — Pre-processes BACS data prior to FPS submission, including random digit generation and BACS code creation based on profile settings configurable at tax reference level.
• FPS_ROLLBACK — Rolls back FPS processing changes, added in version 115.1.
• RESTORED — Restoration routine associated with rollback handling.

Tables Accessed

The package reads and writes the principal UK payroll and RTI staging tables. PAY_GB_FPS_DETAILS and PAY_GB_BACS_FPS hold FPS submission and BACS-specific data. PAY_ASSIGNMENT_ACTIONS, PAY_PAYROLL_ACTIONS, and PAY_ACTION_INFORMATION supply assignment action and payroll action context, including action information values retrieved using child assignment action identifiers. PAY_BALANCE_TYPES, PAY_DEFINED_BALANCES, PAY_BALANCE_FEEDS_F, and PAY_BALANCE_DIMENSIONS provide balance definitions and feeds underpinning NI and PAYE balance retrieval — this is the area referenced by the search term "get_defined_balance_id". PAY_EXTERNAL_ACCOUNTS, PAY_PAYMENT_TYPES, PAY_ORG_PAYMENT_METHODS_F, and PAY_PERSONAL_PAYMENT_METHODS_F support BACS payment routing. HR_SOFT_CODING_KEYFLEX and PAY_ACTION_INTERLOCKS are consulted for costing and process linking respectively.

Usage Notes

The package is an internal component of the UK payroll FPS/RTI flow rather than a general-purpose API. It is invoked during the FPS submission process and its associated BACS pre-processing and rollback activities, typically through Oracle Payroll concurrent programs and the standard RTI processing chain. One other package in the ETRM repository references it, confirming its role as a supporting module rather than a top-level entry point. Custom code should not call these procedures directly, as the interface is not published as a supported API; the documented procedures are provided for reference and troubleshooting. The reference to PAY_DEFINED_BALANCES and PAY_BALANCE_TYPES indicates the "get_defined_balance_id" lookup pattern is used internally to resolve balance identifiers before balance values are fetched, and any investigation of that search term should focus on the balance retrieval functions listed above.