Search Results get_run_id




Overview

PSP_MATRIX_DRIVER_PKG is an Oracle Applications (APPS) owned PL/SQL package associated with the Oracle Payroll product family, specifically the payroll schedule matrix processing functionality. It is classified under the ETRM API taxonomy as OTHER, meaning it is not part of a formally published open interface but serves an internal supporting role within the payroll schedule generation framework. The package materializes payroll schedule data into the PSP_MATRIX_DRIVER staging table, which acts as the driver structure used by downstream payroll matrix and costing processes. Its header, dated January 2007, reflects a long-standing component retained through the 12.1.1 and 12.2.2 releases.

The core business purpose is to load, sequence, and purge the matrix driver records for a defined organization and set of accounting periods, supporting payroll schedule reporting and exceedence checking across a hierarchical schedule structure.

Key Procedures and Functions

The package exposes 17 documented procedures and functions. The principal loading routines are LOAD_ORG_SCHEDULE, which populates driver data for a list of organizations across a period range for a given report type, and LOAD_TABLE_SCHEDULE and LOAD_TABLE, which load driver rows keyed by a schedule identifier under a business group and set of books. LOAD_ORGANIZATIONS performs a comparable organization-oriented load using date-based period bounds. PURGE_TABLE and CLEAR_TABLE manage the lifecycle of the staging data, with CLEAR_TABLE accepting an event parameter to conditionally remove rows.

Control and sequencing are handled by SET_START_PERIOD and SET_RUNID, which establish the reporting window and the run identifier used to tag a given execution batch. Retrieval functions include GET_START_PERIOD, GET_END_PERIOD, GET_RUN_ID, GET_MAX_PERIODS, GET_DYNAMIC_PROMPT, and GET_DYNAMIC_TOTALS; the period, run id, and start-period functions carry RESTRICT_REFERENCES pragmas (WNDS, WNPS) for purity. Validation logic is provided by CHECK_EXCEEDENCE, which tests whether an assignment exceeds schedule thresholds (changed from a payroll-level check under Bug 4511249), CHECK_EXCEEDENCE_SC_COPY, and CHECK_SCH_HIERARCHY, which returns a hierarchy identifier and an invalid count for an assignment and payroll combination.

Tables Accessed

Through APPS synonyms the package reads and writes payroll schedule and driver structures. PSP_MATRIX_DRIVER is the primary staging target populated by the load routines and emptied by the purge and clear routines. PSP_DEFAULT_LABOR_SCHEDULES, PSP_SCHEDULE_LINES, and PSP_SCHEDULE_HIERARCHY supply the schedule definitions and hierarchy relationships evaluated during loading and hierarchy checking. PSP_PAYROLL_CONTROLS and PSP_PAYROLL_LINES provide payroll processing context, while PSP_LS_RUNID_S supplies run identifier sequencing, and PER_TIME_PERIODS resolves the accounting period boundaries used by the period-window functions. DUAL and PLITBLM are referenced for scalar evaluations and PL/SQL table handling respectively.

Usage Notes

PSP_MATRIX_DRIVER_PKG is invoked as an internal engine rather than a directly callable public API. It is referenced by four other packages, indicating that payroll schedule concurrent programs and related payroll processes call it to build and dismantle the matrix driver data set before downstream reporting or costing consumes it. Typical invocation occurs from concurrent program logic or from other payroll schedule packages rather than from a Form directly. Because the package writes only to a staging table (PSP_MATRIX_DRIVER) and depends on current organization, period, and set of books parameters, custom code should never call it concurrently for overlapping parameter ranges; the SET_RUNID and purge/clear routines exist precisely to isolate and clean each execution batch. Customers upgrading from 12.1.1 to 12.2.2 should note that the interface signature, including the assignment-level CHECK_EXCEEDENCE function, is the supported form.