Search Results create_payroll

Overview

PAY_FR_DB_PAY_SETUP is an Oracle EBS APPS-owned PL/SQL package, classified as OTHER in the ETRM repository, that provides the "building blocks" used to configure French payroll (FR) legislative data. The package name reflects its original French localization origin (the "FR" element), and its header comments describe it as a container for the elementary setup activities required to construct a working payroll structure within the Oracle Payroll application. Rather than exposing a single monolithic entry point, the package groups thirteen granular routines that individually create the constituent configuration objects of a payroll: payrolls, elements, input values, balance types and classifications, defined balances, consolidation sets, and element links. In the context of Oracle EBS 12.1.1 and 12.2.2, it serves as a programmatic alternative to the standard Payroll configuration forms, enabling repetitive or template-driven setup to be performed from PL/SQL and, critically, via concurrent programs or scripts. The package is declared AUTHID CURRENT_USER, meaning its database objects are resolved in the schema of the invoker and that calls from custom code execute with the caller's privileges.

Key Procedures and Functions

• CREATE_PAYROLL — Establishes a payroll definition (the record used to group employees for processing, calendar association, and legislation-specific parameters). This is the routine most directly associated with the user search term "create_payroll."
• CREATE_ELEMENT — Creates a payroll element, the fundamental unit that represents earnings, deductions, or other pay components.
• CREATE_INPUT_VALUE — Adds input values to an element, providing the data entry points used when the element is processed for an assignment.
• CREATE_ELEMENT_LINK — Creates the link between an element and the payrolls, assignment sets, or other criteria for which the element becomes available.
• CREATE_BALANCE_TYPE — Defines a balance type used to accumulate element results.
• CREATE_BALANCE_CLASSIFICATION — Assigns or establishes balance classification information.
• CREATE_DEFINED_BALANCE — Creates a defined balance, typically a combined or feed-based balance built from other balance inputs.
• CREATE_CONSOLIDATION_SET — Creates a consolidation set, which groups payrolls for processing and reporting.
• CREATE_OWNER_DEFINITIONS — Establishes ownership definitions that bind objects to an owning application or context.
• SET_SESSION_DATE — Sets the effective date for the session, ensuring the configuration rows created are dated consistently.
• INSERT_CUSTOMIZE_RESTRICTION — Inserts customization restriction records that constrain which setup objects may later be edited.
• INSERT_RESTRICTION_VALUES — Inserts the values associated with those customization restrictions.
• GET_DEFAULT_CURRENCY — Returns the default currency for the legislation/session context, used when creating payroll and balance objects that require a currency.

Tables Accessed

The package reads and writes a focused set of configuration tables through APPS synonyms. Payroll and consolidation definitions are stored in PAY_ALL_PAYROLLS_F and PAY_CONSOLIDATION_SETS / PAY_CONSOLIDATION_SETS_S. Balance structures are held in PAY_BALANCE_TYPES, PAY_BALANCE_CATEGORIES_F, PAY_BALANCE_CLASSIFICATIONS, PAY_BALANCE_CLASSIFICATIONS_S, PAY_BALANCE_DIMENSIONS, and PAY_BALANCE_FEEDS_F. Ownership is tracked in HR_OWNER_DEFINITIONS and HR_APPLICATION_OWNERSHIPS. Currency, language, form, and session context come from FND_CURRENCIES, FND_LANGUAGES, FND_FORM, and FND_SESSIONS—the last supplying the session date applied by SET_SESSION_DATE.

Usage Notes

PAY_FR_DB_PAY_SETUP is a setup-tier API rather than a runtime processing API. It is commonly invoked from custom PL/SQL that automates French localization payroll configuration, from concurrent program wrappers that carry out bulk or repeatable setup, or from migration scripts moving configuration between environments. The ETRM metadata records no dependent packages referencing it ("Referenced by 0 other packages"), so it should be treated as a directly invoked utility rather than a shared internal dependency. Callers should generally invoke SET_SESSION_DATE first, then create payrolls and consolidation sets, then elements, input values, and links, and finally the balance-related objects. Because the package is AUTHID CURRENT_USER, sessions must be initialized to the correct APPS context (via standard EBS session initialization) before execution, and all routines should be considered date-sensitive, using the effective date established for the session.