Search Results debug_toggle




Overview

PAY_US_BALANCE_VIEW_PKG is a United States payroll balance inquiry package owned by the APPS schema in Oracle E-Business Suite. Its source, header pybaluev.pkh, originated in October 1997 and was maintained through release 11i (last header revision 115.7, February 2004). The package provides the server-side logic used to display and navigate payroll balance information for US legislative and assignment-level reporting, particularly balances derived from the PAY_ASSIGNMENT_LATEST_BALANCES and PAY_BALANCE_* schema. Within ETRM it is classified as OTHER, indicating it is an internal supporting package rather than a public, supported API.

The package declares a LatBal record type that mirrors columns of PAY_ASSIGNMENT_LATEST_BALANCES (latest_balance_id, assignment_action_id, value, action_sequence and effective date), reflecting its central role in presenting the most recent balance for an assignment. It also defines GRE (Government Reporting Entity) record and table types, and a source identifier context added in version 110.3.

Key Procedures and Functions

The documented interface exposes 43 subprograms. The most relevant to the search term "get_view_mode" are the view-mode accessors:

  • GET_VIEW_MODE — returns the current view mode held in the package session state. The view mode governs how balance data is filtered or presented (for example, by assignment versus by organizational or GRE context) during an inquiry session.
  • SET_VIEW_MODE — establishes the view mode for the current session so that subsequent balance retrieval and navigation calls honour the selected presentation context.

Session state is managed by a further set of utilities:

  • SET_SESSION_VAR, GET_SESSION_VAR, CLEAR_SESSION_VARS — maintain package-level session variables, including the GRE table and source-id context, across calls within a database session.
  • DEBUG_* familyDEBUG_INIT, DEBUG_WRAP, DEBUG_SET_MAX, DEBUG_ON, DEBUG_OFF, DEBUG_RESET, DEBUG_DUMP, DEBUG_DUMP_TO_TRACE, DEBUG_DUMP_ERR, DEBUG_DUMP_LIKE, DEBUG_GET_LINE, DEBUG_GET_COUNT, DEBUG_MSG, DEBUG_ERR and DEBUG_TOGGLE provide conditional diagnostic tracing. The trace dump routine was modified in 1998 to accept a trace identifier.
  • Historically the package also declared goto_per_latest_balances, goto_asg_latest_balances, goto_route and run_route, which performed balance navigation and GRE date-range routing. These declarations were removed in version 115.7 (bug 3331035), and callers should not depend on them. Per documented practice, the get_value style functions no longer carry PRAGMA definitions.

    Tables Accessed

    The package reads and writes data through APPS synonyms, including:

    Usage Notes

    PAY_US_BALANCE_VIEW_PKG is referenced by approximately 50 other packages and is typically invoked indirectly rather than called directly by end users. It is exercised from Oracle Forms-based US payroll balance inquiry windows, where the form sets and reads the view mode and session variables as the user navigates balance results. Concurrent programs and custom PL/SQL that require US assignment-level latest balance presentation may also call these entry points, but because the package is classified as OTHER and is not a supported public API, direct dependencies in custom code should be avoided where a supported alternative exists. Debugging should be enabled with the DEBUG_ON/DEBUG_OFF and DEBUG_DUMP_TO_TRACE routines during diagnostics only.