Search Results p_province




Overview

The APPS.PAY_CA_EMP_ADDRESS_DTLS package body is a Canadian localization wrapper that provides Oracle Payroll and Human Resources modules with a simplified interface for retrieving an employee's primary address in a formatted, Canada-specific structure. It is a thin abstraction layer built on top of the PAY_CA_RL1_REG package, which encapsulates the underlying Canadian regional (RL1) legislative logic. Rather than forcing calling code to understand the internal record structure of the RL1 primary address object, this wrapper exposes the address fields as discrete, individually named OUT parameters that map directly to the fields an application or report would need to render.

In the Oracle EBS 12.1.1 and 12.2.2 environments, this package sits within the APPS schema alongside other PAY_CA (Canadian Payroll) objects. Its role is one of data marshalling: it invokes the RL1 primary-address retrieval, normalizes each element against NULL, and returns them in a predictable, display-ready form. The header comment referencing version 120.1 and the file paycaaddwrpr.pkb confirms this is a wrapper module, and the naming convention (wrpr) reinforces that it does not itself contain business rules but delegates to regional logic.

Key Procedures and Functions

  • GET_EMP_ADDRESS — The sole documented public function. It accepts a person identifier as input and returns a numeric status value (0 on success). Through a series of OUT parameters, it returns the employee's primary address broken into discrete components: address lines 1 through 3, city, postal code, country, and — of particular relevance to the searching user — p_province, which carries the Canadian province value drawn from the underlying RL1 address record.

The function body declares a local variable of type PAY_CA_RL1_REG.primaryaddress and populates it by calling PAY_CA_RL1_REG.get_primary_address, passing the person identifier and the current system date (SYSDATE). Each element of the returned record is then assigned to the corresponding OUT parameter, wrapped in NVL(...) with a single-space default so that callers never receive a NULL string. Address lines 2 and 3 additionally undergo RTRIM(LTRIM(...)) whitespace trimming. The p_province parameter maps directly to addr.province, and p_country is populated from addr.addr_line_5, reflecting the regional record's field layout.

Tables Accessed

The documented metadata does not list any tables accessed directly via APPS synonyms. Instead, all data retrieval is delegated to the PAY_CA_RL1_REG package, which in turn reads the underlying HR/Payroll address tables (such as PER_ADDRESSES and the associated address-style and geography tables). Because this package only calls get_primary_address as an effective date of SYSDATE, it performs no direct DML and exposes no table dependencies of its own. The absence of direct table references confirms its role as a pass-through wrapper.

Usage Notes

  • The ETRM metadata records that this package is referenced by ten other packages, indicating widespread internal reuse across the Canadian payroll and HR object set.
  • It is typically invoked from payroll calculation routines, HR forms, and reporting or letter-generation processes that require a neatly formatted, country-specific employee address.
  • Custom code requiring Canadian employee address details — for example, producing T4 slips or provincial remittance reports — can call GET_EMP_ADDRESS directly, using p_province to capture the province for taxation and jurisdiction purposes.
  • Callers should expect every returned string to be non-NULL (defaulted to a space) and should check the numeric return value for success. Because the effective date is hard-coded to SYSDATE, the function always returns the address valid on the current date.