Search Results hxc_recurring_periods_api




Overview
Explore in AI Chat

Overview

The APPS.HXC_RECURRING_PERIODS_API package is a public Oracle Time and Labor (OTL) application programming interface that manages the definition of recurring periods within the Time Store. Recurring periods are the reusable time containers that underpin timecard entry, approval processing, and overtime calculation across the OTL suite. The package allows the application to create, maintain, and remove the period definitions upon which time reporting cycles are built.

Because these definitions are consumed throughout the OTL application as Timecard Periods, Approval Periods, and Overtime Recurring Periods, the package occupies a foundational position in the Time and Labor data model. Periods defined here determine the boundaries against which timecards are validated, submitted, and approved. The package is licensed exclusively for use with Time and Labor and is classified as a public API under product HXT, with a display name of "Recurring Period". The header revision traces to hxchrpapi.pkh version 120.1.

Key Procedures and Functions

The package exposes three documented procedures, reflecting a conventional create-update-delete lifecycle for recurring period definitions:

  • CREATE_RECURRING_PERIODS — Inserts a new recurring period definition. The API generates the primary key, assigns the object version number, and records the period name, period type, and duration in days. When validation-only mode is requested, all checks are performed without modifying the database; otherwise, on success the record is committed to the store, and on failure the creation is rolled back and an application error is raised. The documented prerequisite is that the table PER_TIME_PERIOD_TYPES must already be populated before invocation.
  • UPDATE_RECURRING_PERIODS — Modifies the attributes of an existing recurring period, such as its name, period type, or duration, while maintaining the object version number used for optimistic locking and concurrent update detection.
  • DELETE_RECURRING_PERIODS — Removes a recurring period definition from the Time Store when it is no longer required for timecard, approval, or overtime processing.

All three procedures follow the standard OTL API conventions, including a validation flag that permits callers to exercise business rules without persisting changes.

Tables Accessed

The package operates on the HXC_RECURRING_PERIODS table, accessed through its APPS synonym, which stores the recurring period definitions managed by these APIs. In addition, the documentation identifies PER_TIME_PERIOD_TYPES as a prerequisite lookup table that must be populated before recurring periods can be created; this table supplies the period type values selectable during period definition. The primary key and object version number columns of HXC_RECURRING_PERIODS are surfaced directly through the API parameters, confirming that the package is the sanctioned write path for this entity.

Usage Notes

The package is typically invoked from Oracle Forms-based setup and administration pages within Time and Labor, from concurrent programs that mass-maintain period definitions, or from custom PL/SQL extensions requiring programmatic control over period setup. A search such as "tylan cada cuánto se aplica" (Spanish for "how often it is applied") points to the recurring nature of these periods: the duration and period type attributes defined through this API determine the cadence at which timecards, approvals, and overtime rules recur. Implementers configuring weekly, biweekly, or semi-monthly time reporting cycles therefore interact with this package, directly or indirectly, whenever a recurring period must be established, adjusted, or retired. Callers should supply the validation flag during testing to confirm business rules before committing changes, and should ensure PER_TIME_PERIOD_TYPES is seeded to avoid creation failures. The package is referenced by one other package, indicating that downstream OTL processes depend on its period definitions.