Search Results get_custom_xml_routine




Overview
Explore in AI Chat

Overview

PAY_CA_RULES is a Canadian payroll legislation utility package in the Oracle E-Business Suite Payroll module. It is owned by the APPS schema, declared with AUTHID CURRENT_USER, and supports the tax, jurisdictional, payment, and payslip-formatting rules that apply to Canadian payroll processing. Within Oracle EBS 12.1.1 and 12.2.2, this package acts as a shared services layer invoked from payroll run processing, Canadian payslip and deposit advice generation, and payment file production such as Chequewriter and third-party Chequewriter output.

The package metadata available through ETRM does not expose individual signatures, so this summary limits itself to the documented procedure and function names and their apparent purposes. The package is classified as OTHER, and it is not referenced by any other database package, meaning it is typically called directly from forms, concurrent programs, or custom extensions rather than from other PL/SQL package bodies.

Key Procedures and Functions

  • GET_DEFAULT_JURISDICTION — Returns the default tax jurisdiction for a payroll assignment action and employee context.
  • GET_DYNAMIC_TAX_UNIT — Resolves the applicable tax unit dynamically, supporting multi-GRE (Government Reporting Entity) processing.
  • GET_MULTI_TAX_UNIT_PAY_FLAG — Retrieves the Payroll Archiver Level setting from the business group to determine how a payroll run should process multiple tax units.
  • ADD_CUSTOM_XML — Introduced in 2005 and enhanced in 2010 (Bug 9445414 and Bug 9692321), this procedure injects custom XML content into Canadian payslip and deposit advice output. Both a parameterized form and a parameter-less form exist.
  • CONVERT_NUMBER — Converts numeric values, generally for display in payslip or advice text.
  • GET_WORD_VALUE and CF_WORD_AMOUNTFORMULA — Produce word-form amounts, typically for cheques and printed payment documents where an amount must be expressed in words.
  • WORK_SCHEDULE_TOTAL_HOURS — Calculates total working hours based on the work schedule; an IN OUT flag was added in 2009 (Bug 8459792) to indicate whether a schedule was found.
  • GET_FILE_CREATION_NO — Added in 2006 (Bug 9692321 lineage), it derives a file creation number for outgoing payment files.
  • PAYSLIP_RANGE_CURSOR — Provides the cursor used to enumerate payslip records within a specified range.
  • GET_TOKEN_NAMES — Supplies the token names available for substitution in payslip or advice templates.
  • GET_CUSTOM_XML_ROUTINE — Added in 2012 (Bug 13969858), it identifies the routine responsible for generating custom XML content.
  • GET_PAYSLIP_SORT_ORDER1, 2, 3 — Added in 2013 (Bug 16686045) to correctly sort Canadian Deposit Advice (XML) output.

Tables Accessed

The package reads from a broad set of Payroll and HR tables through APPS synonyms. HR_ORGANIZATION_INFORMATION, HR_SOFT_CODING_KEYFLEX, and FND_TERRITORIES provide organizational, key flexfield, and territory data. PAY_ACTION_INFORMATION, PAY_ACTION_INTERLOCKS, PAY_ASSIGNMENT_ACTIONS, PAY_PAYROLL_ACTIONS, and PAY_RUN_TYPES_F drive payroll run and action processing. PAY_LEGISLATION_RULES supplies Canadian legislative rule definitions. PAY_EXTERNAL_ACCOUNTS, PAY_ORG_PAYMENT_METHODS_F, and PAY_PAYMENT_TYPES support payment file generation. PAY_USER_COLUMNS and PAY_USER_TABLES hold user-defined values used in payslip content. FND_SESSIONS provides session context.

Usage Notes

PAY_CA_RULES is invoked during Canadian payroll run processing and when generating cheques, deposit advices, and XML payslips. The ADD_CUSTOM_XML and GET_CUSTOM_XML_ROUTINE procedures are the entry points most commonly extended by customers wishing to inject custom content into payslip or deposit advice XML. Because no documented package references PAY_CA_RULES, callers are typically Oracle Forms, concurrent programs, or custom PL/SQL code. The package relies on session context, so it must be called within an initialized Oracle EBS session. Upgrades between 12.1.1 and 12.2.2 should verify custom calls against the current version, as several documented changes modified procedure signatures.