Search Results pqp_uk_union_template




Overview
Explore in AI Chat

Overview

PQP_UK_UNION_TEMPLATE is a United Kingdom localization PL/SQL package within the Oracle E-Business Suite HRMS payroll schema (APPS). Its purpose is to automate the creation and removal of user-defined payroll element templates used to represent trade union deductions in the UK legislative context. The package encapsulates the complex, multi-table work required to define a union deduction element — including its input values, balances, shadow (sub) element types, and template metadata — behind a single, controlled API. The package constant g_template_leg_code is fixed to 'GB', confirming that all objects it creates are bound to the UK (Great Britain) legislation and legislation subgroup. This isolation of UK-specific logic means the package is only relevant to business groups operating under UK payroll legislation.

Key Procedures and Functions

  • create_user_template — A function returning the union element type core object id (NUMBER). It accepts the union name, element name, reporting name, description, processing type, override amount indicator, tax relief indicator, supplementary levy indicator, union-level balance name and Yes/No flag, rate type, fund list lookup type, effective dates, and business group id. The comments in the source indicate that the union name is converted to an Organization ID and stored as Extra Element Info #1, the element name serves as the base name, and classification is always fixed to 'Voluntary Deduction'. The fund list parameter names the lookup type supplying the selectable funds.
  • delete_user_template — A procedure that removes a previously created union template. It requires the union name, the union-level balance name, the element type id, the element name, the business group id, and an effective date, allowing the deletion to be date-effective rather than unconditional.

Tables Accessed

The package manipulates a broad set of HRMS and payroll objects, all referenced through APPS synonyms. Union identity is resolved through HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION. Balance definition and storage rely on PAY_BALANCE_TYPES, PAY_BALANCE_CATEGORIES_F, PAY_BALANCE_DIMENSIONS, and PAY_DEFINED_BALANCES. The generated deduction element itself is materialized in PAY_ELEMENT_TYPES_F, PAY_ELEMENT_TYPE_EXTRA_INFO, and PAY_ELEMENT_TEMPLATES. Shadow (sub) element structures — used to feed balances from the union element — are held in PAY_SHADOW_ELEMENT_TYPES, PAY_SHADOW_INPUT_VALUES, PAY_SHADOW_BALANCE_TYPES, and PAY_SHADOW_BALANCE_FEEDS. Template orchestration metadata and any user-defined columns are stored in PAY_TEMPLATE_CORE_OBJECTS and PAY_USER_COLUMNS. Collectively these tables form the metadata and balance backbone of a UK voluntary deduction element.

Usage Notes

Because the package is classified as OTHER (not a public supported API), it is primarily invoked by the UK payroll element template setup flow rather than by end users directly. Typical callers include the element template entry forms (e.g., the Element and Balance definition windows) and any Oracle-delivered concurrent process that seeds UK union deduction templates during legislative patch application. Custom implementations that require programmatic creation of union deduction elements — for example during data migration or bulk configuration of multiple business groups — may call create_user_template directly, supplying a valid business group id and effective dates, and later call delete_user_template with the returned element type id to reverse the setup. The package is not referenced by other packages, which reinforces its role as a terminal setup utility. As only two entry points are exposed, the sequencing of validation, element creation, extra info population, shadow element definition, and template registration is handled internally and cannot be decomposed by callers.