Search Results get_retro_batch_id




Overview
Explore in AI Chat

Overview

HXT_UTIL is a shared PL/SQL utility package owned by the APPS schema in Oracle E-Business Suite Release 12.1.1 and 12.2.2. It supports the Oracle Time and Labor (OTL) and related Human Resources modules by centralizing low-level helper routines that would otherwise be duplicated across the timecard, time collection, and payroll integration code paths. In the ETRM (E-Business Suite Technical Reference Manual) classification scheme it is designated an API classification of UTIL, meaning it exposes no public business API contract but supplies reusable building blocks consumed internally by other packages, forms, and concurrent programs.

The package is foundational rather than functional: it does not own business transactions, but it supplies date arithmetic, absence validation, error logging, holiday detection, sequence generation, batch construction, and concurrent request submission services that higher-level time and labor modules depend upon. The documented metadata records 31 procedures and functions and notes that the package is referenced by 19 other packages, confirming its role as a horizontal utility layer across the OTL schema.

Key Procedures and Functions

The documented callable units fall into several functional groupings.

  • DEBUG — Writes diagnostic text during development or troubleshooting, giving developers a lightweight trace mechanism.
  • GEN_ERROR — Two overloads that record errors against timecard, time entry rule, payroll time period, and related identifiers, capturing the error message, location, underlying Oracle message, effective dates, and error type.
  • CHK_ABSENCE — Validates absence balances for an assignment and period, returning net amount, period amount, available amount, and absence status via OUT parameters.
  • SUBMIT_REQ — Submits concurrent programs programmatically, accepting a program name, description, message, location, and up to fifty parameter placeholders.
  • CHECK_FOR_HOLIDAY — Determines whether a given date falls on a holiday per the applicable calendar.
  • FND_USERNAME — Resolves an FND user identifier to a display name.
  • ELEMENT_CAT — Retrieves the element classification associated with a time or payroll element.
  • CHECK_POLICY_USE and GET_POLICIES — Inspect earning policy usage and retrieve applicable policy definitions.
  • GET_SHIFT_INFO — Returns shift definition attributes for time collection logic.
  • ROUND_TIME and TIME_TO_HOURS — Perform time rounding and unit conversion between time and decimal hours.
  • GET_NEXT_SEQNO — Allocates the next sequence value for internal numbering.
  • GET_PERIOD_END, GET_PERIOD_START, and DATE_RANGE — Supply period boundary and range computation helpers.
  • GET_RETRO_BATCH_ID and CREATE_BATCH — Manage retroactive and processing batch identity and creation.
  • GEN_EXCEPTION — Raises or records exceptions in a standardized form.
  • BUILD_COST_ALLOC_FLEX_ENTRY — Constructs cost allocation key flexfield entries for downstream costing.

Tables Accessed

HXT_UTIL reads and writes through APPS synonyms across the time and labor schema. Timecard and summarized hours data are accessed in HXT_TIMECARDS_F, HXT_DET_HOURS_WORKED_F, and HXT_SUM_HOURS_WORKED_F. Holiday processing depends on HXT_HOLIDAY_CALENDARS and HXT_HOLIDAY_DAYS, while rotation and shift logic uses HXT_ROTATION_SCHEDULES and HXT_SHIFTS. Error handling writes to HXT_ERRORS_F, and earning policy validation reads HXT_EARNING_POLICIES. Batch management touches HXT_BATCH_STATES, and internal numbering uses HXT_SEQNO. Time building blocks are read from HXC_TIME_BUILDING_BLOCKS. EBS foundation tables FND_USER, FND_LOOKUP_VALUES, and FND_ID_FLEX_STRUCTURES supply user names, lookup meanings, and flexfield structure metadata.

Usage Notes

HXT_UTIL is invoked internally by OTL forms, time collection concurrent programs, and the 19 dependent packages rather than being called directly by end users. Its SUBMIT_REQ function is particularly valuable for custom code that must launch payroll or time-related concurrent requests with dynamic parameters, and GEN_ERROR is the standard mechanism for persisting failures against timecard rows so they surface in OTL error views. Because it is a UTIL-classified package, Oracle does not guarantee API stability across patches; customizations should treat each signature as version-specific and validate behavior after applying OTL patches or upgrading between 12.1.1 and 12.2.2.