Search Results per_cagr_api_parameters_pk




Overview
Explore in AI Chat

Overview

The table PER_CAGR_API_PARAMETERS is a core data object within the Oracle E-Business Suite Human Resources (PER) module, specifically supporting the Compensation and Grade Rate (CAGR) functionality. It functions as a parameter repository for Compensation APIs, which are critical for defining and processing complex compensation rules, grade rate structures, and entitlement calculations. This table's primary role is to store the configurable parameters that govern the behavior of specific Compensation APIs, enabling the system to dynamically apply business rules for salary administration, promotions, and other compensation-related actions. Its existence is essential for the extensibility and customization of the compensation engine in Oracle HRMS.

Key Information Stored

The table's structure is designed to link parameters to their parent APIs and define their characteristics. The primary key, CAGR_API_PARAM_ID, uniquely identifies each parameter record. The most critical foreign key, CAGR_API_ID, links each parameter to its parent API definition in the PER_CAGR_APIS table. While the full column list is not detailed in the provided metadata, typical columns in such a parameter table would include the parameter name, data type, default value, whether it is mandatory, display sequence, and potentially a description. This design allows a single Compensation API to be executed with different input values, making the compensation rule logic reusable and data-driven.

Common Use Cases and Queries

This table is primarily accessed during the configuration and execution of compensation processes. A common use case is during the setup of a new grade rate or salary basis, where an administrator must define which APIs to invoke and what parameters to pass. For reporting and verification, a typical query would join this table to the parent API table to list all parameters for a specific compensation rule. For example:

  • Identifying all parameters for a specific API: SELECT * FROM hr.per_cagr_api_parameters WHERE cagr_api_id = (SELECT cagr_api_id FROM hr.per_cagr_apis WHERE api_name = 'API_NAME');
  • Troubleshooting an entitlement calculation by verifying the parameter values passed to the governing API.
  • Generating a configuration audit report of all Compensation APIs and their associated parameters for documentation purposes.

Related Objects

As documented in the provided metadata, PER_CAGR_API_PARAMETERS has defined relationships with two key tables:

  • PER_CAGR_APIS: This is the parent table. The foreign key PER_CAGR_API_PARAMETERS.CAGR_API_ID references PER_CAGR_APIS. This relationship ensures every parameter is associated with a valid, defined Compensation API.
  • PER_CAGR_ENTITLEMENT_ITEMS: This table holds the calculated entitlement results. It references PER_CAGR_API_PARAMETERS via the foreign key column PER_CAGR_ENTITLEMENT_ITEMS.CAGR_API_PARAM_ID. This relationship likely stores which specific parameter value (or set of values) was used in the calculation of a particular entitlement item, providing an audit trail.

The primary key constraint PER_CAGR_API_PARAMETERS_PK on CAGR_API_PARAM_ID enforces data integrity for these relationships.