Search Results compare_location_existing

Overview

The APPS.ARH_ADDR_PKG package body encapsulates the address and location validation logic used throughout the Oracle Receivables and Oracle Trading Community Architecture (TCA) modules in Oracle E-Business Suite 12.1.1 and 12.2.2. Its principal business function is to validate, format, and maintain address data associated with customers, sites, and locations before that data is persisted to the TCA registry tables. The package acts as a gatekeeper: it verifies uniqueness of address elements, enforces transaction-level restrictions on the modification of locations already referenced on printed transactions, and produces display-ready formatted address strings for reports, documents, and concurrent output. The body is registered under the APPS schema and is classified as an "OTHER" API, meaning it is intended for internal use by EBS forms, concurrent programs, and other PL/SQL packages rather than as a formally published public API. The header comment indicates a last revision of version 120.20, dated 2007, with several procedures tied to specific bug fixes (#4037614 and #4058639).

Key Procedures and Functions

The package exposes approximately twenty documented procedures and functions:

• FORMAT_ADDRESS / ARXTW_FORMAT_ADDRESS / FORMAT_LAST_ADDRESS_LINE — Return a single concatenated string of address segments, applying a given address style, inserting line breaks, and merging segments with joint characters so the result fits within a supplied box dimension.
• CHECK_UNIQUE_ORIG_SYSTEM_REF / CHECK_UNIQUE_EDI_LOCATION — Validate that an originating system reference or an EDI location identifier is unique before insert or update.
• IDENTIFYING_ADDRESS_FLAG / UPDATE_SITE_USE_FLAG — Determine and maintain flags that identify an address and control the state of a customer site use.
• INSERT_ROW / UPDATE_ROW / DELETE_CUSTOMER_ALT_NAMES — Perform the core DML operations on location and associated customer records, including removal of alternative names.
• LOCATION_EXISTS / TRANSACTION_EXISTS / TRANSACTION_MORG_EXISTS / CHECK_TRAN_FOR_ALL_ACCTS — Existence checks that confirm whether a location or transaction reference exists for a location, an operating unit, or across all accounts.
• GET_LOCATION_DATA — Retrieve the current location record for a given location identifier.
• COMPARE_LOCATION_EXISTING — The procedure referenced in the search. It accepts a location identifier and an input location record, and returns the existing location record together with a status flag indicating whether the supplied data differs from the stored data. Its documented contract returns 'Y' when the input differs from the existing location, 'N' when they are equal, and 'X' when no existing location is found.
• CHECK_PRINTED_TRX — Prevents the update of a physical location once a transaction has already been printed that references that location.
• CHECK_ADDR_MODIF_ALLOWED — Consults system options to determine whether modification of an address is permitted.
• THE_AR_MISS_CHAR / THE_AR_NULL_CHAR — Accessors that return the package-level constants used to represent missing and null characters during address comparison.

Tables Accessed

The package reads and writes the following tables through APPS synonyms. Customer and site data are maintained in HZ_CUST_ACCT_SITES, HZ_CUST_ACCT_SITES_ALL, HZ_CUST_SITE_USES, HZ_CUST_SITE_USES_ALL, HZ_PARTY_SITES, HZ_LOCATIONS, and HZ_LOC_ASSIGNMENTS; the _ALL variants support multi-org operating unit partitioning. Transaction-related validations reference RA_CUSTOMER_TRX, RA_CUSTOMER_TRX_ALL, RA_CUSTOMER_TRX_LINES, RA_CUSTOMER_TRX_LINES_ALL, and RA_CUST_TRX_TYPES. System options governing address modification are read from AR_SYSTEM_PARAMETERS and AR_SYSTEM_PARAMETERS_ALL. Location identification keys are sourced from HR_LOCATIONS_S.

Usage Notes

ARH_ADDR_PKG is not a public API. It is invoked indirectly by EBS forms such as the Customer Standard and Transactions windows, by concurrent programs that format and print addresses, and by 23 other packages that depend on its validation routines. Because its procedures are internal, customizations should call the supported TCA public APIs (for example, HZ_LOCATION_V2PUB) rather than this package directly. The compare_location_existing procedure is specifically useful for detecting redundant address updates, allowing callers to skip writes when the incoming record matches the stored location and to handle the "no existing location" case explicitly.