Search Results geocode_upgrade

Overview

APPS.PAY_US_GEOCODE_ENGINE_PKG is a United States–specific payroll utility package in Oracle E-Business Suite, shipped under the APPS schema with AUTHID CURRENT_USER. Its documented purpose, taken from the package header, is to "run the geocode upgrade" for Oracle Payroll (US legislation). Geocoding in this context refers to the derivation and maintenance of geographic reference data — latitude/longitude and related addressing attributes — associated with employee and location addresses held in Oracle HRMS and Payroll. Such data underpins US payroll processes that depend on accurate jurisdictional placement, most notably city and local tax assignment.

The package is an internal engine rather than a public API. It is classified as OTHER in the ETRM metadata, indicating that it is not published for general customer extension use and that its interface may change between releases. It contains a single documented entry point and is referenced by no other packages, confirming it operates as a terminal component invoked directly rather than as a shared library.

Readers searching for GPS-coordinate retrieval by IMEI should note a definitional distinction: this package neither consumes IMEI identifiers nor interfaces with mobile device telemetry. It reconciles and upgrades geocode data already stored within the EBS data model for US payroll purposes.

Key Procedures and Functions

• GEOCODE_UPGRADE — The sole documented procedure. It follows the standard concurrent-program signature convention, accepting errors through an OUT error buffer parameter and returning status via an OUT numeric return code, together with a mode parameter that selects the operating behavior of the upgrade run. Its function is to execute the geocode upgrade process, migrating or refreshing geographic reference information so that payroll address and tax data align with the current geocode rules and structures. The presence of the p_mode argument indicates the routine supports more than one processing path — typically a validation or report-only pass versus an applied update pass — which is a common pattern for patch and upgrade utilities that must be previewed before committing changes.

Tables Accessed

The documented table references reflect three functional areas:

• Address and location master data: PER_ADDRESSES and HR_LOCATIONS_ALL supply the address records whose geographic attributes are evaluated; PER_ALL_ASSIGNMENTS_F supplies assignment context for employees whose payroll jurisdiction may be affected.
• Geocode and tax reference data: PAY_US_MODIFIED_GEOCODES holds geocode records altered by prior processing; PAY_US_EMP_CITY_TAX_RULES_F holds employee city tax rules; PAY_US_STATES provides state-level reference information used in jurisdiction resolution.
• Concurrent and upgrade infrastructure: FND_CONCURRENT_REQUESTS, PAY_ACTION_CONTEXTS, FF_CONTEXTS, PAY_PATCH_STATUS, and PAY_PATCH_STATUS_S support run-time context, patch state tracking, and idempotent execution — ensuring the upgrade is applied only to data requiring it. DUAL is used for single-row control queries.

Usage Notes

PAY_US_GEOCODE_ENGINE_PKG is intended for invocation through a concurrent program, consistent with its error-buffer/return-code parameter shape and its use of FND_CONCURRENT_REQUESTS and PAY_PATCH_STATUS. It is typically triggered as part of a payroll legislative patch or upgrade cycle, or manually by a system administrator when geocode data must be refreshed. Because the package is classified OTHER and is referenced by no other packages, it should not be treated as a stable integration point: custom code should not call GEOCODE_UPGRADE directly. Where a business requirement concerns device-derived coordinates, this package is not the relevant mechanism, and the requirement should be traced to the appropriate external system rather than to Oracle Payroll geocoding.