Search Results hr_rate_values_api




Overview
Explore in AI Chat

Overview

HR_RATE_VALUES_API is a public PL/SQL API in the APPS schema that manages rate value records within Oracle Human Resources. Rate values define the monetary or numeric amounts associated with grade rates, pay scale rates, and progression points, forming the foundation of compensation structures used throughout Oracle E-Business Suite release 12.1.1 and 12.2.2. The package exposes a controlled, business-rule-aware interface for maintaining the HR rate value entity, ensuring that all validations, date-track logic, and derived assignment rate values are consistently applied. Rather than allowing direct DML against the underlying tables, Oracle delivers this API as the supported entry point, which protects data integrity and triggers any dependent processing. The package is classified as an API in the ETRM metadata and is validated in the APPS schema.

Key Procedures and Functions

The documented interface comprises six procedures:

  • CREATE_RATE_VALUE — Inserts a new rate value record for a grade rate or pay scale rate, applying validation and date-tracked insert logic.
  • UPDATE_RATE_VALUE — Modifies an existing rate value, managing effective-dated changes to the underlying rate record.
  • DELETE_RATE_VALUE — Removes an existing rate value record subject to the API's validation rules.
  • CREATE_ASSIGNMENT_RATE_VALUE — Creates a rate value at the assignment level, allowing an individual assignment to carry its own rate distinct from the grade or scale definition.
  • UPDATE_ASSIGNMENT_RATE_VALUE — Modifies an assignment-level rate value.
  • LCK — A locking routine used to obtain a row-level lock on a rate value record, typically invoked before a related update or delete to enforce concurrency control.

Parameter lists are not enumerated here; callers should consult the package specification for exact signatures and mandatory arguments.

Tables Accessed

The package operates primarily against two tables referenced through APPS synonyms:

  • PAY_RATES — The core table storing rate definitions and rate values, including effective dates and amounts.
  • PAY_GRADE_RULES_F — Stores grade rate rule definitions that govern how rates are derived and validated for a given grade.

Writes are directed at PAY_RATES for create, update, and delete operations, while PAY_GRADE_RULES_F provides the rule context against which validations are performed. The package also depends on HR_API, the common HR utility package supplying shared validation and date-track services.

Usage Notes

HR_RATE_VALUES_API is invoked indirectly by several higher-level components. Within the HR schema, HR_ASSIGNMENT, HR_GRADE_RATE_VALUE_API, HR_PAY_SCALE_VALUE_API, and the rate values self-reference all call into this package. The HR_RATE_VALUES_SWI server-side wrapper mediates form-based maintenance, meaning that the HR grade rates and pay scale rates forms in the EBS UI ultimately reach this API. In Oracle Payroll and Public Sector/Enterprise Compensation contexts, PER_QH_MAINTAIN_UPDATE, PQH_FR_PROGRESSION_POINT_PKG, PQH_FR_SYNC_SAL_RATES, and PQH_GSP_STAGE_TO_HR also reference the package, confirming its role in salary rate synchronization and progression point processing. Custom integrations that must insert or amend rate values should follow the same pattern: invoke the appropriate create, update, or delete procedure rather than issuing direct DML, and call LCK where concurrent modification is a concern. Because the API encapsulates HR business rules, bypassing it risks inconsistent rate data across grades, scales, and assignments.