CU_READ_RGDIR — Read the Payroll Result Directory for an Employee
Reads the RGDIR payroll-result directory for a personnel number so payroll code can identify which payroll results exist, their sequence numbers, period/status indicators, and retroactive relationships before reading the payroll cluster itself. It does not return the complete payroll result; functions such as PYXX_READ_PAYROLL_RESULT use the selected directory entry to read cluster content.
High-confidence practitioner reference for CU_READ_RGDIR, built around SAP-documented usage or long-standing standard application semantics. It covers safe parameters, failure interpretation, S/4HANA direction, ownership, and the evidence path without inventing release-specific interface fields.
Published 20 Sept 2026· 632 words
What it does
Reads the RGDIR payroll-result directory for a personnel number so payroll code can identify which payroll results exist, their sequence numbers, period/status indicators, and retroactive relationships before reading the payroll cluster itself. It does not return the complete payroll result; functions such as PYXX_READ_PAYROLL_RESULT use the selected directory entry to read cluster content. The function should be used within the business framework that owns the object—Workflow, HCM, FI tax/period logic, SD document flow, or material master conversion—rather than as a shortcut around that framework's validations and persistence rules.
Important parameters
The interface notes focus on the business-critical inputs and outputs. Confirm exact DDIC types, optional flags, tables parameters, and release-specific additions in SE37 before implementation.
- PERSNR supplies the employee and IN_RGDIR returns directory entries; payroll country/cluster context and sequence number are used for follow-on reads.
- Use the application's internal object keys and DDIC types; external/display formatting should be converted before the call where required.
- Retain returned IDs, message tables, sequence numbers, period context, or calculation detail so the result can be proved later in standard transactions/reports.
Exceptions
Treat an empty result, application rejection, workflow state problem, or missing customizing separately from a technical runtime failure. Do not convert every nonzero SY-SUBRC into a generic 'function failed' message that loses the actionable cause.
- No payroll result/directory, cluster authorization, archived/inconsistent cluster entries, or selecting the wrong result when retro payroll creates several entries are the main risks.
- Check all declared exceptions and any BAPI/WAPI-style return table immediately.
- For functions that modify business or workflow state, verify the resulting object in its standard application instead of trusting the call return alone.
How to call it safely
Resolve the exact business object and effective date/status first. Call with narrowly scoped data, validate all return/exception information, respect lock and LUW boundaries, and prove the result in the owning application. Never directly update the underlying HR, workflow, tax, sales-flow, or material tables to compensate for a failed standard function call.
ECC vs S/4HANA
Classic payroll cluster/RGDIR processing remains relevant in SAP HCM for S/4HANA payroll deployments; Employee Central Payroll uses the same ABAP payroll foundation. Availability in an S/4HANA on-premise or private-cloud system does not automatically make the function a released ABAP Cloud interface. Where SAP provides released business APIs, workflow actions, CDS views, or service-layer calculations, prefer those for new clean-core extensions.
Common pitfalls
- Calling the function with display-formatted keys instead of the internal object key expected by the application framework.
- Ignoring validity dates, current object/work-item/document status, or retroactive history and therefore selecting the wrong business record.
- Swallowing returned messages/exceptions and then compensating with direct table updates.
- Assuming successful technical execution proves the downstream workflow, posting, payroll, tax, or document process has completed.
- Reusing a classic on-stack function in a side-by-side/cloud extension without checking whether SAP exposes a released successor API.
Whose problem this is
ABAP owns correct invocation and error handling. Workflow administrators own event/linkage and work-item configuration; HCM functional/payroll teams own infotype, OM and payroll semantics; Finance owns period/tax configuration; SD owns document-flow/payment-term behavior; MM owns material unit master data. Integration/Basis joins when the failure crosses RFC, queue, or platform boundaries.
Related SAP objects
Reviewed pages this object connects to in the ERPClimb knowledge graph.
Source: ERPClimb — https://erpclimb.com/sap-function-modules/cu-read-rgdirERPClimb is an independent platform and is not affiliated with SAP SE. Reference pages are written and reviewed by SAP consultants for learning and troubleshooting.