Search Results delete_range

Overview

APPS.PAY_RANGE_API is a PL/SQL package body that provides the supported application programming interface for maintaining pay range definitions in Oracle Payroll. Pay ranges are the grade-related structures that pair a grade or grade step with a defined minimum, maximum, and mid-point value, together with the frequency, currency, and legislative context required to interpret those amounts. These definitions underpin salary validation, grade progression, and reporting in Oracle HRMS and Oracle Payroll.

In Oracle E-Business Suite 12.1.1 and 12.2.2, the package is registered under the APPS schema and reports a status of VALID. It is classified as an API, the highest level of support, meaning that customer and partner code is permitted to call its documented entry points rather than writing directly to the underlying base tables. The package is implemented as a thin business-logic wrapper: it delegates record validation to HR_API, the shared HRMS validation and security layer, and persists data through three dedicated DML programs, PAY_RAN_INS, PAY_RAN_UPD, and PAY_RAN_DEL. Because the package body is the only shipped implementation, the API contract is exposed through the specification, and the body must be compiled and valid before dependent objects succeed.

Key Procedures and Functions

The ETRM metadata documents three procedures, corresponding to the three maintaining operations for a pay range record:

• CREATE_RANGE — Creates a new pay range definition, accepting the range attributes along with the effective dating and business-group context needed to establish the record. It validates the supplied values through the HRMS API layer and routes the insert to the PAY_RAN_INS program.
• UPDATE_RANGE — Modifies an existing pay range. It applies the same validation path and writes changes through the PAY_RAN_UPD program, preserving the date-tracked history model used throughout HRMS.
• DELETE_RANGE — Removes a pay range record, invoking PAY_RAN_DEL. Deletion typically applies to the delete of a datetracked row rather than a physical purge, consistent with the date-tracked design.

Parameter lists are not reproduced here. Consult the package specification in the database or the ETRM object viewer for the exact signatures before calling these procedures.

Tables Accessed

The ETRM excerpt lists the package's dependencies as HR_API and the PAY_RAN_INS, PAY_RAN_UPD, and PAY_RAN_DEL programs, which serve as the insert, update, and delete handlers for the pay range table. The metadata as provided does not enumerate individual tables via public synonyms; the referenced programs operate on the base pay range entity, and the API is the documented, supported route to it. Direct DML against the underlying table is not recommended, since it bypasses validation, security, and date-track logic enforced by HR_API and the DML programs.

Usage Notes

PAY_RANGE_API is invoked whenever a pay range must be created, changed, or removed programmatically. Typical callers include the Oracle Payroll and HRMS forms that maintain grade and pay range definitions, concurrent programs that load or migrate grade structures, and custom or third-party interfaces that integrate compensation data with Oracle E-Business Suite. The package itself is not referenced by any other database object, confirming it is an entry point rather than an internal building block.

The API is referenced by two other packages, indicating that other APIs within the HRMS family delegate to it. All three procedures should be called within the standard API pattern: set up the business group and date-track context, pass a valid effective date, handle the API return status before committing, and respect the caller's transaction boundaries. Because the package reports VALID status on 12.1.1 and 12.2.2, it is safe for upgrade-safe customizations built against the documented procedures.