Results for “ben_acty_rt_deduct_sched_api”

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

Overview

The APPS.BEN_ACTY_RT_DEDUCT_SCHED_API package is a PL/SQL application programming interface belonging to the Oracle E-Business Suite Advanced Benefits (BEN) module. It provides the programmatic entry point for maintaining deduction schedules that are associated with activity base rates. In Oracle Advanced Benefits, an activity rate represents a rate that varies based on a participant's activity (such as hours worked, units produced, or service periods), and a deduction schedule defines the frequency and pattern by which those rates are converted into payroll deductions. This API encapsulates the business logic, validation, and date-tracking rules required to create, modify, and remove those schedule records without requiring direct DML against the underlying table.

The package is classified as a public API in the ETRM 12.2.2 repository and is owned by the APPS schema. The header comments identify the source file as beadsapi.pkh, with a revision history originating in 2005. The "executeApiCallRedacted" string returned by the user's search is not a procedure of this package; it is a generic diagnostic or logging token emitted by the EBS API framework layer (typically within the hr_api utility routines) and does not correspond to any documented member of BEN_ACTY_RT_DEDUCT_SCHED_API.

Key Procedures and Functions

The ETRM metadata documents four packaged members:

• CREATE_ACTY_RT_DEDUCT_SCHED — Inserts a new deduction schedule record tied to an activity base rate. It accepts a business group identifier, the activity base rate identifier, a deduction schedule code, payroll frequency references, and twenty descriptive flexfield attribute columns. A p_validate flag controls whether the operation is committed or rolled back.
• UPDATE_ACTY_RT_DEDUCT_SCHED — Modifies an existing deduction schedule. It applies the same attribute set as the create routine, using the surrogate key and object version number to enforce optimistic locking on the date-tracked record.
• DELETE_ACTY_RT_DEDUCT_SCHED — Logically or physically removes the schedule record, subject to referential and date-tracking constraints defined by the Benefits data model.
• LCK — A locking routine used to serialize concurrent access to a schedule row prior to an update or delete, preventing lost-update conditions in multi-user processing.

Tables Accessed

The package operates exclusively against BEN_ACTY_RT_DED_SCHED_F, accessed through an APPS synonym. The _F suffix indicates that this is a date-tracked ("future") table, meaning each row carries effective start and end dates together with an object version number. The create, update, and delete routines all write to this table, while the date-tracking engine derives the corresponding _D (dated) view for point-in-time reporting. No other tables are documented as referenced.

Usage Notes

This API is normally invoked indirectly. Standard Advanced Benefits configuration forms, batch rate loaders, and the Benefits open enrollment and eligibility concurrent programs call the routine when deduction scheduling information must be persisted for an activity rate. Custom integrations—such as interface programs loading rate schedules from an external payroll or time-and-labor system—should call this package rather than inserting into BEN_ACTY_RT_DED_SCHED_F directly, because the API enforces business group validation, flexfield handling, date-track integrity, and concurrency control. The ETRM metadata records no inbound package dependencies, so the API is a leaf-level writer and may be safely called from custom concurrent programs and PL/SQL wrappers. Callers should always pass p_validate appropriately, perform a commit only after all rows in a batch succeed, and handle standard hr_api exceptions.