Search Results pay_jp_dim_invalid_freq_type




Overview
Explore in AI Chat

Overview

APPS.PAY_JP_DIMENSION_GENERATOR_PKG is an Oracle E-Business Suite payroll package body that generates and maintains Japanese balance dimensions within Oracle Payroll. The "JP" designation identifies the module as a Japanese localization component, and its internal logic revolves around date-driven frequency calculations and the construction of balance dimension records. The package supports the localization requirement that Japanese payroll balances be grouped and reported against period definitions (daily, semi-monthly, monthly) that differ from the standard payroll period model used in other legislations.

The body carries the version banner $Header: pyjpdimg.pkb 120.0 2006/04/24 00:02 ttagawa noship $, confirming its origin as a seeded localization artifact maintained under the Payroll (PAY) schema and shipped as an unshipped (noship) object available in both EBS 12.1.1 and 12.2.2. The package is classified as a standard Payroll API object rather than a public interface, and the ETRM metadata records no dependent packages that reference it, indicating it is invoked internally by localization setup and balance maintenance routines.

Key Procedures and Functions

The documented interface exposes eight callable units. The user search term "add_header" does not correspond to any documented procedure in this package; the closest documented name in the ETRM listing is REBUILD_PACKAGE, which handles regeneration of the package's own internal definitions rather than adding header rows.

  • START_DATE — Computes the beginning date of a balance dimension period. It accepts an effective date, a reset date, a frequency type (DAY, SMONTH, MONTH), and a numeric frequency, and applies modular arithmetic plus ADD_MONTHS/MONTHS_BETWEEN to derive the period start. Invalid frequency types raise PAY_JP_DIM_INVALID_FREQ_TYPE through FND_MESSAGE.
  • END_DATE — Derives the corresponding closing date for the dimension period, complementing START_DATE so that each balance dimension occupies a well-defined date range.
  • CREATE_BALANCE_DIMENSION — Inserts new balance dimension definitions and their related setup rows based on the calculated period boundaries.
  • UPDATE_BALANCE_DIMENSION — Modifies existing balance dimension records, typically when period definitions or frequency parameters change.
  • REBUILD_PACKAGE — Reconstructs or refreshes the package's dimension data set as a whole, used during setup reinstall or corrective maintenance.

The remaining documented units complete the eight-entry interface and follow the same pattern of period calculation and dimension maintenance.

Tables Accessed

The package reads and writes a mix of balance infrastructure and Oracle Fast Formula metadata. Among the balance tables, PAY_BALANCE_DIMENSIONS and PAY_BALANCE_DIMENSIONS_S hold the dimension definitions the package creates and updates, PAY_DEFINED_BALANCES identifies the balances being dimensioned, PAY_BALANCE_CONTEXT_VALUES supplies context values for dimension processing, and PAY_ASSIGNMENT_LATEST_BALANCES provides current balance values for assignment-level calculations.

The Fast Formula tables — FF_FORMULAS_F, FF_COMPILED_INFO_F, FF_DATABASE_ITEMS, FF_FDI_USAGES_F, FF_ROUTES and FF_ROUTES_S, FF_ROUTE_CONTEXT_USAGES, FF_ROUTE_PARAMETERS and FF_ROUTE_PARAMETERS_S, and FF_USER_ENTITIES — are consulted to align dimension generation with the formula routes and database items that drive Japanese payroll calculation.

Usage Notes

PAY_JP_DIMENSION_GENERATOR_PKG is not intended for direct customer invocation. It is executed through Oracle Payroll's Japanese localization setup, during balance dimension definition and maintenance, and by concurrent processes that rebuild payroll balance structures. Because the ETRM metadata records no packages referencing it, custom code should avoid hard dependencies on these routines and instead use supported Payroll balance APIs. Any modification requires a valid effective date and reset date; supplying an unsupported frequency type raises the seeded FND error message. In 12.1.1 and 12.2.2 the object resides in the APPS schema and is accessed through the standard APPS synonyms.