Search Results pay_batch_control_totals_ovn




Overview

PAY_BCT_SHD is a shadow (history) package in the Oracle EBS Payroll (PAY) schema, owned by APPS and documented with a status of VALID. Its name follows Oracle's standard shadow-table convention, in which the _SHD suffix denotes the companion package that maintains the shadow or audit copy of a base entity — in this case batch control totals (PAY_BATCH_CONTROL_TOTALS). As a shadow package, PAY_BCT_SHD exists to preserve the pre-change image of batch control total rows so that the associated business (BUS) package, PAY_BCT_BUS, can perform its own row-level auditing, version tracking, and who-column management before and after DML. Functionally, it supports the batch control totals subsystem, which reconciles the totals of a payroll batch (control counts and amounts entered by the user) against the totals actually produced by the batch when it is processed. Because it is a shadow package, it is not intended as a public API: it is invoked indirectly by the business package and by database triggers rather than being called directly by forms or concurrent programs. ETRM classifies it as API classification OTHER.

Key Procedures and Functions

Five procedures/functions are documented for this package. None of these are public integration APIs; they are internal shadow-layer helpers.

  • RETURN_API_DML_STATUS — Returns the DML status resulting from the most recent shadow-layer operation, allowing the calling business package to determine whether the change succeeded and to propagate that status back to its own caller.
  • CONSTRAINT_ERROR — Handles constraint-violation conditions raised during shadow DML, centralizing the error handling that would otherwise be duplicated across the insert, update, and delete shadow routines.
  • API_UPDATING — Indicates whether the package is currently executing within an API-driven update, so that the shadow logic can behave appropriately depending on the calling context.
  • LCK — Performs the locking of the shadow row (or the corresponding base row) prior to modification, ensuring concurrency-safe updates to batch control totals.
  • CONVERT_ARGS — Converts the argument values passed by the caller into the form required by the shadow DML statements, normalizing datatypes and values before they are written to the shadow table.

Tables Accessed

The package accesses PAY_BATCH_CONTROL_TOTALS through its APPS synonym. This is the base batch control totals table that holds the header-level control information for a payroll batch — the control count and control amount entered prior to batch processing — and it is the entity whose historical image the shadow package maintains. PAY_BCT_SHD also queries ALL_CONSTRAINTS, the Oracle data dictionary view, which indicates that the package performs a dictionary lookup at runtime, most likely to resolve constraint names or definitions in support of the CONSTRAINT_ERROR and related validation logic. No other tables are documented.

Usage Notes

PAY_BCT_SHD is referenced by PAY_BATCH_CONTROL_TOTALS_OVN, the object name matching the user's search term pay_batch_control_totals_ovn. In Oracle's naming conventions, an _OVN object is a view-layer artifact that carries the entity's user-facing or validation logic and that calls into the shadow and business packages. The package is also referenced by the PAY_BCT_BUS business package and by the four generated DML packages PAY_BCT_INS, PAY_BCT_UPD, PAY_BCT_DEL, and PAY_BCT_SHD itself, forming a standard Oracle-generated entity stack. In practice, this means PAY_BCT_SHD is invoked automatically when batch control total records are inserted, updated, or deleted — whether from the Batch Control Totals form, from a concurrent program that creates or adjusts payroll batches, or from custom code that manipulates PAY_BATCH_CONTROL_TOTALS through the supported API layer. Consultants should not call this package directly; the correct integration surface is the business package (PAY_BCT_BUS) and the associated OVN validation. The presence of a VALID status in both 12.1.1 and 12.2.2 confirms the package remains part of the supported Payroll schema across both releases.