Search Results hxc_generic_retrieval_utils




Overview
Explore in AI Chat

Overview

APPS.HXC_GENERIC_RETRIEVAL_UTILS is a PL/SQL package body in the Oracle E-Business Suite Time and Labor (HXC) module. It provides shared utility logic that supports the generic retrieval engine used to gather timecard data, evaluate retrieval rules, and assemble the inputs required by downstream Time and Labor processing. In EBS 12.1.1 and 12.2.2, retrieval rules and retrieval ranges determine which employees, assignments, time building blocks, and transactions are pulled into a timecard or adjustment run. This package supplies the low-level checks, parsing, and status management routines that the generic retrieval package and concurrent retrieval processes depend upon, rather than exposing end-user functionality directly.

Key Procedures and Functions

The documented interface exposes ten procedures and functions:

  • TIME_BLD_BLK_CHANGED — detects whether a time building block has been modified, supporting change detection during retrieval.
  • PARSE_RESOURCES — parses resource definitions used to drive retrieval selection logic.
  • CHK_RETRIEVE — evaluates whether retrieval should proceed for a given context.
  • SET_PARENT_STATUSES — updates parent-level statuses, propagating state through dependent retrieval structures.
  • RECOVERY — performs recovery logic, likely reinstating statuses after an interrupted or failed retrieval run.
  • CHK_TERMINATED — checks whether an employee or assignment is terminated, which affects retrieval eligibility.
  • GET_RET_CRITERIA — returns retrieval criteria assembled from the configured retrieval rules and rule components.
  • CHK_NEED_ADJ — determines whether an adjustment is required, tying into preference-based adjustment lines.
  • CHK_OTM_PREF — evaluates Oracle Time and Labor preference results relevant to retrieval.
  • ABSENCE_LINK_EXISTS — checks for the existence of absence linkage, connecting retrieval to absence type elements.

Tables Accessed

The package reads and writes several HXC tables through APPS synonyms. Retrieval configuration is sourced from HXC_RETRIEVAL_RULES, HXC_RETRIEVAL_RULE_COMPS, HXC_RETRIEVAL_RANGES, and HXC_RETRIEVAL_PROCESSES. Timecard and transaction data are handled via HXC_TRANSACTIONS, HXC_TRANSACTION_DETAILS, HXC_TIME_BUILDING_BLOCKS, and HXC_TIME_RECIPIENTS. Adjustment and preference logic references HXC_BEE_PREF_ADJ_LINES, HXC_PREFERENCE_EVALUATION, and HXC_MESSAGE_TYPE/HXC_MESSAGE_TABLE_TYPE. Absence linkage uses HXC_ABSENCE_TYPE_ELEMENTS. Concurrent program context comes from FND_CONCURRENT_PROGRAMS, FND_CONCURRENT_REQUESTS, and FND_APPLICATION, while PLITBLM is used for PL/SQL name resolution.

Usage Notes

HXC_GENERIC_RETRIEVAL_UTILS is invoked indirectly. It is called by HXC_GENERIC_RETRIEVAL_PKG and is referenced by four other packages, meaning it executes within the Time and Labor retrieval concurrent processes rather than from a direct user action. Administrators configure retrieval rules and ranges through the Time and Labor setup forms; the retrieval concurrent program then drives this utility package to validate eligibility, detect changes, apply preferences, and determine adjustments. Because it references HR_UTILITY and HXC_LOCK_API, it participates in locking and HR data validation during high-volume retrieval runs. Customizations should avoid modifying this package body directly; extensions are safer when built on the documented public procedures or on the higher-level generic retrieval entry points.