Search Results pay_apm_shd




Overview
Explore in AI Chat

Overview

PAY_APM_SHD is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite 12.1.1 and 12.2.2. The "SHD" suffix in Oracle EBS naming conventions typically denotes a shadow or shadowing package associated with a corresponding base package or table, most commonly related to tables that carry a _SHD suffix used for auditing, tracking, or shadow record maintenance. In the context of the APM (Application Process Manager / process module) area of Oracle Payroll, this package serves as a supporting utility for maintaining shadow-level tracking of process module activity and target information.

The package is closely tied to the payroll process module framework through its reference to PAY_AU_PROCESS_MODULES. It provides standard date-tracking and concurrency-control helper functions that are common in Oracle Application Object Library and payroll shadow packages, including row-level locking, API DML status reporting, and argument conversion utilities.

According to the ETRM documentation, PAY_APM_SHD is not referenced by any database object; it is referenced by four other packages, indicating it operates as a shared utility invoked by higher-level payroll or process module APIs rather than being called directly by forms or concurrent programs.

Key Procedures and Functions

The package exposes five documented procedures and functions:

  • RETURN_API_DML_STATUS — Returns the DML status of the most recent API operation, allowing the calling package to determine whether an insert, update, or delete succeeded or failed. This is a standard Oracle AOL API convention for propagating DML results.
  • CONSTRAINT_ERROR — Handles or signals constraint validation errors raised during package processing, providing a controlled mechanism for error reporting when a database constraint is violated.
  • API_UPDATING — Determines or flags whether an API-driven update is currently in progress, used to guard against conflicting concurrent modifications.
  • LCK — Implements row-level locking, typically performed via SELECT ... FOR UPDATE, to serialize access to shadow records and prevent lost updates.
  • CONVERT_ARGS — Converts or normalizes argument values, commonly transforming internal IDs and codes into the format expected by downstream process module routines.

The ETRM metadata does not document explicit parameter lists for these routines, so callers should consult the package source in the EBS instance for exact signatures.

Tables Accessed

The package reads and writes through the following APPS synonyms:

  • PAY_AU_PROCESS_MODULES — The primary business table. This holds Australia (AU) payroll process module definitions and their associated process metadata. PAY_APM_SHD supports keeping shadow records for this table in sync, including target process module identifiers.
  • ALL_CONSTRAINTS — Queried to validate constraint definitions before or during DML. This supports the CONSTRAINT_ERROR logic by allowing the package to confirm which constraints apply to the shadow table before raising or interpreting an error.

Additional referenced objects include FND_MESSAGE (for message retrieval), HR_API and HR_UTILITY (shared HRMS utility routines), STANDARD (for base PL/SQL functions), and the PAY_APM_SHD package itself, reflecting self-referencing calls between procedures.

Usage Notes

PAY_APM_SHD is not invoked directly by end users. It is called by four other APPS packages that manage payroll process module processing and shadow table maintenance. Typical invocation patterns include:

  • Higher-level payroll process module APIs that call LCK to serialize access before writing shadow records.
  • Routines that use CONVERT_ARGS to normalize identifiers before passing them to PAY_AU_PROCESS_MODULES.
  • Callers that invoke API_UPDATING and RETURN_API_DML_STATUS to detect and report on concurrent API updates.

Because the package is marked VALID and is not referenced by any database object other than its callers, it can be treated as an internal implementation detail. The package is not intended for direct inclusion in customer extensions. Customizations affecting its behavior should be made through the public APIs of the calling packages rather than by modifying PAY_APM_SHD, preserving Oracle supportability across 12.1.1 and 12.2.2.