Search Results per_add_shd




Overview
Explore in AI Chat

Overview

APPS.PER_ADD_SHD is a shadow (suffix _SHD) PL/SQL package in the Oracle E-Business Suite Human Resources (PER) schema. It is declared AUTHID CURRENT_USER and, as the header comment $Header: peaddrhi.pkh 120.1 2011/11/15 11:34:33 sidsaxen ship $ indicates, it belongs to the address (ADDR) family of HR APIs generated from the corresponding table handler. Its central purpose is to expose the global record type g_rec_type, which mirrors the structure of the PER_ADDRESSES entity — the primary address records for persons and organizations in Oracle HRMS.

In the 12.1.1 and 12.2.2 code lines, the shadow package serves as the shared, non-business-logic container that the main public address API (PER_ADDRESSES_API and related packages) references for its data structures and for a small set of utility and state-inspection routines. It does not itself implement the core insert/update/delete business rules; instead it supplies the record shape, helper conversions, and status flags that the public API relies upon.

Key Procedures and Functions

The ETRM metadata documents six callable members. Their purposes are:

  • RETURN_API_DML_STATUS — Returns the current status of DML activity performed through the API, allowing callers to determine whether the last API operation resulted in a database change.
  • CONSTRAINT_ERROR — Centralised error-raising routine for constraint violations encountered while processing address records, mapping Oracle errors to HRMS messages.
  • API_UPDATING — Indicates whether an API-driven update is currently in progress, used to guard against conflicting direct table manipulation.
  • LCK — Locking routine that secures a row in the address entity to prevent concurrent modification during an API transaction.
  • CONVERT_ARGS — Argument conversion helper that translates and normalises incoming parameters (for example, locale or attribute values) before they are applied to the record.
  • DERIVE_LOCALE — Derives the locale that governs address formatting and validation, populating the derived_locale element of the record type.

No parameter signatures are published in the ETRM extract, and none are asserted here.

Tables Accessed

Three tables are referenced through APPS synonyms:

  • PER_ADDRESSES — The principal address table; the record type maps its columns (address_id, person_id, date_from/date_to, address lines, regions, telephone numbers, and the addr_attribute1..17 descriptive flexfield columns).
  • ALL_CONSTRAINTS — Consulted by the constraint-related logic to identify and interpret address constraints at runtime.
  • DBMS_DESCRIBE — Used for runtime introspection of stored program arguments, supporting the argument-conversion and validation routines.

Usage Notes

PER_ADD_SHD is not intended for direct invocation by end users. It is referenced by nine other packages, and is typically reached indirectly when HR forms, the Person/Address maintenance concurrent programs, or custom PL/SQL integrations call the public address API to create, update, or query person addresses. Developers writing custom code against HRMS addresses should call the public API layer; the shadow package provides the supporting record type, locale derivation, locking, and status checks that make those calls consistent and safe. Because the package is AUTHID CURRENT_USER, it executes with the privileges of the calling schema, so appropriate grants on PER_ADDRESSES and related objects are required.