Search Results element_types_f




Overview
Explore in AI Chat

Overview

The APPS.PAY_US_USER_INIT_DEDN package body is a United States localization utility within Oracle Payroll (PAY) that supports the creation and removal of user-defined initial deduction elements and their associated payroll definitions. In Oracle EBS 12.1.1 and 12.2.2, payroll elements are rarely standalone records; a functional deduction such as a pre-tax 401(k) contribution or a post-tax garnishment requires a coordinated set of rows spanning element types (the ELEMENT_TYPES_F and ELEMENT_TYPES_TL date-tracked entities), input values, balance feeds, balance types, defined balances, iterative rules, and, for US statutory and benefit-linked deductions, an association to a benefits classification. Manually assembling this graph through the Element Description and Balance windows is error-prone and time-consuming. The package encapsulates that assembly logic into a single programmatic entry point, ensuring the resulting element conforms to Payroll's internal conventions.

The header identifies the package as pyusdtmp.pkb, whose naming reflects its role as a US payroll deduction template builder. The package resides in the APPS schema and is classified as a general utility API rather than a business-process API.

Key Procedures and Functions

  • CREATE_USER_INIT_TEMPLATE — The primary function. It accepts a comprehensive set of descriptive and behavioral attributes for a user-defined initial deduction: element name, reporting name, description, classification, benefit classification identifier, category, processing type, priority, standard link, processing run type, calculation rule, start and stop rules, partial deduction and arrearage flags, effective start and end dates, employer match, after-tax component, SRS plan type and buy-back indicators, Roth and USERRA contribution flags, business group identifier, catch-up processing, and termination rule. Using these inputs, the function creates the element in PAY_ELEMENT_TYPES_F, its input values in PAY_INPUT_VALUES_F, any defined balances and balance feeds, and the associated iterative rules, returning a numeric identifier for the generated element.
  • DELETE_USER_INIT_TEMPLATE — The inverse operation. It removes a previously generated user-defined initial deduction template and the dependent rows created alongside it, allowing test data or obsolete templates to be cleaned up without leaving orphaned balance or feed records.

Tables Accessed

The package reads and writes across the core Payroll element model. PAY_ELEMENT_TYPES_F and PAY_INPUT_VALUES_F hold the date-tracked element and its input value definitions; PAY_ELEMENT_CLASSIFICATIONS supplies valid classification codes such as Pre-Tax Deductions. PAY_ELEMENT_TEMPLATES stores the template metadata. Balance-side objects include PAY_BALANCE_TYPES, PAY_DEFINED_BALANCES, PAY_BALANCE_FEEDS_F, PAY_BALANCE_CLASSIFICATIONS, and PAY_BALANCE_DIMENSIONS, which collectively define how the deduction's results accumulate. PAY_ITERATIVE_RULES_F and PAY_ITERATIVE_RULES_S carry sequence-level processing behaviour. Formula references are resolved through FF_FORMULAS_F and FF_GLOBALS_F, while BEN_BENEFIT_CLASSIFICATIONS links the element to benefits plan configuration. FND_SESSIONS is used to determine the current session context, typically the business group and effective date governing the created records.

Usage Notes

The package is invoked as a server-side API, most commonly from Oracle Forms-based element definition flows, from concurrent programs that seed or migrate deduction templates, and from custom PL/SQL setup scripts during implementation or data conversion. Because it manipulates date-tracked tables, callers should supply valid effective dates and a business group identifier consistent with the target legislation. The function should be executed within a properly initialized Payroll session so that FND_SESSIONS resolves correctly. One other package depends on this object, confirming it is intended as a reusable building block rather than an end-user-facing interface.