Search Results insert_customize_restriction

Overview

PAY_DB_PAY_SETUP is an Oracle Payroll database package owned by the APPS schema and classified under the ETRM "OTHER" API category. It provides the foundational building blocks required to configure and maintain payroll setup data within Oracle E-Business Suite Release 12.1.1 and 12.2.2. The package is declared AUTHID CURRENT_USER, meaning its SQL statements execute with the privileges of the invoking user rather than the definer, which is important when the package is called from a session whose security context has already been established by the calling application.

The package header carries a source control header of pypsetup.pkh 115.11, dated 2004, indicating the interface has been stable across multiple major releases. Its stated purpose is to hold building blocks for payroll setup, and it is documented as being used by db_pay_vol_setup and as referencing core HR and Payroll entities such as hr_elements, hr_utility, hr_balances, and hr_payrolls. In the ETRM metadata for 12.2.2, the package exposes 13 documented procedures and functions and is referenced by 48 other packages, confirming its role as a low-level utility layer rather than an end-user facing API.

Key Procedures and Functions

The documented interface is organised around creating and wiring the core payroll configuration objects:

• CREATE_PAYROLL — establishes a payroll definition, including its associated consolidation set and default currency behaviour.
• CREATE_CONSOLIDATION_SET — creates the consolidation set used to group payroll runs for costing and reporting.
• CREATE_ELEMENT — creates an element definition in the element hierarchy.
• CREATE_INPUT_VALUE — attaches an input value to an element, defining the entry that users or processes supply at run time.
• CREATE_ELEMENT_LINK — links an element to a payroll, organisation, or other eligibility criterion so it becomes usable in a payroll run.
• CREATE_BALANCE_TYPE — defines a balance type used for accumulation and reporting.
• CREATE_BALANCE_CLASSIFICATION — creates the balance classification that groups related balance types.
• CREATE_DEFINED_BALANCE — builds a defined balance over one or more balance feeds.
• CREATE_OWNER_DEFINITIONS — registers owner definitions that determine which legislative or business entity owns a given balance.
• SET_SESSION_DATE — sets the effective date used for date-tracked payroll setup operations within the session.
• INSERT_CUSTOMIZE_RESTRICTION — inserted into the package in version 3.5 (27-APR-93) alongside INSERT_RESTRICTION_VALUES; it records customisation restrictions that govern how setup objects may be modified.
• INSERT_RESTRICTION_VALUES — stores the individual restriction values associated with a customisation restriction.
• GET_DEFAULT_CURRENCY — returns the default currency applicable to the current session or business group context.

Tables Accessed

The package reads and writes through APPS synonyms. Currency resolution relies on FND_CURRENCIES, while language and lookup handling use FND_LANGUAGES and FND_LOOKUP_VALUES. Session context is derived from FND_SESSIONS and FND_FORM. Payroll and organisation data is drawn from PAY_ALL_PAYROLLS_F, HR_ALL_ORGANIZATION_UNITS, and HR_APPLICATION_OWNERSHIPS. Balance configuration touches PAY_BALANCE_CATEGORIES_F, PAY_BALANCE_CLASSIFICATIONS, PAY_BALANCE_CLASSIFICATIONS_S, PAY_BALANCE_DIMENSIONS, PAY_BALANCE_FEEDS_F, and PAY_BALANCE_TYPES. Owner definitions are maintained in HR_OWNER_DEFINITIONS, consistent with the CREATE_OWNER_DEFINITIONS procedure.

Usage Notes

PAY_DB_PAY_SETUP is a back-end setup utility. It is not normally invoked directly from an Oracle Forms screen; instead it is called by higher-level setup APIs and concurrent programs, most notably the volume setup package db_pay_vol_setup. Custom code that needs to create payroll configuration programmatically should generally prefer the supported public APIs, but PAY_DB_PAY_SETUP is the documented implementation layer for element, input value, payroll, consolidation set, balance type, balance classification, defined balance, element link, and owner definition creation. The presence of INSERT_CUSTOMIZE_RESTRICTION and INSERT_RESTRICTION_VALUES indicates it also enforces which setup objects may be customised, a control that matters when applying legislative patches or upgrades. Because the package is AUTHID CURRENT_USER and is referenced by 48 packages, callers must ensure the session date and security context are set correctly, typically by calling SET_SESSION_DATE before any date-effective create operation.