Search Results delete_batch_header_a




Overview
Explore in AI Chat

Overview

PAY_BATCH_ELEMENT_ENTRY_BK7 is an Oracle EBS PL/SQL package body owned by the APPS schema that implements the business-layer hook for the Batch Element Entry (BEE) API family. The package is generated automatically by the Oracle HRMS API Hook Pre-processor, as indicated by the header comment ("Code generated by the Oracle HRMS API Hook Pre-processor") and the source control stamp on pybthapi.pkb (version 120.14, dated 2011/08/04). Generated on 2012/11/27, this object belongs to the standard Oracle Payroll API "BK" series — the pre-processor "Before/After" or "hook" stubs that Oracle delivers to allow customer extensions at defined points in the API lifecycle without modifying the base API code.

In Oracle EBS 12.1.1 and 12.2.2, the Batch Element Entry API (PAY_BATCH_ELEMENT_ENTRY_API) is the supported interface for creating, updating, and deleting batches of element entries in Oracle Payroll. This BK7 package supplies the hook implementation invoked during the delete-batch-header operation. Its only documented procedures are DELETE_BATCH_HEADER_A and DELETE_BATCH_HEADER_B, both of which correspond to the delete_batch_header API call the user searched for.

Key Procedures and Functions

  • DELETE_BATCH_HEADER_A — The "pre" hook. This procedure contains location-setting calls (hr_utility.set_location) marking entry and exit, and is otherwise empty by default. It is the point at which the HRMS API Hook Pre-processor expects customer or localization logic to be inserted prior to the base delete logic executing.
  • DELETE_BATCH_HEADER_B — The "post" hook. It returns the current commit unit via hr_api.return_commit_unit, conditionally invokes application hooks (hr_api.call_app_hooks), and — when hooks are enabled — calls hxt_util.check_batch_states, passing the batch identifier. It then calls hr_api.validate_commit_unit with the operation name 'DELETE_BATCH_HEADER' and the API prefix 'BP' before exiting.

Both procedures are stubs in the delivered product. No parameter lists are newly defined here beyond P_BATCH_ID (the batch identifier) and P_OBJECT_VERSION_NUMBER (used for optimistic locking/concurrency control); these are passed through from the calling API. The package body is intentionally minimal so that Oracle can regress the hooks at upgrade time.

Tables Accessed

The documented source excerpt contains no direct DML against application tables. Data access is indirect: hxt_util.check_batch_states is a Time and Labor (HXT) utility that validates the state of the batch — verifying that the batch header is in a deletable status and that no downstream dependencies (for example, approved or transferred time) would be violated. The commit unit validation in hr_api.validate_commit_unit operates against HRMS transaction-control structures rather than a business table. The underlying delete is performed by the base API (pay_batch_element_entry_api), which removes rows from the batch header and line tables (PAY_BATCH_HEADERS and related batch element entry tables) using the APPS synonyms. This BK7 package is therefore a hook shell rather than a data-manipulating unit.

Usage Notes

  • Invocation path: The package is not called directly by end users. It is invoked indirectly when the Batch Element Entry API's delete_batch_header routine runs, either from the Batch Element Entry form, from a concurrent program, or from custom code that calls PAY_BATCH_ELEMENT_ENTRY_API.DELETE_BATCH_HEADER.
  • Concurrency control: The P_OBJECT_VERSION_NUMBER parameter enforces optimistic locking; callers must supply the current version number to avoid the "record has been modified" error.
  • Extension point: Because the procedures are empty by default, they are the designated place to add customer-specific validation or side effects. Oracle documentation cautions that any custom logic added here must be re-applied after upgrading, since the pre-processor regenerates the body.
  • Dependencies: The package is referenced by one other package within APPS, confirming its role as a subordinate hook rather than a top-level entry point.

In summary, PAY_BATCH_ELEMENT_ENTRY_BK7 is a generated HRMS API hook that guards the delete-batch-header operation in Oracle Payroll's Batch Element Entry interface, providing pre- and post-execution insertion points for batch state validation and commit-unit integrity checks.