Search Results get_cagr_values

Overview

APPS.HR_SUMMARY_UTIL is a utility package in Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 that supports the Human Resources summary and statutory reporting infrastructure, most notably the legislative "headcount" and workforce summary reporting frameworks built on the PAY_USER_TABLES / PAY_USER_ROWS / PAY_USER_COLUMNS extensibility model. Its primary business role is to translate configuration-driven summary definitions (key types, gender, age, employee category, nationality, seniority, and other user-defined attributes) into dynamically constructed SQL fragments, and to load the resulting aggregate values into the summary data store. The package is classified as a UTIL object under the APPS schema, meaning it is an internal helper rather than a published business API, and it sits beneath higher-level HR reporting processes rather than being invoked directly by end users.

Key Procedures and Functions

The package exposes ten documented procedures and functions. GET_LOOKUP_VALUES is the routine associated with the user's search term; it resolves the values of a specified lookup type into the form required for a summary column, and is used when summary categories are driven by Oracle lookup codes rather than by user tables. CREATE_OTHER_KV constructs the "Other" key-value entry for a given key type and business group, allowing values that fall outside defined categories to be captured. GET_ALTERNATE_VALUES and GET_BAND_VALUES both build value expressions for summary columns, the former from an arbitrary table and column, and the latter from a table defined by low and high boundary columns (typically used for age or length-of-service bands). GET_CAGR_VALUES derives compound aggregate or rate values, and GET_MONTH resolves a month reference used in period-based summaries. INITIALIZE_RUN and INITIALIZE_PROCEDURE establish the runtime context — assigning the process run identifier, business group, template, and parameter values, and resetting package-level state. LOAD_ITEM_VALUE and LOAD_ITEM_KEY_VALUE persist a resolved summary value or key-value pair into the summary store for the active business group. Parameter lists are not reprinted here to avoid misrepresentation; only their documented purpose is described.

Tables Accessed

The package reads and writes the PAY_USER_TABLES, PAY_USER_COLUMNS, PAY_USER_COLUMN_INSTANCES_F, and PAY_USER_ROWS_F tables. These tables form the user-defined table framework that stores the configuration of summary and reporting structures: PAY_USER_TABLES defines the named user table, PAY_USER_COLUMNS and PAY_USER_COLUMN_INSTANCES_F define the columns and their per-instance behavior, and PAY_USER_ROWS_F holds the row-level data. HR_SUMMARY_UTIL uses these definitions to determine which columns and key types participate in a given summary, then constructs and executes the corresponding SQL. It also relies on DBMS_SQL for dynamic SQL construction and execution, and on PLITBLM for PL/SQL table (associative array) manipulation, consistent with the prmRecType / prmTabType structures declared in the package header.

Usage Notes

HR_SUMMARY_UTIL is not intended for direct invocation by end users or as a supported public API. It is referenced by five other packages and is typically invoked as part of HR summary generation, statutory reporting, and related concurrent program or request-set processing. Because it manipulates package-level global state (business group, process run identifier, year, and stored clause fragments), callers must issue INITIALIZE_RUN or INITIALIZE_PROCEDURE before invoking the value-building functions, and must ensure the package state is not shared across concurrent sessions. Custom code should call the higher-level HR reporting processes rather than these utilities directly, since the internal interfaces are private and may change between patch levels. When extending summary definitions, the supported approach is to configure the PAY_USER_TABLES and PAY_USER_COLUMNS framework rather than to modify or bypass this package.