Search Results show_formula_queue

Overview

The APPS.PAY_JP_MAG_UTILITY_PKG package body is a Japanese localization utility package shipped with Oracle E-Business Suite (available in both 12.1.1 and 12.2.2). It supports the Japanese Magnetic Media (MAG) payroll processing feature set, which is used to produce the electronic media and formatted files required for Japanese statutory payroll reporting and bank transfer processing. The utility package provides internal helper routines rather than a customer-facing API: its responsibilities include maintaining a debug queue for formulas processed by the MAG engine, managing an in-memory collection of runtime "contexts," and storing and retrieving parameter values used by the MAG formula evaluation logic. The package is classified as API classification OTHER, confirming that it is an internal technical component not intended for direct third-party integration.

The package is authored against the HR utility tracing framework (HR_UTILITY), and all routines set location markers through HR_UTILITY.SET_LOCATION for diagnostic tracing. Global state is held in package-level PL/SQL collections that persist for the duration of a database session.

Key Procedures and Functions

• SHOW_FORMULA_QUEUE — Debug procedure that iterates over the internal formula queue collection (g_formula_queue) and writes each stacked formula identifier to the HR trace output. It is documented explicitly as being for debug purposes only. The queue is walked using FIRST and NEXT on the associative array indexed by BINARY_INTEGER.
• ENQUEUE_FORMULA — Accepts a formula identifier and appends it to the package's internal formula queue, deriving the next index from NVL(g_formula_queue.LAST, 0) + 1. Used by the MAG processing engine to defer formula evaluation.
• DEQUEUE_FORMULA — Removes and returns the next formula from the queue, complementing ENQUEUE_FORMULA in the queue-based processing model.
• SHOW_CONTEXTS — Debug procedure that displays the currently registered runtime contexts held by the package.
• CLEAR_CONTEXTS — Removes all contexts from the in-memory context collection, resetting state between processing runs.
• SET_CONTEXT — Registers or updates a runtime context value used during formula evaluation.
• SHOW_PARAMETERS — Debug procedure that lists the parameter values currently held by the package.
• GET_PARAMETER — Retrieves a stored parameter value for use by the MAG calculation logic.
• SET_PARAMETER — Stores or updates a parameter value within the package's in-memory parameter store.

Thirteen documented procedures/functions exist in total; the remaining routines follow the same context/parameter pattern. No parameter lists are invented here, and the naming convention consistently reflects setter, getter, and diagnostic-display behavior.

Tables Accessed

The only documented table reference is PLITBLM, accessed through an APPS synonym. PLITBLM is the standard Oracle database table used internally by the PL/SQL interpreter. Because g_formula_queue is a BINARY_INTEGER-indexed associative array, PL/SQL requires that indices be sorted on demand, and the PL/SQL runtime uses PLITBLM to perform this sorting for indexed-by collections. This confirms that the package's queue traversal depends on collection semantics rather than on any payroll application table; the package does not read or write application data in the payroll schema.

Usage Notes

PAY_JP_MAG_UTILITY_PKG is invoked indirectly. It is referenced by one other package, which drives the Japanese MAG formula-processing flow: that caller enqueues formulas, sets contexts and parameters, then evaluates them, optionally calling the SHOW_* debug procedures to trace state. The package is not attached to a concurrent program or a form directly and carries no concurrent-program registration. Typical invocation therefore occurs from the parent MAG processing package during Japanese payroll runs, and from custom diagnostic scripts in development or support scenarios where tracing has been enabled through the HR utility framework. Because the queue, contexts, and parameters live in package global variables, all state is session-scoped and is lost when the session ends; callers must establish state within a single session. The SHOW_* procedures produce output only through HR_UTILITY trace, so enabling the appropriate HR tracing profile option is a prerequisite for observing their output.