Search Results per_cagr_api_parameters_pk

Overview

PER_CAGR_API_PARAMETERS is a Human Resources (PER) module table in Oracle E-Business Suite, owned by the HR schema. It stores the metadata definitions for parameters exposed by Compensation and Grading (CAGR) APIs — the configurable inputs that entitlement, retained rights, and related compensation processes accept when they call a CAGR API. Each row describes a single parameter belonging to one API definition, including its display label, underlying column type, size, and default unit of measure. This table therefore acts as a dictionary of API input contracts, allowing the application to render or validate parameter values dynamically rather than hard-coding them.

The table carries both a surrogate primary key (CAGR_API_PARAM_ID) and a second identifier column, ZD_EDITION_NAME, which participates in the unique index PER_CAGR_API_PARAMETERS_PK. The presence of ZD_EDITION_NAME reflects the edition-based redefinition (EBR) architecture used in EBS 12.2, enabling online patching. Based on the foreign key structure — this table references PER_CAGR_APIS while being referenced by several downstream transactional tables — its heuristic Data Vault classification is satellite-leaning. That is, it is best modeled as descriptive attribute data attached to an API (hub/link) parent, rather than as an independent hub or a link between entities.

Key Information Stored

The documented physical schema contains 17 columns. The most significant are:

• CAGR_API_PARAM_ID — the surrogate primary key, uniquely identifying each parameter definition row.
• CAGR_API_ID — foreign key to PER_CAGR_APIS, tying the parameter to its owning API definition.
• ZD_EDITION_NAME — edition identifier, part of the composite unique index and central to EBS 12.2 online patching.
• PARAMETER_NAME — the internal/programmatic name used when the API is invoked or bound.
• DISPLAY_NAME — the user-facing label presented in UI or reporting contexts.
• COLUMN_TYPE — the data type of the parameter value.
• COLUMN_SIZE — the permitted length or precision of the parameter value.
• UOM_PARAMETER — indicates whether the parameter is treated as a unit-of-measure value.
• UOM_LOOKUP — the lookup type or source used to validate UOM values.
• DEFAULT_UOM — the default unit of measure applied when none is supplied.
• HIDDEN — flag controlling whether the parameter is exposed to users.
• OBJECT_VERSION_NUMBER — optimistic locking column used by the framework to detect concurrent updates.
• LAST_UPDATE_DATE, LAST_UPDATED_BY, LAST_UPDATE_LOGIN, CREATED_BY, CREATION_DATE — standard WHO audit columns tracking creation and modification.

Note that the surrogate key (CAGR_API_PARAM_ID) is distinct from the business-key candidate represented by the unique index over (CAGR_API_PARAM_ID, ZD_EDITION_NAME). No separate non-surrogate business key is documented.

Common Use Cases and Queries

The primary use case is retrieving the parameter contract for a given CAGR API so that callers can build valid input structures. A typical query joins the parameter table to PER_CAGR_APIS:

• Listing parameters for an API: SELECT p.PARAMETER_NAME, p.DISPLAY_NAME, p.COLUMN_TYPE, p.COLUMN_SIZE FROM per_cagr_api_parameters p WHERE p.cagr_api_id = :api_id ORDER BY p.parameter_name;
• Identifying UOM-driven parameters: SELECT * FROM per_cagr_api_parameters WHERE uom_parameter = 'Y';
• Reporting visible parameters only: SELECT display_name, column_type FROM per_cagr_api_parameters WHERE hidden = 'N';
• Reconciling parameters to their downstream results, joining through PER_CAGR_ENTITLEMENT_RESULTS on CAGR_API_PARAM_ID.

Analysts also use the table to audit API configuration changes over time via the LAST_UPDATE_DATE and LAST_UPDATED_BY columns, and to validate that entitlement definitions reference parameters that still exist and are not hidden.

Related Objects

The following objects are the most significant dependents and parents of PER_CAGR_API_PARAMETERS, per the documented foreign key relationships:

• PER_CAGR_APIS — parent table; joined on PER_CAGR_API_PARAMETERS.CAGR_API_ID = PER_CAGR_APIS.CAGR_API_ID.
• PER_CAGR_ENTITLEMENT_ITEMS — references this table via CAGR_API_PARAM_ID.
• PER_CAGR_RETAINED_RIGHTS — references this table via CAGR_API_PARAM_ID.
• PER_CAGR_ENTITLEMENT_RESULTS — references this table via CAGR_API_PARAM_ID.

In addition, the CAGR API layer itself (the PL/SQL packages that consume PER_CAGR_APIS definitions) relies on this table indirectly, since parameter metadata governs how API inputs are validated and bound at runtime.