Results for “gms_sweeper”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.GMS_SWEEPER is a PL/SQL package body within the Oracle E-Business Suite Grants Management (GMS) module. Its principal business function is to reconcile and sweep award expenditure balances against encumbrances, ensuring that budgetary and award-level accounting records remain consistent across the GMS schema. The package operates on the intersection of award distributions, budget versions, billing packets, and burden components, aggregating cost and encumbrance data at the award and expenditure-type level.

Internally, the package body defines several PL/SQL record and collection types that reveal its processing model. The Bal_Rec type holds expenditure item identifiers, award distribution line numbers, award and project identifiers, task identifiers, bill amounts, and a reason code. The Fail_Rec type captures failure diagnostics spanning resource list members, incurred-by person and organization, job, expenditure type, expenditure and revenue categories, system linkage function, expenditure date, budget version, budget task, and categorization and time-phased type codes. Two associative arrays, Upd_Error_Table and Upd_Reason_Table, stage these records during processing. A separate Rec_Award_Exp record type supports recording burdenable raw cost and raw cost, reflecting logic traced to Bug 4053891. A profile option check via FND_PROFILE.value('GMS_ENABLE_DEBUG_MODE') governs whether debug messages are written to the log file.

Key Procedures and Functions

The ETRM metadata documents a single public procedure for this package:

• UPD_ACT_ENC_BAL — Updates actual and encumbrance balances. Based on the package's internal record structures and table references, this procedure reconciles award-level actual cost and encumbrance amounts against the corresponding balances held in the GMS tables, applying the calculated differences and recording any failures or rejection reasons in the internal error and reason collections for subsequent logging.

No additional parameter lists are documented in the metadata, and none are asserted here.

Tables Accessed

The package reads and writes a broad set of GMS and General Ledger tables through APPS synonyms:

• GL_PERIOD_STATUSES — Supplies accounting period open/closed status to constrain which periods may be swept.
• GMS_AWARDS and GMS_AWARDS_ALL — Provide award header and descriptive context for the balances being adjusted.
• GMS_AWARD_DISTRIBUTIONS — Source of award distribution line detail, including the ADL line number referenced in Bal_Rec.
• GMS_AWARD_EXP_TYPE_ACT_COST — Stores actual cost by award and expenditure type; referenced by the Rec_Award_Exp burden/raw cost logic.
• GMS_BALANCES — The principal balance store updated by the sweep.
• GMS_BC_PACKETS and GMS_BC_PACKET_ARRIVAL_ORDER — Billing packet data driving expenditure and task references.
• GMS_BILLING_CANCELLATIONS — Cancellation records considered when reconciling billed amounts.
• GMS_BUDGET_VERSIONS — Budget version context attached to failed and updated records.
• GMS_BURDEN_COMPONENTS — Burden structure applied when computing burdenable raw cost.
• GMS_EVENT_ATTRIBUTE and GMS_EVENT_INTERSECT — Event-level attribute and intersection data supplying project, task, and bill amount values.
• GMS_INSTALLMENTS — Installment schedules relevant to encumbrance calculation.
• GMS_SUMMARY_PROJECT_FUNDINGS — Summary funding figures used in balance derivation.

Usage Notes

GMS_SWEEPER is a backend package rather than a user-facing API. It is referenced by three other packages in the GMS schema, indicating that it is invoked programmatically from award and billing processing flows rather than directly from Oracle Forms. Typical invocation occurs from concurrent programs or from calling packages that perform award balance maintenance, such as those triggered during billing packet arrival or period-end reconciliation. Because it depends on GL period status, it should be executed when the relevant accounting periods are open for adjustment. Debug output is controlled by the GMS_ENABLE_DEBUG_MODE profile option, which should be enabled only during troubleshooting to avoid log volume. The presence of the Upd_Error_Table and Upd_Reason_Table collections implies that failures are accumulated and reported rather than raised immediately, so callers should inspect log or diagnostic output after execution. The header comment records the source file as gmsfcuab.pls version 120.9.12010000.2, reflecting maintenance aligned to Release 12.1.1 and 12.2.2.