Search Results pay_bth_ins




Overview
Explore in AI Chat

Overview

PAY_BTH_INS is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified as an "OTHER" API within the Oracle Payroll (PAY) module. Its name follows the naming convention for batch header processing routines — "BTH" denoting batch header and "INS" denoting insertion — indicating that the package is responsible for low-level insert operations against the Payroll batch header data structures. In Oracle EBS 12.1.1 and 12.2.2, batch headers are the parent records that group prepayments, third-party payments, and other payroll disbursement transactions processed through Oracle Payroll's batch payment functionality. The package operates beneath the public batch element entry APIs, servicing the persistence layer rather than exposing a full business-facing interface.

Key Procedures and Functions

The ETRM metadata documents one callable program unit within the package:

  • INS — The insertion routine that creates batch header records in the underlying Payroll tables. Consistent with the "OTHER" API classification, INS is an internal worker procedure rather than a formally published interface; it exists to encapsulate the insert logic so that multiple callers can create batch headers without duplicating SQL. Parameter details are not published in the ETRM extract, and no signatures should be assumed. Its singular, insert-only scope reflects the package's narrow design: the companion update and validation logic resides in related packages such as the batch element entry API.

Tables Accessed

The package references two documented tables through APPS synonyms:

  • PAY_BATCH_HEADERS — The transactional batch header table, which stores the defining attributes of a payroll payment batch, including batch identifiers, dates, statuses, and organizational context. PAY_BTH_INS writes new rows into this table via its INS routine.
  • PAY_BATCH_HEADERS_S — The corresponding dated/translated (TL-style _S) shadow table that holds the descriptive or localized columns associated with each batch header row. An insert into the base table is normally accompanied by a row in the _S table to maintain referential completeness for descriptive attributes.

Dependency metadata additionally shows that the package references PAY_BTH_SHD, the batch header shadow/audit table used in Payroll's table-shadowing scheme, and the SYS.STANDARD package. The shadow reference indicates that INS participates in the audit trail that tracks historical versions of batch header records.

Usage Notes

PAY_BTH_INS is not intended for direct invocation by end users or external integrations. ETRM dependency data shows it is referenced by PAY_BATCH_ELEMENT_ENTRY_API, meaning that the batch element entry API calls PAY_BTH_INS internally when a batch header must be created as a prerequisite to element entry processing. The package also appears in its own dependency list, reflecting internal recursion or private helper calls.

In practice, customers and partners encounter this package only through standard Payroll flows: batch payment concurrent programs, the Batch Element Entry (BEE) forms and spreadsheet upload, and any custom code that legitimately routes through the supported batch element entry API. Because PAY_BTH_INS is an internal, undocumented interface, it carries the usual risks of direct calls: Oracle may change its signature or behavior without notice during patching or upgrades from 12.1.1 to 12.2.2. Customizations should therefore always invoke the published PAY_BATCH_ELEMENT_ENTRY_API instead. When troubleshooting batch creation failures, DBAs and developers may inspect PAY_BTH_INS in the ETRM dependency report to trace how a batch header row was inserted and which shadow records were generated.