Search Results expired_period_date

Overview

APPS.HR_JPDRB is a Japanese localisation package body within the Oracle E-Business Suite payroll schema. Its header comment block dates the source file to May 2004, and it remains a component of the Oracle Payroll Japanese legislation functionality in both EBS 12.1.1 and 12.2.2. The package supplies balance retrieval logic for the Japanese payroll environment, where statutory withholding and similar deductions depend on history-aware balance lookups rather than simple point-in-time queries.

The package's central design principle is expiry-aware retrieval. Rather than returning a stored balance unconditionally, HR_JPDRB determines whether the balance has expired relative to the assignment action and the effective (session) date supplied by the caller. Where expiry checking is required, the package navigates back to the last assignment action associated with the assignment, and uses the effective date passed in as the criterion for the expiry test. Balances that fail the expiry test are handled distinctly from those that pass, allowing the payroll engine to avoid applying stale values.

The header comments further indicate that balance values may not be held in the latest balances table alone; the package distinguishes between assignment-level and person-level balance processing. Where a route code is required, the balance type identifier and the balance dimension must both be known before HR_JPRTE and HR_ROUTES can be invoked. For person-level balances, the comments note that a substantial amount of calculation precedes any route resolution, and the package accordingly relies on HR_JPBAL rather than duplicating that logic.

Key Procedures and Functions

The documented API surface consists of five program units, qualified in ETRM as API classification OTHER, indicating that they are internal building blocks rather than published, customer-callable interfaces.

• GET_BALANCE — The primary retrieval routine. It returns a balance as a numeric value. The source confirms it accepts an assignment identifier, a defined balance identifier, and an effective date, and that it first establishes whether the balance exists in the latest balances table before applying expiry logic. The main body of the package is organised around this function, including a date-mode variant concerned with testing expiry before retrieval.
• BALANCE_EXPIRED — Reports whether a balance has expired. It supports the decision point described in the header comments, allowing callers to separate retrieval from the expiry judgement itself.
• EXPIRED_PERIOD_DATE — Derives the date associated with an expired period, providing the temporal boundary against which expiry is evaluated.
• GET_ACTION_DATE — Resolves the assignment action date context used by the expiry calculations, corresponding to the navigation back to the last sequence-generating assignment action described in the source comments.

No parameter lists are reproduced here, as the documented metadata does not enumerate them fully and they should not be inferred.

Tables Accessed

Five tables are documented as referenced through APPS synonyms:

• PAY_ASSIGNMENT_ACTIONS — Provides the most recent sequence-generating assignment action for the assignment and effective date, forming the basis of the expiry test.
• PAY_DEFINED_BALANCES — Identifies the defined balance being requested and supplies the definition attributes needed to resolve the correct dimension and balance type.
• PAY_BALANCE_DIMENSIONS — Supplies dimension information required before any route resolution can occur.
• PAY_PAYROLL_ACTIONS — Provides payroll action context associated with the balance and its effective dating.
• PER_TIME_PERIODS — Supplies the payroll period boundaries used in determining whether a balance falls within an expired period.

The calls to HR_JPBAL, HR_JPRTE, and HR_ROUTES noted in the source comments imply further indirect database activity through those sibling Japanese payroll packages.

Usage Notes

HR_JPDRB is not referenced by any other package according to the documented metadata, meaning it is not a shared utility invoked through the normal package call graph. It is therefore most plausibly invoked from Japanese payroll balance fast formulas, from payroll calculation routines, or from custom client extensions that require expiry-aware balance retrieval. The presence of an effective-date parameter and the date-mode retrieval variant indicate that callers must supply the session date appropriate to the payroll run or assignment action being processed; passing an incorrect date will alter the point at which the assignment action history is evaluated and may cause balances to be judged expired or current incorrectly. Because the package is classified as OTHER rather than as a public API, implementations should treat it as internal to the Japanese payroll localisation and validate behaviour against the specific EBS release and patch level in use, since the file header reflects a relatively early revision of the source.