Search Results keyflex_comb

Overview

PAY_BTL_SHD is a PL/SQL package body in the APPS schema that supports the Oracle Payroll Batch Element Entry (BEE) subsystem. Its designation "SHD" and its inclusion of a seeded shadow routine (PAY_BTL_SHD) indicate that it functions as a shadow processing or maintenance utility that operates on batch element entry data on behalf of the Payroll Batch Element Entry API. Within Oracle EBS 12.1.1 and 12.2.2, the package provides internal services for validating, converting, and updating the batch line records held in the PAY_BATCH_HEADERS and PAY_BATCH_LINES tables, and for resolving the cost allocation key flexfield combination attached to batch lines. The package is classified as an "OTHER" API type in the ETRM repository, signifying that it is an internal support unit rather than a public documented interface, and it is referenced by six other packages in the E-Business Suite. It is currently VALID in the APPS schema.

Key Procedures and Functions

The ETRM documentation records seven procedures and functions within PAY_BTL_SHD. Their documented purposes are:

• RETURN_API_DML_STATUS — Returns the DML status of the API invocation, allowing the caller to determine whether the most recent insert, update, or delete performed through the package completed successfully.
• CONSTRAINT_ERROR — Handles constraint violation conditions raised when batch element entry data fails integrity checks against the underlying database constraints.
• API_UPDATING — Indicates or manages whether the API is currently in an update state, supporting consistent transactional behaviour during batch line maintenance.
• LCK — Provides the locking routine used to serialize access to batch element entry records, preventing concurrent modification of the same batch header or line.
• CONVERT_ARGS — Converts or normalises arguments passed into the package routines before they are applied to the batch element entry tables.
• KEYFLEX_COMB — Resolves the cost allocation key flexfield combination used by batch lines, working against PAY_COST_ALLOCATION_KEYFLEX.
• GET_FLEX_SEGS — Retrieves the individual flexfield segment values that make up the cost allocation key flex combination.

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

Tables Accessed

The package operates against four documented tables accessed through APPS synonyms:

• PAY_BATCH_HEADERS — The batch header records that group batch element entry lines; read and maintained during batch processing.
• PAY_BATCH_LINES — The individual batch element entry lines, which the package validates, converts, and updates.
• PAY_COST_ALLOCATION_KEYFLEX — Holds the cost allocation key flexfield combinations referenced by batch lines, used by KEYFLEX_COMB and GET_FLEX_SEGS.
• ALL_CONSTRAINTS — The data dictionary view queried by CONSTRAINT_ERROR to identify and report constraint violations.

Usage Notes

PAY_BTL_SHD is an internal support package rather than an end-user entry point. It is typically invoked indirectly by the Payroll Batch Element Entry forms and concurrent programs, and by the six dependent packages identified in the ETRM dependency list, most notably through the PAY_BTL_SHD shadow routine and the surrounding HR_ENTRY, HR_API, and HR_UTILITY infrastructure. It relies on APP_EXCEPTION, FND_MESSAGE, and HR_MESSAGE for error construction and messaging. Because the package is not referenced by any database object outside the application stack, direct custom invocation is uncommon; customers extending batch element entry behaviour should generally call the supported BEE API layer instead. Any custom reliance on this package should be treated as unsupported, since its internal procedures are not part of Oracle's published API surface and may change between 12.1.1 and 12.2.2.