Results for “hr_grade_rate_value_api”

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

Overview

The APPS.HR_GRADE_RATE_VALUE_API package body is a public API within the Oracle E-Business Suite Human Resources (HR) module. It provides the programmatic interface for creating, maintaining, and removing grade rate values — the specific monetary or numeric amounts associated with a grade rate, which in turn is attached to a grade. Grade rate values are foundational to compensation processing: they determine the pay or rate of pay an employee receives when assigned to a particular grade and step, and they feed payroll and salary administration logic across Oracle HRMS and Oracle Payroll.

This package is classified as an API in the ETRM metadata and resides in the APPS schema, meaning it is a supported, callable interface intended for use by Oracle application forms, concurrent programs, and customer extensions rather than being an internal private routine. As documented in the ETRM repository for release 12.2.2, the package is marked VALID and exposes three documented procedures that correspond directly to the standard create, update, and delete lifecycle operations expected from an Oracle HRMS date-tracked API.

Key Procedures and Functions

The package body documents three procedures:

• CREATE_GRADE_RATE_VALUE — Inserts a new grade rate value record, establishing the amount or rate associated with a given grade rate for a defined date range. This is the primary entry point when a new rate amount must be introduced into the compensation structure.
• UPDATE_GRADE_RATE_VALUE — Modifies an existing grade rate value. In keeping with Oracle HRMS date-tracked design, updates typically result in a new effective-dated row rather than an in-place modification, preserving the historical rate for prior periods.
• DELETE_GRADE_RATE_VALUE — Removes a grade rate value record, logically terminating its validity so that it no longer applies from the effective deletion date forward.

All three procedures follow the standard Oracle HRMS API conventions, including the use of effective dates, object version numbers for optimistic locking, and a consistent validation and error-handling model. Parameter lists are not enumerated here, as they are documented separately in the package specification.

Tables Accessed

The ETRM metadata records the following tables referenced through APPS synonyms:

• PAY_GRADE_RULES_F — The grade rules table holds the definition of grade rate rules and rate structures to which individual rate values belong. The API reads this table to validate that the target rate context exists and is consistent with the value being written.
• PER_GRADES — The grades table stores the grade definitions used across the enterprise. It is referenced to confirm that the grade associated with the grade rate value is valid and to support the date-tracked relationship between grades and their rate values.

Usage Notes

The package body APPS.HR_GRADE_RATE_VALUE_API is referenced by no other database object and instead depends on supporting packages including HR_API, HR_RATE_VALUES_API, and HR_UTILITY, which supply shared validation, date-tracking, and error-stack utilities. Because it exposes only public procedures and is not itself called internally by other packages, it is intended to be invoked explicitly by:

• Oracle HRMS compensation and grade-rate maintenance forms, which call the API to persist user-entered rate changes.
• Concurrent programs or batch loaders that mass-maintain grade rate values across multiple grades.
• Custom PL/SQL code in customer extensions that must insert, amend, or end-date grade rate values while respecting Oracle's date-tracked compensation model.

Because the package is an officially classified API, direct DML against PAY_GRADE_RULES_F and PER_GRADES should be avoided in favor of these procedures, ensuring that validation, effective dating, and audit behavior remain consistent with standard Oracle HRMS processing. The behavior is documented as equivalent across Oracle EBS 12.1.1 and 12.2.2.