Search Results api_validated

Overview

The APPS.PAY_PST_UTILS package is a PL/SQL utility package in Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 that provides status, progress, and diagnostic information for payroll batch processing performed through the HR Pump and Oracle Payroll action-parameter infrastructure. Despite the frequent association of the term "PST" with third-party invoice or payment-solution software in external search contexts, within EBS this identifier refers to an Oracle-owned, seeded package registered under the APPS schema with API classification OTHER. It is declared AUTHID CURRENT_USER, meaning execution privileges are evaluated against the calling user rather than the package owner, and its documented header dates to 2006 (script pypstutl.pkh). The package exposes read-only query functions rather than transactional DML, and it is referenced by zero other packages, confirming its role as a standalone reporting and introspection utility rather than a component of the core payroll processing chain.

Key Procedures and Functions

The documented interface comprises twenty functions organized into two logical groupings.

• Batch Functions — BATCH_STATUS, PERCENT_COMPLETE, PROCESS_STATUS, TOTAL_LINES, CAN_UPDATE, DATE_STARTED, PARAMETER_GROUP, VALIDATE_ONLY, DATE_COMPLETED, COMPLETION_TEXT, PROCESS_PHASE, LAST_BATCH_EXCEPTION, DISPLAY_VIEW_ERRORS, and LAST_PROCESS_DATE. These collectively return the state of a payroll batch identified by a batch identifier: overall status and process status, completion percentage, total line count, timestamps for start and completion, the parameter group in use, a validate-only indicator, descriptive completion text, the current processing phase, the most recent batch exception, a flag controlling error display, and the date of the last processing run.
• API Functions — MODULE_NAME, MODULE_STATUS, API_UNPROCESSED, API_VALIDATED, API_ERROR, and API_COMPLETE. These operate at a finer granularity, keyed by both batch identifier and API identifier, returning the API module name and status together with counts of records in the unprocessed, validated, error, and complete states.

Tables Accessed

Access to underlying data is achieved through APPS synonyms. The package reads HR_PUMP_BATCH_LINES and HR_PUMP_BATCH_EXCEPTIONS to derive line counts, completion percentages, and exception detail. It queries HR_API_MODULES to resolve module names and per-API status. FND_CONCURRENT_REQUESTS, FND_CONCURRENT_PROGRAMS, and FND_APPLICATION supply concurrent manager context, enabling correlation of a batch with the concurrent request that spawned it. PAY_ACTION_PARAMETER_GROUPS supports the parameter-group function, and DBMS_UTILITY is used as an Oracle-supplied utility package for supporting operations. No documented table is written to by this package.

Usage Notes

Because the package is undocumented in the Oracle Forms layer and is not referenced by any other seeded package, it is most commonly invoked from custom concurrent programs, custom PL/SQL wrappers, or ad hoc SQL against the APPS schema. Typical usage is operational monitoring: querying PERCENT_COMPLETE and PROCESS_PHASE for long-running payroll batch processes, or calling LAST_BATCH_EXCEPTION and DISPLAY_VIEW_ERRORS for troubleshooting failed runs. Developers building custom payroll status dashboards in 12.1.1 or 12.2.2 should treat these functions as supported read-only entry points, while recognizing that the interface is not formally published for external integration. All calls must be issued from a session with execute privilege on the APPS package and select privilege on the referenced HR and FND objects.