Results for “process_event_type”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

PAY_PPE_API is a public PL/SQL API owned by the APPS schema that manages the persistence of Payroll Process Events within Oracle E-Business Suite. Its principal business function is to create, maintain, and remove rows in the PAY_PROCESS_EVENTS table, which records events generated against an assignment during payroll processing. These events drive downstream lifecycle handling, retroactive recalculation, and notification logic used by the payroll engine, so the integrity of the rows this package writes is significant to overall payroll processing accuracy.

The package is declared with AUTHID CURRENT_USER, meaning the executing schema, rather than APPS, governs privilege resolution for every call. The header of the source file (pyppeapi.pkh) carries a revision marker of 120.1.12010000.1 dated 2008/07/27, indicating that the package is a long-standing, stable component of the Payroll (PAY) module. ETRM classifies it as an API with public access status.

Key Procedures and Functions

• CREATE_PROCESS_EVENT — Inserts a single row into PAY_PROCESS_EVENTS, returning the generated primary key and object version number through its out parameters. It accepts validation, assignment identification, effective/session date, change type, status, description, event-update linkage, organization process event group, business group, surrogate key, calculation date, and retroactive status inputs. Validation errors are raised when the change type is not a valid value in the PROCESS_EVENT_TYPE lookup or when the status is not valid in the PROCESS_EVENT_STATUS lookup.
• UPDATE_PROCESS_EVENT — Modifies an existing process event row, applying the same lookup validation rules as creation and maintaining the object version number for optimistic locking.
• DELETE_PROCESS_EVENT — Removes a process event record identified by its primary key and object version number, supporting cleanup of obsolete or reversing events.

The three procedures form the complete CRUD surface for the process event entity. No parameters are documented here beyond those shown for create, and none should be assumed for the update or delete entry points.

Tables Accessed

The documented write target is PAY_PROCESS_EVENTS, where every created, updated, or deleted row resides. The API also references PAY_EVENT_UPDATE through the optional p_event_update_id foreign key, and it implicitly depends on the HR lookup engine for the PROCESS_EVENT_TYPE and PROCESS_EVENT_STATUS lookup types, which supply the permissible values for the change type and status arguments. APPS synonyms provide access to these objects at runtime. No other table access is documented in the ETRM record.

Usage Notes

The package is normally invoked by other payroll APIs and batch processes rather than directly by end users. Because the API is public, custom PL/SQL and extensions may call it when business requirements demand programmatic creation of payroll process events. The p_validate parameter should be set to true in callers that wish the transaction to roll back rather than commit, which is standard practice during testing or when the API is embedded inside a larger controlled transaction. Callers must supply a valid effective date, change type, and status; otherwise the API raises the documented invalid-event-type or invalid-status errors. The object version number returned on creation should be retained and passed back on subsequent updates and deletes to prevent lost updates. Given that seven other packages reference this API, modifications to calling code should preserve the documented parameter semantics.