Search Results gmp_calendar_api




Overview
Explore in AI Chat

Overview

GMP_CALENDAR_API is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite, classified as an API. It provides the central programmatic interface for querying and validating manufacturing and production calendar definitions stored in the Oracle Bills of Material calendar tables. Its primary business purpose is to answer calendar-related questions for downstream Oracle Process Manufacturing (OPM) and manufacturing execution logic: whether a given moment is a working day or working time, what dates fall within a contiguous production window, and which dates represent valid work days across a calendar. Because production scheduling, resource capacity planning, and shop-floor transaction posting all depend on accurate calendar interpretation, this package serves as the reusable foundation that other OPM modules call rather than reimplementing calendar arithmetic themselves. The package body is documented as VALID in ETRM for both 12.1.1 and 12.2.2, and it is referenced by seven other database objects, confirming its role as a shared dependency in the manufacturing calendar layer.

Key Procedures and Functions

The documented public interface exposes nine procedures and functions:

  • IS_WORKING_DAY — Determines whether a specified date qualifies as a working day on a given calendar.
  • IS_WORKING_DAYTIME — Extends the working-day test to a specific date and time, evaluating whether a moment falls within an active shift interval.
  • GET_CONTIGUOUS_PERIODS — Returns contiguous working periods, allowing callers to identify uninterrupted production windows.
  • GET_ALL_DATES — Retrieves the full set of dates associated with a calendar, typically over a caller-supplied range.
  • GET_WORK_DAYS — Returns the dates that are valid working days for a calendar.
  • GET_WORKDAY_DETAILS — Supplies detailed attributes for work days, such as shift-level information.
  • GET_NEAREST_WORKDAYTIME — Locates the nearest valid working day and time relative to a supplied reference point, useful for scheduling offsets.
  • RETRIEVE_CALENDAR_DETAIL — Returns the underlying detail records that define a calendar's shifts and dates.
  • LOG_MESSAGE — Provides internal diagnostic logging, consistent with the package's dependency on FND_FILE and FND_MSG_PUB.

No parameter lists are documented in the ETRM metadata, and none are asserted here.

Tables Accessed

The package reads calendar definitions from the Oracle Bills of Material calendar tables. BOM_CALENDARS holds the calendar header defining a named calendar; BOM_SHIFT_DATES stores the date-level shift assignments and exceptions; and BOM_SHIFT_TIMES stores the shift time intervals used to evaluate working time. GMP_CALENDAR_DETAIL_GTMP is a global temporary table used to stage or accumulate calendar detail results during processing. DUAL is used for single-row evaluations and PLITBLM is the standard PL/SQL integer-table type used for collection handling. The package also depends on FND_API, FND_FILE, FND_MESSAGE, and FND_MSG_PUB for API error handling and message logging.

Usage Notes

GMP_CALENDAR_API is normally invoked from other PL/SQL packages and concurrent programs rather than directly by end users. The ETRM dependency listing confirms it is referenced by seven database objects and is not referenced by any other object in the reverse direction, marking it as a leaf-level utility in the dependency chain. Typical invocations occur during production scheduling, capacity checks, resource availability calculations, and shop-floor transaction validation, where a caller must confirm whether a requested date or time is inside a working window before posting or planning. Customizations should call the documented API routines instead of querying the BOM calendar tables directly, since the package encapsulates exception handling, shift logic, and FND message integration. Because calls may rely on the FND_API messaging stack, callers should initialize and check the message stack appropriately, and should avoid invoking the package from contexts where the standard FND logging facilities are unavailable.