Search Results hr_summary_util




Overview
Explore in AI Chat

Overview

HR_SUMMARY_UTIL is a utility package body in the APPS schema that supports the Oracle E-Business Suite Human Resources summary and talent-management infrastructure. Rather than exposing a single business transaction, it provides the shared runtime plumbing on which the HR Summary framework depends: lookup resolution, key/value normalization, banding, and cumulative growth calculations used in compensation and workforce analytics. In EBS 12.1.1 and 12.2.2 the object is documented as VALID, is classified as a UTIL API by ETRM, and is a member of the HR family of packages that includes HR_SUMMARY_API, HR_SUMMARY_KEY_VALUE, and HR_UTILITY. Its principal role is to resolve the many configurable codes and user-defined table structures that drive summary definitions, so that higher-level summary and reporting logic can work against consistent values.

Key Procedures and Functions

ETRM documents ten callable units within the package body. They fall into three functional clusters.

  • INITIALIZE_RUN and INITIALIZE_PROCEDURE — establish the execution context for a summary run, setting up the state and parameters that subsequent calls rely upon.
  • GET_LOOKUP_VALUES — retrieves values from Oracle HR lookups (HR_LOOKUPS), providing the decoded meaning behind lookup codes used in summary definitions.
  • CREATE_OTHER_KV, LOAD_ITEM_VALUE, and LOAD_ITEM_KEY_VALUE — construct and populate the key/value pairs that represent individual summary items, reading user-defined column, row, and instance metadata.
  • GET_ALTERNATE_VALUES and GET_BAND_VALUES — return alternate and banded (range) values respectively, supporting the tiering logic used in compensation and grading summaries.
  • GET_CAGR_VALUES — computes compound annual growth rate values, applied where trend and growth metrics are required.
  • GET_MONTH — a date/period helper that returns month-oriented values used in period-based calculations.

No parameter signatures are documented in the ETRM extract; callers should treat the internal contract as subject to change across patch levels.

Tables Accessed

The package reads the following objects through APPS synonyms:

  • PAY_USER_TABLES, PAY_USER_COLUMNS, PAY_USER_COLUMN_INSTANCES_F, and PAY_USER_ROWS_F — the flexible user-defined table framework that supplies the configurable columns, rows, and instances summarized by the package.
  • HR_LOOKUPS and FND_ID_FLEX_STRUCTURES_VL — lookup and key flexfield structure metadata used to resolve valid values and descriptive flexfield context.
  • PER_BUSINESS_GROUPS — establishes the business group context for the run.
  • DBMS_SQL, PLITBLM, and STANDARD — supplied PL/SQL and dynamic SQL infrastructure, indicating that the package builds and executes dynamic statements against the user-defined table structures.
  • FND_MESSAGE, HR_SUMMARY_API, HR_SUMMARY_KEY_VALUE, and HR_UTILITY — used for message handling and for delegating summary-specific processing to the core HR Summary API.

Usage Notes

HR_SUMMARY_UTIL is not intended for direct end-user invocation. It is called internally by the HR Summary framework and by HR_UTILITY, and ETRM records that it is referenced by five other packages while itself referencing none outside the documented list. Typical invocation is indirect: a summary definition is configured, a summary run is executed through the HR Summary concurrent program or the Summary API, and this utility performs the lookup, key/value, banding, and CAGR computations in support of that run. Custom code should call HR_SUMMARY_API rather than this utility, since its procedures are internal helpers whose signatures and behavior may change with patches. The package requires no grants beyond APPS and executes with the privileges of the calling user in the APPS schema.