Search Results hr_hk_person_address_api




Overview
Explore in AI Chat

Overview

The APPS.HR_HK_PERSON_ADDRESS_API package is a public, licensed Oracle E-Business Suite API that manages person address records for the Hong Kong (HK) localization within Oracle Human Resources. Its @rep:displayname is defined as "Person Address for Hong Kong," and the package operates under the PER product scope with AUTHID CURRENT_USER privileges. It is classified as an API in the ETRM 12.2.2 repository and is owned by the APPS schema.

The primary business purpose of this package is to abstract the Hong Kong–specific address style so that callers do not need to supply localization-specific attributes directly. Internally, the creation routine delegates to the generic create_person_address API, passing the Hong Kong value for address style. This ensures that addresses created through the API conform to the format required for Hong Kong, including county and other localization-specific validations. The source header (hrhkwrpa.pkh, version 120.2, dated 2011/12/20) confirms this is a mature, pre-existing localization package that remains available across both 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

Two documented procedures are exposed by this package:

  • CREATE_HK_PERSON_ADDRESS — Creates a new address record for a particular person in the Hong Kong address style. It validates that a valid person exists on the start date of the address and that the ADDRESS_TYPE lookup has been defined via QuickCodes. Notable parameters include p_validate (perform validation only without modifying the database), p_effective_date (determines when the DateTrack operation takes effect), p_pradd_ovlapval_override (indicates and validates whether a primary address overlap exists), p_validate_county (validates county details, defaulting to true), and p_person_id (identifies the person for whom the address is created). On success, a new address is inserted; on failure, no address is created and an error is raised.
  • UPDATE_HK_PERSON_ADDRESS — Updates an existing Hong Kong person address record. It follows the same DateTrack and validation conventions as the create routine, supporting the p_validate and p_effective_date parameters so that changes can be previewed or applied with correct effective dating.

Both procedures participate in Oracle HRMS DateTrack, meaning historical and future-dated address changes are managed consistently with other person datetracked entities.

Tables Accessed

The package accesses the PER_ADDRESSES table through an APPS synonym. This is the primary and only documented table reference. PER_ADDRESSES stores person address records, and the API inserts new rows (via CREATE_HK_PERSON_ADDRESS) and modifies existing rows (via UPDATE_HK_PERSON_ADDRESS) while applying DateTrack logic so that effective-dated history is preserved. Because the package has no dependencies from other packages (Referenced by 0 other packages), it functions as a leaf-level localization API rather than a shared foundation component.

Usage Notes

The package is typically invoked from Oracle Forms (the Hong Kong person address maintenance form), from concurrent programs performing data loads or migrations, and from custom PL/SQL code that needs to create or maintain Hong Kong person addresses programmatically. Callers should always supply p_validate = TRUE first to confirm that person, address type, county, and primary-overlap validations pass before committing changes. Because the API enforces the HK address style, it should be used in preference to the generic address API when processing Hong Kong persons, ensuring localization-compliant data and correct DateTrack behavior. The p_effective_date parameter must reflect the intended date on which the address change takes effect, and any custom integration should account for the error raised on validation failure.