Search Results hr_pay_scale_value_api




Overview
Explore in AI Chat

Overview

The APPS.HR_PAY_SCALE_VALUE_API package body is a public, server-side PL/SQL API within the Oracle E-Business Suite (12.1.1 / 12.2.2) that manages pay scale values associated with grade rate and pay scale structures in Oracle Human Resources. Pay scale values define the individual monetary or numeric values that make up a pay scale, such as the rate points, spinal points, or step values assigned within a grade rate or pay scale definition. This API allows developers and integrators to create, maintain, and remove these pay scale value records programmatically, rather than through the standard HRMS forms, while preserving the underlying business rules, validation, and data integrity logic enforced by the application.

The package carries an API classification and is owned by the APPS schema. It is a VALID object in the ETRM documentation. The API is designed to be called by other components of the Oracle HRMS suite, such as grade rate and pay scale setup, payroll processing logic, and custom extensions, ensuring that the correct validation and cross-referencing of related rate and scale structures occurs on every transaction.

Key Procedures and Functions

The ETRM documentation lists five procedures/functions for this package, including the following documented entry points:

  • CREATE_PAY_SCALE_VALUE — Creates a new pay scale value record. It inserts the value associated with a pay scale, applying the API's internal validation before persisting the record. It is the primary entry point for adding new scale values to a pay scale definition.
  • UPDATE_PAY_SCALE_VALUE — Modifies an existing pay scale value. This procedure updates the stored value and any related attributes, subject to the same validation and integrity checks as record creation.
  • DELETE_PAY_SCALE_VALUE — Removes a pay scale value record that is no longer required. The API handles any dependent logic or referential constraints before the deletion is committed.

The API also depends on the HR_API and HR_UTILITY packages and on HR_RATE_VALUES_API, which provide shared error handling, validation, and rate-value utilities.

Tables Accessed

The package reads from and writes to the following documented tables (accessed through APPS synonyms):

  • PER_SPINAL_POINTS — Stores spinal point definitions used within pay scale and grade structures. The API references these to link scale values to their applicable spinal points.
  • PAY_GRADE_RULES_F — Holds the grade rate and pay scale rule definitions that govern how values and rates are applied. The API uses this table to validate that a scale value is consistent with the applicable grade rule.
  • PAY_RATES — Contains the pay rate and rate value information. The API writes the actual pay scale values and reads existing rate data for consistency and validation.

These tables form the core of the pay scale and grade rate data model, ensuring that any created, updated, or deleted value remains consistent with the surrounding rate and grade rule configuration.

Usage Notes

The HR_PAY_SCALE_VALUE_API is typically invoked by the Oracle HRMS forms for pay scale and grade rate maintenance, and by concurrent programs and custom PL/SQL code that need to load or maintain pay scale data in bulk. Because it is not referenced by any other database object (per the ETRM dependency report), it is intended to be called directly by external code rather than as an internal dependency of another package. Developers integrating with this API should call the create, update, and delete procedures within a properly scoped transaction and should handle the API's standard HR error stack, since validation failures are reported through the HR_API error mechanism rather than through unhandled exceptions. In 12.1.1 and 12.2.2 environments, the API should be called only after the associated grade rate, pay scale, and spinal point structures have been defined, to ensure that cross-references in PAY_GRADE_RULES_F and PER_SPINAL_POINTS resolve correctly.