Search Results create_recurring_periods




Overview
Explore in AI Chat

Overview

The APPS.HXC_RECURRING_PERIODS_API package body provides the business logic layer for maintaining recurring period definitions within Oracle E-Business Suite. Recurring periods describe repeating time intervals — such as weekly, bi-weekly, or monthly cycles defined by a duration in days, a start date, and an optional end date — that are used by time and labor, scheduling, and related applications to generate or validate timecard and shift data. The package exposes a small, focused set of DML-style APIs that encapsulate row creation, modification, and removal against the HXC_RECURRING_PERIODS entity, while delegating the underlying table maintenance to the generated table handler and the _bk_1 business logic hooks.

As an ETRM-classified API (classification: API), the package is designed to be called directly from PL/SQL rather than executed only through internal forms logic, and its procedures follow the standard Oracle HRMS API conventions: a p_validate flag for trial execution, IN OUT NOCOPY primary key and object version parameters, and date parameters whose time components are truncated before processing. Debug tracing is emitted through hr_utility.set_location when the HR debug facility is enabled, and each write operation opens a savepoint to support rollback on error.

Key Procedures and Functions

  • CREATE_RECURRING_PERIODS — Inserts a new recurring period definition. It accepts the period name, period type, duration in days, start date, optional end date, and optional effective date, returning the generated recurring period identifier and object version number. The procedure truncates time portions from all inbound date parameters, opens a savepoint, invokes the before-process user hook, performs validation, and persists the row.
  • UPDATE_RECURRING_PERIODS — Modifies an existing recurring period row identified by its primary key and current object version number. This is the procedure associated with the search term update_recurring_periods. It applies the same validation, savepoint, hook, and date-truncation conventions as the create operation and returns the incremented object version number for optimistic concurrency control.
  • DELETE_RECURRING_PERIODS — Removes a recurring period definition, again keyed on the row identifier and object version number, subject to the same validation and hook pattern. Deletion typically raises errors if the period is referenced by dependent data, and the savepoint ensures the operation can be rolled back cleanly.

Tables Accessed

The package operates on a single documented table, HXC_RECURRING_PERIODS, accessed through its APPS synonym. This table stores the recurring period identifier, object version number, name, period type, duration in days, and the start and end dates that define each cycle. All three procedures read and write this table: create inserts, update modifies, and delete removes rows. Validation routines and the before-process hooks read existing rows to enforce uniqueness and referential rules before the table handler commits changes.

Usage Notes

This package is normally invoked from PL/SQL in three contexts: Oracle Forms-based maintenance screens that manipulate recurring periods, concurrent or batch programs that load period definitions from external sources, and custom extensions that require programmatic control over recurring period setup. Callers should always supply p_validate = TRUE first to validate inputs without committing, then re-invoke with p_validate = FALSE to persist. The object version number returned by each call must be retained and passed back on subsequent updates or deletes to detect concurrent modification. Because the package relies on hr_utility tracing and business logic hooks, the HR debug profile option and any customer-defined hook implementations in the _bk_1 package should be configured before use. Referenced by one other package, it should be treated as a stable interface within the HXC schema in both 12.1.1 and 12.2.2.