Search Results per_cagr_api_pk




Overview
Explore in AI Chat

Overview

The PER_CAGR_APIS table is a core data definition table within the Oracle E-Business Suite Human Resources (PER) module, specifically for versions 12.1.1 and 12.2.2. It serves as the master repository for defining Compensation and Grade Rate (CAGR) Application Programming Interfaces (APIs). These APIs are programmatic components used to calculate and manage complex compensation rules, grade rate structures, and entitlement logic within the HRMS system. The table's primary role is to store the metadata and configuration that governs how compensation-related calculations are executed, acting as a central reference for the system's compensation rule engine.

Key Information Stored

While the provided ETRM metadata does not list individual columns, the structure and related objects indicate the nature of the data stored. The table's primary key is the CAGR_API_ID, a unique identifier for each defined API. Based on its purpose and related tables, this table likely stores critical configuration details such as the API name, type (e.g., for grade progression, bonus calculation, or entitlement determination), associated legislation or country, status, and the name of the underlying PL/SQL package or procedure that contains the business logic. The existence of a primary key constraint (PER_CAGR_API_PK) ensures the integrity and uniqueness of each API definition.

Common Use Cases and Queries

This table is primarily accessed for configuration, troubleshooting, and reporting on the compensation rule framework. Common operational scenarios include identifying all active compensation APIs for a specific legislation or validating the setup before a mass compensation review. A typical query would join PER_CAGR_APIS to its parameter child table to review a full API configuration.

  • Listing All Defined APIs: SELECT CAGR_API_ID, API_NAME, LEGISLATION_CODE FROM HR.PER_CAGR_APIS WHERE STATUS = 'ACTIVE';
  • Finding APIs for a Specific Process: Queries often join to related tables like PER_CAGR_ENTITLEMENT_ITEMS to trace which APIs drive specific compensation elements.
  • Integration & Support: Technical consultants use this table to understand the backend logic for compensation calculations when debugging issues or developing custom integrations.

Related Objects

As documented in the foreign key relationships, PER_CAGR_APIS is a parent table to several key compensation objects. The PER_CAGR_API_PARAMETERS table stores the configurable input parameters required for each API defined in PER_CAGR_APIS. The PER_CAGR_ENTITLEMENT_ITEMS table references this table to link specific compensation entitlement items (like allowances or bonuses) to the calculation logic defined by a particular API. These relationships form a hierarchy where PER_CAGR_APIS is the central definition, driving parameterized calculation logic for specific compensation items.