Search Results is_quarter_allowed

Overview

OZF_TIME_API_PVT is a private PL/SQL package in the APPS schema that provides the shared time-dimension logic used throughout the Oracle E-Business Suite Trade Management (ETRM) modules. Trade Management analytics, forecasting, promotion planning, and allocation processing all operate against a period-based calendar model rather than raw transaction dates. OZF_TIME_API_PVT encapsulates the calendar arithmetic that these modules depend on, exposing functions that resolve period start dates, period end dates, period names, last-year-same-period (LYSP) equivalents, and period ID mappings. It also performs validation checks that determine whether a given time range or quarter is permissible under the configured ETRM calendar. Because it is a PVT (private) API, it is not intended for direct invocation by external integrations or end-user code; it exists to serve Oracle's own product packages and is documented here primarily so that implementers and support engineers can trace calendar-related behavior and diagnose dependency chains. The package is owned by APPS and is reported as VALID in the ETRM 12.2.2 documentation set.

Key Procedures and Functions

The ETRM metadata documents eight callable units within the package. Their purposes are as follows:

• GET_PERIOD_START_DATE — Returns the starting date of the period that contains or corresponds to the supplied calendar reference.
• GET_PERIOD_END_DATE — Returns the closing date of the corresponding period, complementing the start-date function for range construction.
• GET_PERIOD_NAME — Resolves the descriptive period label (for example, a fiscal period or quarter name) associated with a given time reference, used in reporting and UI display.
• GET_LYSP_PERIOD_NAME — Returns the period name for the last-year-same-period, the prior-year comparison period used in trend and year-over-year analysis.
• GET_LYSP_ID — Returns the internal identifier of the last-year-same-period, allowing dependent packages to join fact data to the prior-year period without recomputing date logic.
• GET_PERIOD_TBL — Returns a period collection or table structure, enabling callers to obtain multiple periods in a single call rather than iterating period by period.
• IS_QUARTER_ALLOWED — Validates whether quarter-level granularity is permitted for the calling context, reflecting ETRM calendar and setup constraints.
• IS_PERIOD_RANGE_VALID — Validates that a requested start-and-end period range is well formed and within the permitted calendar boundaries before processing proceeds.

The documentation does not publish parameter signatures; parameter lists should be confirmed by inspecting the package specification in the target instance.

Tables Accessed

The package reads from the ETRM time-dimension tables, accessed through APPS synonyms. The documented dependencies are OZF_TIME_DAY, OZF_TIME_WEEK, OZF_TIME_ENT_PERIOD, OZF_TIME_ENT_QTR, and OZF_TIME_ENT_YEAR, with DUAL used for single-row expression evaluation. These tables form the enterprise calendar hierarchy: day and week levels supply fine-grained date resolution, while the period, quarter, and year tables provide the rolled-up time entities that Trade Management planning and analytics rely on. Period names, period IDs, start and end dates, and last-year-same-period mappings are all derived from these tables. DUAL supports internal case expressions, date arithmetic, and default value generation. Because this is a private API, all table access is read-oriented; calendar maintenance is performed by separate ETRM setup and administration programs.

Usage Notes

OZF_TIME_API_PVT is invoked indirectly. The documented dependents are OZF_ALLOCATION_ENGINE_PVT, OZF_CUST_FACTS_PVT, OZF_TIME_API_PVT_W, and the public wrapper package OZF_TIME_API_PVT_W, which is the supported entry point for code outside the private layer. Practitioners typically encounter this package when debugging allocation runs, customer fact generation, forecasting buckets, or period-comparison reports that return unexpected period names or last-year values. When investigating such issues, confirm that the ETRM time dimension has been populated for the affected fiscal years; a missing or misaligned calendar row is a common root cause of incorrect start dates, end dates, or LYSP results. Because the private package may change between releases without public notice, custom code should call the public wrapper rather than referencing OZF_TIME_API_PVT directly. In 12.1.1 and 12.2.2 the object is reported VALID under the APPS schema.