Search Results pay_monitor_balance_retrieval




Overview
Explore in AI Chat

Overview

PAY_MONITOR_BALANCE_RETRIEVAL is an Oracle EBS PL/SQL package owned by the APPS schema and classified under the OTHER API category. It forms part of the Oracle Payroll product family, providing the supporting infrastructure used to capture and return payroll balance retrieval monitor information to the user interface layer. The package header, delivered under the file identifier pymnblrt.pkh, is an older artifact of the E-Business Suite codebase (the header revision reflects a 2005 build), yet it remains present in both 12.1.1 and 12.2.2 environments and continues to be referenced by dependent code.

The most distinctive aspect of the package is its internal session variable mechanism. The header declares two PL/SQL index-by tables, SessionVarNames and SessionVarValues, along with an EmptyTable construct used to null out tables because the certified PL/SQL level did not support DELETE on PL/SQL tables. Name and value pairs are limited to 64 characters each. Names are forced to upper case on both set and get operations, while values are stored verbatim. Because NEXT and LAST attributes were unavailable in pure WNDS functions at that PL/SQL level, NULL values are stored rather than skipped, which the original comment acknowledges can carry a performance cost when large numbers of variables are held.

Key Procedures and Functions

The package exposes a compact set of documented entry points:

  • SET_SESSION_VAR — Stores a name/value pair into the internal session variable tables. Names are upper-cased before storage; NULL names are rejected, but NULL values are accepted.
  • GET_SESSION_VAR — Retrieves the value previously stored against a given variable name. The name parameter is upper-cased before the lookup so that retrieval is case-insensitive with respect to the stored name.
  • CLEAR_SESSION_VARS — Resets the session variable state, releasing any names and values accumulated during the current session. This is the routine that users typically search for when investigating stale or residual session data.
  • MONITOR_BALANCE_RETRIEVAL — The principal business routine, responsible for performing or recording the balance retrieval monitoring activity for which the package is named.
  • OUTPUT_BAL_RETRIEVAL_DATA — Formats and emits the gathered balance retrieval data for consumption by the calling layer.

Parameter lists are deliberately not reproduced here; implementers should consult the package specification in the target environment for exact signatures.

Tables Accessed

The package operates against a single documented base table, PAY_MONITOR_BALANCE_RETRIEVALS, accessed through an APPS synonym. This table persists the records produced by the balance retrieval monitoring process. The session variable tables are PL/SQL in-memory constructs rather than database objects, so they impose no DDL or transactional overhead and are discarded when the session ends.

Usage Notes

The package is typically invoked from Oracle Payroll forms and from dependent PL/SQL code; the ETRM metadata records that it is referenced by one other package. Its session variable routines are useful when a form or process needs to carry short-lived state across calls within a single database session, with CLEAR_SESSION_VARS called at the end of that lifecycle to prevent residual values from leaking into subsequent operations. Because the implementation predates modern PL/SQL collection semantics, custom code extending the package should avoid relying on DELETE or NEXT/LAST behaviour against its internal tables, and should CLEAR_SESSION_VARS rather than manipulating the tables directly.