Search Results determine_pay_date

Overview

HXT_CLOCK_USER_EDITS is an Oracle EBS package body owned by the APPS schema and classified as an "OTHER" API within the OTM (Oracle Time and Labor, formerly Oracle Time Management/HXT) application family. Its source header dates to version 120.0 and reflects the 11i/12.x code line, so it is present in both EBS 12.1.1 and 12.2.2. The package exists to provide customer-overridable user exits for the time collection and clock-based data processing flow. Specifically, it addresses two policy decisions that vary from one enterprise to the next: how an entered "employee number" maps to a valid HR person record, and how the system determines the pay date (date worked) associated with a time punch. The package is written as a set of stub functions that deliver baseline, out-of-the-box behavior, with the explicit expectation that customers will replace the bodies to conform to their own definitions and business rules. The comments in the body make this intent clear, noting that "customers will have different definitions of what an Employee Number is" and that pay-date rules "will vary."

Key Procedures and Functions

• GET_PERSON_ID — Returns a valid PERSON_ID together with last name and first name for a supplied employee number, business group, and date worked. In the seeded base system it queries PER_PEOPLE_F using the input employee number, restricting by the effective date range and the business group. It returns a status code indicating success (0), no matching data found (1), or an unexpected error (2). This is the function directly relevant to the search term "get_person_id": it is the documented user exit through which customers redefine how an employee number resolves to a person.
• DETERMINE_PAY_DATE — Determines the date worked (pay date) that should be associated with a time punch, given the start time, end time, and person identifier. The Phase I implementation simply sets the date worked equal to the truncated start time. The body notes that future releases are intended to derive the date worked from the employee's work schedule, which is why the routine is exposed as an overridable function rather than hard-coded logic.

Tables Accessed

The only table documented as referenced by this package is PER_PEOPLE_F, the Oracle HRMS effective-dated person table (accessed through its APPS synonym). It is read by GET_PERSON_ID to resolve the employee number into a person_id, last_name, and first_name. The query filters on employee_number, business_group_id, and the effective start/end date range relative to the date worked, which ensures the correct effective-dated person record is returned. No inserts, updates, or deletes are performed; the package is strictly read-only with respect to the database. DETERMINE_PAY_DATE performs no table access in its Phase I form.

Usage Notes

HXT_CLOCK_USER_EDITS is invoked as a user exit during time-collection processing, typically when clock or timecard data is imported or validated and the system must translate an externally supplied employee number into an HR person and assign a date worked. Because the base package is a stub, customizations normally take the form of modifying the function bodies (or creating a replacement package) rather than calling the seeded version directly. The package is referenced by one other package in the ETRM metadata, confirming that it participates in an internal call chain rather than being driven by a standalone concurrent program or form. The return-code convention (0 = success, 1 = no data, 2 = error) allows the calling code to handle resolution failures gracefully. Implementers upgrading from 12.1.1 to 12.2.2 should re-verify any customized versions, since the OTM code line is shared and the header indicates an unchanged base revision.