Search Results upd_act_enc_bal
Overview
The APPS.GMS_SWEEPER package is a member of the Oracle Grants Management (GMS) module within Oracle E-Business Suite, having been present since the earliest 11i releases and remaining largely unchanged through 12.1.1 and 12.2.2. Its primary business function is to "sweep" and update actual and encumbered award balances — that is, to reconcile, roll up, or refresh the balance records that represent summarized award activity. This supports the grants accounting cycle by ensuring that encumbrance and actual amounts posted against an award remain consistent with the underlying distributions, burden components, and period-status information before downstream processes such as award reporting, billing, or period close are executed.
The package is declared AUTHID CURRENT_USER, meaning that it executes with the privileges of the calling schema rather than the definer, a convention consistent with many GMS public APIs that must honor the caller's grants and security context. It is a documented member of the ETRM (E-Business Suite Technical Reference Manual) repository, with an API classification of OTHER.
Key Procedures and Functions
The ETRM metadata documents exactly one procedure for this package.
- UPD_ACT_ENC_BAL — The sole documented routine. As its name suggests, it updates actual and encumbered balances. It is the workhorse procedure of the sweeper and is responsible for recalculating or refreshing balance rows associated with award activity. It accepts an error buffer and return code (
errbuf,retcode), which signals that it is designed to be callable in a concurrent-program context. It also exposes optional selection parameters, including a packet identifier, a mode flag, and optional project and award identifiers, allowing the caller to scope the sweep to a particular packet, project, or award rather than processing the entire population.
No other procedures or functions are documented, and the package body itself is short, confirming that UPD_ACT_ENC_BAL is the exclusive entry point exposed to callers.
Tables Accessed
The package touches a broad set of GMS base tables, all referenced through APPS synonyms. These include:
- GMS_AWARDS, GMS_AWARDS_ALL — award headers, providing the governing award context and organization-level definition.
- GMS_BALANCES — the central balance table that the sweeper updates.
- GMS_AWARD_DISTRIBUTIONS — distribution lines that feed the actual and encumbered amounts.
- GMS_AWARD_EXP_TYPE_ACT_COST — expenditure type to actual cost mappings used to categorize activity.
- GMS_BURDEN_COMPONENTS — burden/indirect cost components applied to distributions.
- GMS_BUDGET_VERSIONS — budget version definitions that frame baseline and budget comparisons.
- GMS_SUMMARY_PROJECT_FUNDINGS — summarized funding records at the project level.
- GMS_BC_PACKETS, GMS_BC_PACKET_ARRIVAL_ORDER — billing and costing packet structures, indicating the sweep may be scoped to a specific packet.
- GMS_BILLING_CANCELLATIONS — cancellation records that affect what should remain in the balances.
- GMS_INSTALLMENTS — award installment schedules.
- GMS_EVENT_ATTRIBUTE, GMS_EVENT_INTERSECT — event-attribute and intersection data used in event-driven processing.
- GL_PERIOD_STATUSES — General Ledger period statuses, ensuring the sweep respects open/closed accounting periods.
Usage Notes
Because UPD_ACT_ENC_BAL exposes errbuf and retcode parameters, it is structured as a concurrent-program compatible routine. It is typically invoked from a concurrent program registered against this package, from Grants Management forms that need to refresh award balances on demand, or from custom PL/SQL that requires a scoped (by project, award, or packet) balance recalculation. Three other packages reference it, confirming its role as a shared utility within the GMS balance-processing chain. When invoking it directly, callers should supply valid project or award identifiers and confirm that the relevant GL periods are open, since closed-period rows are filtered through GL_PERIOD_STATUSES.