Search Results pay_event_groups_api




Overview
Explore in AI Chat

Overview

PAY_EVENT_GROUPS_API is a public PL/SQL API package owned by the APPS schema that provides a programmatic interface for maintaining event group definitions within Oracle Payroll. Event groups are the grouping mechanism by which payroll events—such as balance adjustments, retroactive recalculations, and proration triggers—are categorized and processed collectively. In Oracle EBS 12.1.1 and 12.2.2, this package exposes the core Data Manipulation Language operations that allow developers and integrators to create, modify, and remove event group definitions without writing directly against the underlying PAY_EVENT_GROUPS table.

The package is classified as a public API in the ETRM repository and is validated against the 12.2.2 release. Its role is analogous to other Payroll maintenance APIs such as PAY_ELEMENTS_API and PAY_ELEMENT_LINKS_API: it centralizes the business rules, validation logic, and WHO-column auditing that must be applied whenever an event group record is inserted, updated, or deleted. Direct DML against the base table bypasses these safeguards, which is why the API is the supported route for any custom extension.

Key Procedures and Functions

The ETRM metadata documents three procedures, all of which are standard maintenance entry points:

  • CREATE_EVENT_GROUP — Inserts a new event group definition into PAY_EVENT_GROUPS. The procedure performs the required validation of the group name and attributes before persisting the row, and populates the standard auditing columns.
  • UPDATE_EVENT_GROUP — Modifies an existing event group record. It allows the caller to change descriptive and functional attributes of an event group while preserving referential integrity with dependent payroll processes.
  • DELETE_EVENT_GROUP — Removes an event group definition. The procedure is the supported mechanism for retiring an event group and ensures that deletion is subject to the same validation rules applied during creation and update.

Detailed parameter lists are not reproduced here; callers should consult the package specification in the EBS instance, since the documented metadata names only the procedures and their purposes.

Tables Accessed

The package performs its DML exclusively against PAY_EVENT_GROUPS, accessed through the APPS synonym. This is the base table that stores event group identifiers, names, and the attributes that determine which payroll events are associated with a group. The CREATE, UPDATE, and DELETE procedures map directly onto insert, update, and delete operations on this table. The package depends on HR_API, the shared Human Resources API package, which supplies common validation and utility routines used across HRMS maintenance APIs, and on the SQL STANDARD package for standard Oracle PL/SQL functions such as NVL and DECODE.

Usage Notes

PAY_EVENT_GROUPS_API is referenced by three other packages: PAY_AU_RETRO_UPGRADE, PAY_US_RSRW_UPGREV, and PQP_PRORATION_WRAPPER. This indicates that the package is invoked both by upgrade and localization processes (Australia retroactive upgrade, US RSRW upgrade reversal) and by proration logic in the PQP schema. Custom code should follow the same pattern: call CREATE_EVENT_GROUP, UPDATE_EVENT_GROUP, or DELETE_EVENT_GROUP and then commit, rather than issuing DML directly to PAY_EVENT_GROUPS. The API may also be surfaced through a Payroll setup form, in which case the form executes the same procedures on behalf of the user. When developing extensions, the API should be invoked within the standard Payroll initialization sequence so that HR_API dependencies are satisfied, and callers should expect the package to enforce the validation and auditing behavior common to all APPS payroll maintenance APIs.