Search Results chk_otm_pref




Overview
Explore in AI Chat

Overview

The APPS.HXC_GENERIC_RETRIEVAL_UTILS package is a core utility within the Oracle E-Business Suite Time and Labor (OTL) architectural stack, specifically belonging to the HXC (Time and Labor) application schema. Its fundamental business function is to support the Time and Labor retrieval process, which is the mechanism by which employee time and attendance data is gathered from various source systems or interfaces and validated against retrieval rules and criteria before being processed. This package provides the programmatic infrastructure for evaluating retrieval rules, validating time building block data, checking preferences, and determining whether adjustments or retrievals are necessary. The package's header, last updated in 2008 and delivered through the 12.1.1 and 12.2.2 code lines, defines a comprehensive set of PL/SQL record and table types that model retrieval ranges, retrieval rules, resources, outcomes, and preference evaluations. These data structures underpin the logic used across the Time and Labor retrieval engine, enabling consistent and reusable handling of the complex temporal and rule-based data inherent in time recording systems.

Key Procedures and Functions

The package exposes ten documented procedures and functions that collectively implement retrieval validation and decision logic:

  • TIME_BLD_BLK_CHANGED — The procedure most directly associated with the user's search term. It is used to determine or record whether a time building block has changed, which is critical for triggering reprocessing or retrieval events.
  • PARSE_RESOURCES — Populates and organizes the collection of resources (via the t_resource type) for subsequent retrieval evaluation.
  • CHK_RETRIEVE — Evaluates whether a retrieval should occur for a given set of criteria or time building block.
  • SET_PARENT_STATUSES — Manages and updates the status of parent records within the time building block hierarchy.
  • RECOVERY — Provides recovery handling logic, likely for failed or interrupted retrieval processes.
  • CHK_TERMINATED — Determines whether a time recipient or resource has a terminated status, affecting retrieval eligibility.
  • GET_RET_CRITERIA — Retrieves the applicable retrieval criteria based on configured rules and ranges.
  • CHK_NEED_ADJ — Determines whether an adjustment is required for a given time record.
  • CHK_OTM_PREF — Checks OTM (Oracle Time and Labor) preferences, populating the t_pref collection structure.
  • ABSENCE_LINK_EXISTS — Verifies the existence of an absence linkage, supporting integration between time records and absence management.

These routines are declared alongside supporting record types such as r_ret_ranges, r_ret_rule, r_rtr_outcome, and their corresponding index-by tables.

Tables Accessed

The package reads and writes against the principal Time and Labor tables via APPS synonyms. HXC_TIME_BUILDING_BLOCKS is the central transactional table for time entries and is heavily referenced for resource, start time, and stop time attributes. HXC_TIME_RECIPIENTS identifies the individuals or entities for whom time is recorded. Retrieval configuration and evaluation rely on HXC_RETRIEVAL_PROCESSES, HXC_RETRIEVAL_RANGES, HXC_RETRIEVAL_RULES, and HXC_RETRIEVAL_RULE_COMPS, which define how and when data is retrieved. HXC_TRANSACTIONS and HXC_TRANSACTION_DETAILS capture transactional outcomes, while HXC_ABSENCE_TYPE_ELEMENTS supports absence linkage checks. HXC_BEE_PREF_ADJ_LINES relates to preference-based adjustment lines. Oracle Application Object Library tables FND_APPLICATION, FND_CONCURRENT_PROGRAMS, and FND_CONCURRENT_REQUESTS provide application and concurrent program context. PLITBLM is used as a generic PL/SQL index-by table storage facility.

Usage Notes

This package is not intended for direct end-user invocation but is called internally by the Time and Labor retrieval engine, referenced by four other packages within the HXC schema. It is typically invoked during concurrent program execution—particularly retrieval and time processing concurrent programs—and from within Time and Labor forms that trigger retrieval or status recalculation. TIME_BLD_BLK_CHANGED and its companion routines would be invoked whenever a time building block is inserted or updated and change detection is required to decide whether downstream retrieval, status, or adjustment logic must be re-executed. Customizations should treat this package as an internal API; direct modification is unsupported, and any custom code should call it only within the boundaries established by Oracle's documented Time and Labor extension points.