Results for “set_batch_status”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

HXT_BATCH_PROCESS is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the Oracle Time and Labor (OTL) batch processing and payroll transfer flow. Its primary responsibility is to assemble, validate, and merge timecard batches and to drive their transfer into Oracle Payroll through the Pay Batch mechanism. The package is classified as an "OTHER" API in ETRM, indicating it is an internal utility rather than a publicly supported interface, and it is referenced by eight other packages within the OTL and payroll integration stack. The package header (hxtbat.pkh, version 120.4, last modified 2007) defines several collection types used to stage validated timecards and empty batches before processing, reflecting its role as a data aggregation and movement engine between Time and Labor and Payroll.

Key Procedures and Functions

The package exposes fifteen documented procedures and functions. Among the most significant:

• MERGE_BATCHES — provided as both a function and a procedure, this routine consolidates multiple source batches into a single target batch. The function form returns a profile option value, while the procedure form accepts a merge batch name, a table of validated timecards, a table of empty batches to be deleted, and a business group identifier.
• MAIN_PROCESS — the primary driver that orchestrates the batch processing sequence, invoking validation, transfer, and error handling routines in order.
• SET_BATCH_STATUS — updates the status of a batch in HXT_BATCH_STATES, transitioning it through the processing lifecycle. This is the routine most commonly referenced in troubleshooting queries.
• TRANSFER_TO_PAYROLL — moves validated timecard data into the payroll batch structures for costing and payment processing.
• SUM_TO_MIX — aggregates summarized hours into the mix used for payroll transfer.
• ROLLBACK_PAYMIX — reverses a payroll mix operation, restoring prior batch state.
• INSERT_PAY_BATCH_ERRORS, DEL_PRIOR_ERRORS, and CALL_GEN_ERROR2 — manage the collection, clearing, and generation of error messages associated with batch processing.
• GET_LOOKUP_CODE and GET_INPUT_VALUE_DETAILS — retrieve lookup values and input value details required during validation.
• DTL_TO_BEE and SNAP_RETRIEVAL_DETAILS — support detail-to-BEE conversion and snapshotting of retrieval details.
• GET_UPGRADE_STATUS — reports upgrade state for batch data.

Tables Accessed

The package reads and writes across the Time and Labor and Payroll schemas through APPS synonyms. Core timecard and batch tables include HXT_TIMECARDS_F, HXT_BATCH_STATES, HXT_DET_HOURS_WORKED_F, and HXT_SUM_HOURS_WORKED_F. Payroll batch structures accessed include PAY_BATCH_HEADERS, PAY_BATCH_LINES, PAY_ACCRUAL_PLANS, HXC_RET_PAY_DETAILS, and HXC_RET_PAY_LATEST_DETAILS. Supporting lookups and configuration tables include FND_LOOKUP_VALUES, FND_PROFILE_OPTION_VALUES, FND_USER, FND_DESCR_FLEX_COLUMN_USAGES, FND_DESCR_FLEX_CONTEXTS, and HXC_DATA_SETS. These accesses support staging, validation, status transition, and payroll transfer.

Usage Notes

HXT_BATCH_PROCESS is invoked internally by OTL batch processing concurrent programs and by the Time and Labor batch entry forms rather than being called directly by end users. The SET_BATCH_STATUS routine is frequently referenced in diagnostic queries to determine why a batch remains in a pending or error state. Customizations that modify batch behavior should avoid direct calls to MAIN_PROCESS and instead use the supported OTL public APIs, since the package is classified as OTHER and its signatures may change between patch levels. The presence of the g_user_id global, initialized from FND_GLOBAL.User_Id, indicates the package records audit columns using the current session user.