Search Results create_range_table




Overview

APPS.PAY_RANGE_TABLE_API is a public PL/SQL API belonging to the Oracle E-Business Suite Payroll (PAY) module. Its business purpose is to manage the definition and maintenance of range tables — the user-defined lookup structures that map a range of values (for example, years of service, age bands, or salary bands) to the outcomes used by payroll calculations, such as rates, percentages, or flat amounts. Range tables are consumed by payroll formulas and element processing logic, so they must be created, amended, and retired through a controlled, date-effective API rather than by direct table manipulation. The package body (source header pyprfapi.pkb, version 120.0) therefore exposes a small, well-defined maintenance surface consisting of create, update, and delete operations, each enforcing the effective-dating and validation rules expected by the payroll engine.

Key Procedures and Functions

The documented API surface comprises three procedures:

  • CREATE_RANGE_TABLE — Inserts a new range table definition. In the source excerpt, this is the entry point reached by the user search term "create_range_table". Its signature accepts an effective date range (p_EFFECTIVE_START_DATE, p_EFFECTIVE_END_DATE), the range table number (p_RANGE_TABLE_NUMBER), the unit of measure for row values (p_ROW_VALUE_UOM), the period frequency (p_PERIOD_FREQUENCY), the associated earnings type (p_EARNINGS_TYPE), business group and legislation context (p_BUSINESS_GROUP_ID, p_LEGISLATION_CODE), the standard 30 descriptive flexfield attribute columns, and a second descriptive flexfield block for range information (p_RAN_INFORMATION_CATEGORY, p_RAN_INFORMATION1, and further range information segments). Almost every parameter carries a NULL default, allowing callers to supply only the values relevant to the specific range table being defined.
  • UPDATE_RANGE_TABLE — Modifies an existing range table definition, applying changes in a date-effective manner so that historical payroll results already computed against earlier versions remain reproducible.
  • DELETE_RANGE_TABLE — Removes a range table definition, typically by end-dating it or by logical deletion, subject to the referential and date-tracking rules of the payroll data model.

No parameter lists are invented here; the documented metadata identifies these three procedures by name and role only, beyond the CREATE_RANGE_TABLE signature visible in the source excerpt.

Tables Accessed

The package references two tables through APPS synonyms:

  • HR_LEGISLATION_INSTALLATIONS — Used to validate that the legislation context supplied by the caller is installed and active for the business group, ensuring range tables are only defined for legislations that the payroll application actually supports.
  • HR_ORGANIZATION_INFORMATION — Used to resolve and validate organization-level (business group) information associated with the range table definition, supporting the multi-tenant, business-group-partitioned nature of payroll data.

The package is additionally referenced by two other packages, indicating it forms part of a wider dependent API chain in the payroll configuration layer.

Usage Notes

PAY_RANGE_TABLE_API is typically invoked from the Payroll setup forms that maintain range tables, from concurrent programs that load setup data, and from custom PL/SQL code performing bulk or migration-based configuration. Because range tables drive formula and element processing, callers should always supply a valid business group, an installed legislation, and consistent effective dates; they should also populate the descriptive flexfield attributes only where the corresponding flexfield structure has been defined. Direct DML against the underlying range table entities should be avoided in favour of these three procedures so that validation and date-effective integrity are preserved.