Results for “pay_sf_bus”

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

Overview

PAY_SF_BUS is a private PL/SQL package within the Oracle E-Business Suite Payroll (PAY) module, owned by the APPS schema. The "SF" prefix associates it with the shadow formula and shadow element type infrastructure that Oracle Payroll uses to manage payroll calculation rules across legislation versions. The package encapsulates the business rule validation logic for the shadow formula entity, functioning as the business rules layer of the Shadow Formula Row Handler (the suffix "BUS" denoting "business rules"). Its header comment block, dated 2005, confirms it is an original row handler component of the payroll shadow schema introduced with the R12 data model.

The package is classified as an "Internal Row Handler Use Only" component. It is not a public API and is not intended for direct invocation by external code, forms, or concurrent programs. Instead, it is called exclusively from within the shadow formula row handler layer, which itself sits beneath the public Shadow Formula API (PAY_SHADOW_FORMULA_API) and related shadow element type APIs.

Key Procedures and Functions

The package exposes three documented private procedures, each acting as the validation entry point for a corresponding DML operation on the shadow formula entity:

• INSERT_VALIDATE — Controls execution of all insert business rules validation. It is called from the internal insert ("ins") procedure of the row handler prior to committing a new shadow formula row. The procedure receives the effective date and a PL/SQL record structure populated by the row handler.
• UPDATE_VALIDATE — Controls execution of all update business rules validation. It is invoked from the internal update ("upd") procedure to validate changes to an existing shadow formula record.
• DELETE_VALIDATE — Controls execution of all delete business rules validation. It is invoked from the internal delete ("del") procedure to validate whether a shadow formula row may be removed, typically enforcing referential or status-based restrictions.

Each procedure is designed to be a thin orchestrator of business rule calls. Oracle's developer guidance embedded in the source explicitly recommends calling straight procedures or functions and avoiding conditional branching within these validators. Errors are not automatically handled by the validation layer; any failure must be explicitly coded and raised by the underlying business rule routines.

Tables Accessed

The package reads and writes data through APPS synonyms for the following payroll shadow and template tables:

• PAY_SHADOW_FORMULAS — The primary entity validated by this package; holds shadow formula definitions.
• PAY_SHADOW_ELEMENT_TYPES — Shadow element type definitions to which shadow formulas are attached; validation ensures consistency with the parent element type.
• PAY_SHADOW_INPUT_VALUES — Input value definitions associated with shadow element types and formulas.
• PAY_TEMPLATE_CORE_OBJECTS and PAY_TEMPLATE_FF_USAGES — Payroll template metadata governing core objects and fast formula usage, used to validate template-driven configuration context.
• FND_TERRITORIES — Referenced for territory (legislation/country) validation, ensuring shadow formula definitions align with valid territory codes.

Usage Notes

Because the package is marked "Internal Row Handler Use Only," it should never be called directly from custom code. The supported integration path is through the public Shadow Formula API (PAY_SHADOW_FORMULA_API), which internally delegates insert, update, and delete operations to the row handler and, in turn, to the validators in PAY_SF_BUS. The package is referenced by three other packages within the payroll shadow schema, reflecting its position in the layered row handler architecture.

Typical invocations occur when a payroll administrator or implementation consultant defines or modifies shadow formulas during payroll configuration, whether through the relevant payroll setup forms or through API-driven setup migration. Modification of this package is not supported; all business rules executed from these validators should be extended through the documented public APIs and their associated hooks. In Oracle EBS 12.1.1 and 12.2.2, the package remains an internal component, and no client extension points are exposed.