Search Results pay_jp_dimension_generator_pkg




Overview
Explore in AI Chat

Overview

PAY_JP_DIMENSION_GENERATOR_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the Japanese localization of Oracle Payroll. Its principal business function is the creation, maintenance, and regeneration of balance dimensions used by the Japanese payroll statutory reporting and calculation framework. Balance dimensions in Oracle Payroll HRMS define the "contexts" (such as assignment, tax unit, or predefined groupings) against which payroll balances are accumulated and reported. For Japan, statutory requirements oblige specific dimensional rollups — for example those tied to social insurance, labour insurance, and monthly withholding tax reporting — which are not delivered in the global balance dimension seed data. This package programs the automatic generation and update of those dimensions, together with the underlying Fast Formula route, parameter, and user-entity metadata that the payroll engine requires in order to evaluate and store Japanese statutory balances correctly.

The package is classified under the ETRM as API classification OTHER, indicating that it is an internal localization utility rather than a published public API. It is validated and present in both EBS 12.1.1 and 12.2.2, and it is not referenced by any other APPS package, confirming its role as a self-contained generator invoked from the Japanese payroll localization setup or patching layer.

Key Procedures and Functions

The package exposes eight documented procedures and functions:

  • START_DATE — returns or derives the effective start date used to bound the dimension generation window, ensuring dimensions are created with the correct date-tracked validity.
  • END_DATE — provides the corresponding end date for the generation or rebuild range.
  • CREATE_BALANCE_DIMENSION — creates a new balance dimension record, including the associated context usages required by the Japanese statutory definitions.
  • UPDATE_BALANCE_DIMENSION — modifies existing balance dimension definitions, typically to correct context, route, or date-tracked attributes.
  • REBUILD_PACKAGE — regenerates the dependent metadata (routes, parameters, user entities, and compiled formula information) so that the payroll engine recognises the new or amended dimensions.

These procedures are complemented by additional documented members of the package (eight in total) that house the shared date-tracked and Fast Formula metadata logic used by the create, update, and rebuild operations. No public parameter signatures are documented in the ETRM record; consumers should treat these as internal localization routines.

Tables Accessed

The package reads and writes the balance dimension core tables PAY_BALANCE_DIMENSIONS and its date-tracked shadow PAY_BALANCE_DIMENSIONS_S, together with PAY_BALANCE_CONTEXT_VALUES (the context combinations valid for each dimension) and PAY_DEFINED_BALANCES / PAY_ASSIGNMENT_LATEST_BALANCES, which store the accumulated results. It also manipulates the Fast Formula metadata layer: FF_FORMULAS_F, FF_COMPILED_INFO_F (compiled formula currency), FF_DATABASE_ITEMS and FF_FDI_USAGES_F (formula database item inputs and usage tracking), FF_ROUTES / FF_ROUTES_S, FF_ROUTE_CONTEXT_USAGES, FF_ROUTE_PARAMETERS / FF_ROUTE_PARAMETERS_S (route evaluation metadata), and FF_USER_ENTITIES. This broad footprint reflects that a balance dimension in HRMS exists simultaneously as a database row set and as a set of Fast Formula runtime metadata records.

Usage Notes

PAY_JP_DIMENSION_GENERATOR_PKG is normally invoked during Japanese payroll setup and post-patch processing — specifically, after localization patches that introduce or revise statutory balance definitions. It is intended to be run by a technical administrator with APPS-level privileges in a controlled maintenance window, because it writes directly to Fast Formula metadata and balance dimension tables and can therefore invalidate compiled formula caches. Executing it while payroll runs are in progress is not advisable. It is not exposed through a standard concurrent program in the documented metadata, so invocation is typically via a wrapper script or SQL*Plus session, frequently driven by the Japanese localization patch driver. Customizations should not call these procedures from bespoke payroll code; instead, they should consume the resulting dimensions through standard payroll balance reporting. The absence of references from other APPS packages confirms that no supported internal dependency requires the package to be running outside of setup activities.