Search Results pay_sdb_ins




Overview
Explore in AI Chat

Overview

PAY_SDB_INS is a PL/SQL package body owned by the APPS schema that forms part of the Oracle Payroll shadow defined balance infrastructure. The package supports the population and maintenance of shadow defined balances, which are internal staging structures Oracle Payroll uses to accelerate the calculation and retrieval of defined balance values during payroll processing. Defined balances aggregate payroll run results — earnings, deductions, employer contributions, and other accumulators — and shadow tables provide a materialized, query-optimized representation of this data so that balance feeds, payroll runs, and reporting routines can work against them without repeatedly walking the underlying balance and run-result tables.

The object is classified as an OTHER API in the ETRM 12.2.2 metadata, indicating it is an internal utility rather than a published, supported interface. It is valid in both Oracle EBS 12.1.1 and 12.2.2. The package body exposes a single documented program unit, INS, and depends on a compact set of sibling packages and tables that together implement the shadow balance lifecycle.

Key Procedures and Functions

  • INS — The only documented procedure in the package body. Its name follows the Oracle Payroll convention for insertion routines, and it is the entry point through which rows are written into the shadow defined balance tables. It is intended to be called by the higher-level shadow balance processing logic — specifically the orchestration package PAY_SDB_BUS — rather than by external callers directly.

The package body also depends on PAY_SDB_SHD, which provides the shared declarations that PAY_SDB_INS implements. No parameter lists are documented in the ETRM metadata, and callers are expected to invoke INS only through the supported shadow balance processing path.

Tables Accessed

  • PAY_SHADOW_DEFINED_BALANCES — The primary shadow table holding materialized defined balance values keyed to assignment, balance, and context. PAY_SDB_INS inserts rows into this table as balance results are consolidated.
  • PAY_SHADOW_DEFINED_BALANCES_S — The companion sequence used to generate primary keys for the shadow balance table.

Both objects are referenced through APPS synonyms. The package also references DUAL and the STANDARD package for basic PL/SQL support functions.

Usage Notes

PAY_SDB_INS is not invoked directly by Oracle Forms or by end users. It is called internally by PAY_SDB_BUS, the business logic package for shadow defined balances, which in turn is driven by the payroll balance calculation and data refresh processes. The dependency chain places PAY_SDB_INS near the bottom of the shadow balance stack: PAY_SDB_BUS determines what must be inserted, PAY_SDB_INS performs the insert, and PAY_SDB_SHD supplies the shared type and constant declarations.

The package additionally depends on HR_API and HR_UTILITY for HRMS-level error handling and general utility routines. Despite the ETRM note that PAY_SDB_INS is "not referenced by any database object," the documented metadata states it is referenced by three other packages, so custom code should treat it as an internal implementation detail. Customers should not call PAY_SDB_INS from custom PL/SQL, concurrent programs, or personalizations; doing so bypasses the validation and locking performed by PAY_SDB_BUS and risks corrupting the shadow balance tables. Any extension of shadow defined balance behavior should be implemented through supported balance feed and defined balance configuration, not by modifying or invoking this package body.