Search Results return_business_group_id

Overview

APPS.HR_API is a foundational PL/SQL package body within Oracle E-Business Suite Release 12.1.1 and 12.2.2 that centralizes shared utility logic for the Human Resources (HRMS) product family. Rather than serving a single business transaction, HR_API functions as a common service layer: it provides argument validation, business group and legislation context resolution, security group handling, key flexfield segment processing, and lookup validation helpers that hundreds of other HR and non-HR APIs call. The package is a member of the APPS schema and is classified as an API in the ETRM repository. Its internal global variables — including g_legislation_code, g_business_group_id, g_session_context, and flags such as g_call_cus_api_hooks and g_call_leg_api_hooks — demonstrate that it also governs hook invocation and initialization semantics for the R12 architecture. With a documented call graph referencing 8,629 dependent packages and a header version of 120.4, HR_API is one of the most widely reused objects in the EBS data model, underpinning the consistent behavior of employee, payroll, and organization APIs.

Key Procedures and Functions

The documented interface comprises 35 procedures and functions. The principal groups include:

• Error handling: MANDATORY_ARG_ERROR and ARGUMENT_CHANGED_ERROR raise standardized HRMS error messages when required arguments are null or improperly supplied during an API call.
• Context resolution: RETURN_BUSINESS_GROUP_ID, VALIDATE_BUS_GRP_ID, and RETURN_LOOKUP_CODE resolve and validate the business group, legislation, and lookup context that most HR APIs require.
• Security and flexfield utilities: SET_SECURITY_GROUP_ID, STRIP_CONSTRAINT_NAME, and RETURN_CONCAT_KF_SEGMENTS manipulate security group context and key flexfield segment concatenations for descriptive and key flexfield processing.
• Lookup existence checks: NOT_EXISTS_IN_HR_LOOKUPS, NOT_EXISTS_IN_LEG_LOOKUPS, NOT_EXISTS_IN_HRSTANLOOKUPS, NOT_EXISTS_IN_FND_LOOKUPS, and their _DT_ counterparts validate lookup codes against HR, legislation, HR standard, and FND lookup tables respectively.
• Commit and installation checks: RETURN_COMMIT_UNIT, VALIDATE_COMMIT_UNIT, CANNOT_FIND_PROG_UNIT_ERROR, and HR_INSTALLED support transactional boundary determination and product installation verification.

These routines are invoked internally by HRMS APIs and are not typically called directly by end users.

Tables Accessed

HR_API queries and references several core EBS tables through APPS synonyms:

• FND_PRODUCT_INSTALLATIONS — used by HR_INSTALLED to verify that Oracle HRMS is installed and licensed.
• FND_LANGUAGES — consulted for language and territory context during lookup and legislation resolution.
• FND_ID_FLEX_STRUCTURES and FND_ID_FLEX_SEGMENTS — read during key flexfield concatenation and segment stripping logic.
• HR_ORGANIZATION_INFORMATION — accessed to resolve organization-level business group and legislation attributes.
• DBMS_LOCK and DBMS_SESSION — Oracle-supplied packages used for locking and session context management rather than application tables.

Usage Notes

HR_API is an internal infrastructure API. It is invoked automatically by higher-level HRMS APIs, forms, and concurrent programs whenever business group, legislation, or lookup context must be resolved or validated. The initialize-oriented globals (g_session_context, g_legislation_code, g_business_group_id) indicate that the package participates in R12 session initialization, echoing the pattern introduced in file version 120.2. Custom code extending Oracle HRMS should call the public HRMS business APIs rather than HR_API directly, although the validation helpers may be referenced where consistent error semantics are required. Because the package is referenced by thousands of dependent objects, modifications are governed by Oracle's API compatibility rules and should never be altered without a supported patch or extension strategy.