Search Results per_cagr_apis




Overview
Explore in AI Chat

Overview

The PER_CAGR_APIS table resides in the HR schema and belongs to the PER (Human Resources) product family within Oracle E-Business Suite 12.1.1 and 12.2.2. Its name reflects the Consolidated Appropriations and Grants Reporting (CAGR) framework, a legislative reporting regime that governs how public-sector employers track and report employee entitlement, salary, and service data for grant-funded positions. In this context, PER_CAGR_APIS functions as a registry of the API definitions that the HR application programming interface layer exposes for consumption by downstream entitlement, reporting, and retained-rights processes.

Each row in PER_CAGR_APIS identifies a discrete API surface that the E-Business Suite makes available to external or internal callers. The table serves as a catalog or hub of API identities, with dependent child tables attaching parameters, entitlement items, retained rights, and computation results. Under the heuristic Data Vault classification provided in the metadata, PER_CAGR_APIS is a hub-leaning object: it holds the stable business key and descriptive attributes for each API, while the transactional and parameter detail is carried by the surrounding link and satellite tables that reference it. This classification is a modeling suggestion rather than a physical constraint in the delivered schema.

Key Information Stored

The table is documented with ten columns. The most significant are:

  • CAGR_API_ID — the surrogate primary key, enforced by the PER_CAGR_API_PK constraint. This is the value propagated to all dependent tables.
  • ZD_EDITION_NAME — the editioning discriminator used by Oracle's Edition-Based Redefinition (EBR) framework, enabling online patching. It participates with CAGR_API_ID in the unique index PER_CAGR_API_PK, making (CAGR_API_ID, ZD_EDITION_NAME) the documented business-key candidate.
  • API_NAME — the human-readable identifier of the API, typically the PL/SQL package or procedure name registered for CAGR processing.
  • CATEGORY_NAME — a grouping attribute that classifies the API by functional area, such as entitlement, parameter, or result processing.
  • OBJECT_VERSION_NUMBER — the optimistic locking column used by the Oracle Application Framework (OAF) and other EBS layers to detect concurrent updates.
  • LAST_UPDATE_DATE, LAST_UPDATED_BY, LAST_UPDATE_LOGIN — the standard WHO audit columns recording when, by whom, and under which session the row was last modified.
  • CREATED_BY, CREATION_DATE — the corresponding audit columns for row creation.

Only API_NAME and CATEGORY_NAME carry true descriptive payload; the remaining columns provide identity, auditing, and concurrency control.

Common Use Cases and Queries

Typical usage involves resolving an API name to its surrogate ID before joining to dependent tables, or reporting on which APIs are registered by category. A representative query lists all registered CAGR APIs:

  • SELECT CAGR_API_ID, API_NAME, CATEGORY_NAME FROM HR.PER_CAGR_APIS WHERE ZD_EDITION_NAME = 'ORA$BASE';

To resolve a specific API and its parameters, analysts join to PER_CAGR_API_PARAMETERS on CAGR_API_ID:

  • SELECT a.API_NAME, p.* FROM HR.PER_CAGR_APIS a JOIN HR.PER_CAGR_API_PARAMETERS p ON p.CAGR_API_ID = a.CAGR_API_ID;

A third common scenario determines which entitlement items are served by a given API, using the join to PER_CAGR_ENTITLEMENT_ITEMS. Because the table is editioned, every query should either filter on ZD_EDITION_NAME or rely on the editioning view in the APPS schema, which restricts visibility to the active edition automatically.

Related Objects

Four foreign-key relationships are documented, all of them pointing back to PER_CAGR_APIS via CAGR_API_ID:

  • PER_CAGR_API_PARAMETERS — stores the parameter definitions bound to each API; joined on CAGR_API_ID.
  • PER_CAGR_ENTITLEMENT_ITEMS — maps entitlement items to the API that processes them.
  • PER_CAGR_RETAINED_RIGHTS — records retained-rights computations associated with an API.
  • PER_CAGR_ENTITLEMENT_RESULTS — captures the output of entitlement processing for each API.

Together these objects form the CAGR API subsystem within the HR schema, with PER_CAGR_APIS acting as the central hub from which entitlement, parameter, and result data fan out. The APPS schema exposes the same table through synonym and editioning views, which is the recommended access path for concurrent-manager and OAF-based components.