Search Results pay_paywsqee_pkg




Overview
Explore in AI Chat

Overview

PAY_PAYWSQEE_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified under the Oracle Payroll (PAY) product family. Its name derives from "Payroll Web ADI Quick Entry and Element Entry," indicating that it supports the Web ADI (Web Applications Desktop Integrator) spreadsheet-based interface used by payroll administrators to upload and validate batch element entries. The package provides the server-side logic that Web ADI and the Payroll Batch Element Entry (BEE) framework rely upon for creating payroll batches, validating element entry details, resolving input values, and converting internal identifiers into user-facing display values. In EBS 12.1.1 and 12.2.2, it acts as a shared utility layer between the payroll batch APIs and the HXT (Web ADI) integration packages, and its VALID status confirms it compiles cleanly against the standard APPS dependencies.

Key Procedures and Functions

The ETRM metadata documents eleven callable units within the package. Their purposes are as follows:

  • GET_BATCH_ELEMENT_TYPE — Returns the element type associated with a payroll batch, allowing the interface to determine which element a batch line belongs to.
  • PAYLINK_REQUEST_ID — Retrieves or resolves the request identifier used by the PayLink integration, linking batch processing to a concurrent request.
  • CHECK_NAME_UNIQUENESS — Validates that a batch or element entry name is unique before insertion, preventing duplicate batch definitions.
  • NEXT_BATCH_SEQUENCE — Generates the next sequence number for a payroll batch, ensuring ordered batch numbering.
  • BATCH_OVERALL_STATUS — Derives and returns the aggregate status of a batch by evaluating its constituent lines or control totals.
  • ASSIGNMENT_NUMBER — Resolves the assignment number for the employee or applicant associated with a batch line.
  • GET_INPUT_VALUE_DETAILS — Returns the descriptive details of an element input value, supporting validation and display of entry data.
  • POPULATE_CONTEXT_ITEMS — Populates the descriptive flexfield context items required when writing element entries.
  • CREATE_BATCHES_REQUEST_ID — Creates or returns the concurrent request identifier used when batches are generated or uploaded.
  • CONVERT_INTERNAL_TO_DISPLAY — Translates internal stored values into display-ready values for the Web ADI spreadsheet or user interface.

Tables Accessed

The package reads and writes the core payroll batch element entry tables. PAY_BATCH_HEADERS and PAY_BATCH_LINES store the batch definition and its element entry lines, and PAY_BATCH_CONTROL_TOTALS holds the aggregated control totals used for batch validation. PAY_ELEMENT_TYPES_F and PAY_INPUT_VALUES_F / PAY_INPUT_VALUES_F_TL supply element and input value definitions, including translated names. PAY_PAYROLL_ACTIONS and PAY_ACTION_PARAMETER_GROUPS provide action and parameter group context. FND_DESCR_FLEX_COLUMN_USAGES is consulted to populate descriptive flexfield context items. These tables are referenced through APPS synonyms, consistent with standard EBS data access conventions.

Usage Notes

PAY_PAYWSQEE_PKG is not typically invoked directly by end users. It is called by Web ADI and Payroll Batch Element Entry components, including HXT_BATCH_PROCESS, HXT_INTERFACE_UTILITIES, HXT_OTC_RETRIEVAL_INTERFACE, HXT_RETRO_MIX, HXT_UTIL, and HXT_HXT007A_XMLP_PKG, as well as payroll packages such as PAY_BEE_SS, PAY_HR_OTC_RETRIEVAL_INTERFACE, PAY_MIX_ROLLBACK_PKG, and PAY_WEBADI_BEE_CONTENT_V. It is referenced by eleven other packages and by the PAY_BATCH_HEADERS_V1 view. Custom extensions that create or validate payroll batches through Web ADI should call this package rather than manipulating PAY_BATCH_HEADERS and PAY_BATCH_LINES directly, to preserve sequence generation, uniqueness checks, flexfield context population, and status derivation. Because it is owned by APPS and marked VALID, it should be treated as a standard, non-customizable object; modifications risk invalidating dependent HXT and PAY packages.