Search Results payment_extract




Overview
Explore in AI Chat

Overview

APPS.PAY_CA_PAYREG_EXTRACT_PKG is an Oracle E-Business Suite payroll package body that supports the Canadian Payment Register extraction process. Its stated purpose, per the package header, is to generate a payment report output file in a user-specified format, with HTML and CSV as the initially supported output formats. The package therefore sits at the boundary between Oracle Payroll's payment data model and the reporting/export layer used by Canadian payroll operations. It is classified under ETRM as OTHER rather than as a public API, meaning it is an internal implementation package rather than a supported programmatic interface. The header version metadata (pycaprpe.pkb 120.9, last modified 2011/10/21) indicates the package has been maintained across the 11i and R12 release streams and is present in both 12.1.1 and 12.2.2 environments.

Key Procedures and Functions

ETRM documents a single procedure or function for this package: PAYMENT_EXTRACT.

  • PAYMENT_EXTRACT — The entry point that produces the payment register extract output in the requested user format. Based on the package description, it assembles payment-related data and emits the result as an HTML or CSV file. The change history shows the output logic was refined repeatedly, including a fix that formatted the Pay Date using fnd_date.date_to_canonical, and a change that printed the Total Payment Amount immediately below the Amount field. No parameter lists are documented in the ETRM metadata and none are asserted here.

The package body additionally contains private cursors referenced in the change log, including c_personal_paymeth_info (modified for UTF8 requirements) and c_assignments (modified to correct a join involving consolidation_set_id). These are internal implementation constructs and are not exposed as documented procedures.

Tables Accessed

The package reads from a broad set of Payroll and FND tables via APPS synonyms. The payroll core tables supply assignment, element, and payment context: PAY_ASSIGNMENT_ACTIONS and PAY_ACTION_INTERLOCKS provide payroll action and process-interlock information; PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F, and PAY_INPUT_VALUES_F supply element entry and input value detail used to derive payment amounts. Payment method and type configuration is drawn from PAY_ORG_PAYMENT_METHODS_F, PAY_ORG_PAYMENT_METHODS_F_TL, PAY_PAYMENT_TYPES, PAY_PAYMENT_TYPES_TL, and PAY_EXTERNAL_ACCOUNTS. Organization and payroll definitions come from HR_ALL_ORGANIZATION_UNITS_TL and PAY_ALL_PAYROLLS_F. FND_LOOKUP_VALUES supplies lookup translations used when rendering output values. Because the package produces an extract, these tables are primarily read; the package's role is reporting rather than transactional update of payroll data.

Usage Notes

PAY_CA_PAYREG_EXTRACT_PKG is not referenced by any other documented package, indicating it is invoked at the top of a call stack rather than being called internally by other PL/SQL units. In practice, such packages are typically executed from a concurrent program registered in Oracle Payroll or from a client-side reporting flow that requests a specific output format. The format-sensitive design (HTML, CSV) means callers must supply the desired output format at invocation. Customizations should avoid direct calls into this package where a supported API exists, since it is classified as OTHER and its internal cursors and interfaces may change between patch levels. When troubleshooting the "payment_extract" search term, this object is the relevant Payroll source for Canadian payment register output generation, and its behavior is best traced through the concurrent program definition that drives it and through the private cursors identified in the change history.