Results for “pay_au_modules”

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

Overview

PAY_AU_MODULES is an HR-schema payroll configuration table in Oracle E-Business Suite (validated in 12.1.1 and 12.2.2) that defines the discrete processes which may be invoked by the generic code caller within the Australian (AU) payroll localization. Each row describes a callable unit of logic — a package, procedure, function, or formula — that the payroll engine can select and execute programmatically. Because the table is keyed by business group and legislation, it supports multi-tenant, multi-legislative deployments where distinct legal entities maintain their own catalog of executable payroll modules.

From a Data Vault modeling perspective, the heuristic classification of this object is hub-leaning. The stable, uniquely identified business concept is the module itself (identified by NAME within a business group and legislation), while descriptive and type attributes are attached. In practice MODULE_ID serves as the surrogate hub key, and the descriptive columns (ENABLED_FLAG, PACKAGE_NAME, PROCEDURE_FUNCTION_NAME, FORMULA_NAME, DESCRIPTION) behave as satellite attributes, with MODULE_TYPE_ID acting as a link to the module-type reference table.

Key Information Stored

The table contains 17 documented columns. The most significant are:

• MODULE_ID — the surrogate primary key (PAY_AU_MODULES_PK), a system-generated unique identifier for each module. It is also part of the unique index PAY_AU_MODULES_U1 (MODULE_ID, ZD_EDITION_NAME), which supports the edition-based redefinition (EBR) model in 12.2.
• NAME — the business-key candidate, forming the PAY_AU_MODULES_UK1 unique key together with BUSINESS_GROUP_ID and LEGISLATION_CODE. This is the human-readable module identifier users and administrators recognize.
• BUSINESS_GROUP_ID and LEGISLATION_CODE — the partitioning context that scopes a module to a specific enterprise group and to Australian legislation respectively.
• MODULE_TYPE_ID — foreign key to PAY_AU_MODULE_TYPES, categorizing the module (for example, by execution mechanism or purpose).
• ENABLED_FLAG — controls whether the module is active and thus eligible for execution by the generic code caller.
• PACKAGE_NAME, PROCEDURE_FUNCTION_NAME, and FORMULA_NAME — the concrete technical pointers the caller resolves at runtime to invoke the correct PL/SQL or formula logic.
• DESCRIPTION — free-text documentation of the module's purpose.
• Audit columns — CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, LAST_UPDATE_LOGIN, and OBJECT_VERSION_NUMBER provide standard EBS auditing and optimistic locking, while ZD_EDITION_NAME supports edition-based redefinition.

Common Use Cases and Queries

Typical scenarios include auditing which callable modules are enabled for a business group, tracing a payroll process back to its PL/SQL entry point, and reporting on module coverage by legislation. A representative query listing enabled Australian modules with their types follows:

• SELECT m.MODULE_ID, m.NAME, m.ENABLED_FLAG, t.TYPE_NAME FROM HR.PAY_AU_MODULES m JOIN HR.PAY_AU_MODULE_TYPES t ON m.MODULE_TYPE_ID = t.MODULE_TYPE_ID WHERE m.LEGISLATION_CODE = 'AU' AND m.ENABLED_FLAG = 'Y' AND m.BUSINESS_GROUP_ID = :p_bg_id;
• To resolve the executable logic for a named module: SELECT PACKAGE_NAME, PROCEDURE_FUNCTION_NAME, FORMULA_NAME FROM HR.PAY_AU_MODULES WHERE NAME = :p_name AND BUSINESS_GROUP_ID = :p_bg AND LEGISLATION_CODE = 'AU';
• To find every module invoked by a given payroll process, join through PAY_AU_PROCESS_MODULES on MODULE_ID.

Related Objects

The table participates in a defined referential network:

• PAY_AU_MODULE_TYPES — referenced via PAY_AU_MODULES.MODULE_TYPE_ID; supplies the type classification for each module.
• PAY_AU_MODULE_PARAMETERS — references PAY_AU_MODULES.MODULE_ID, holding the parameter definitions each module accepts.
• PAY_AU_PROCESS_MODULES — references PAY_AU_MODULES.MODULE_ID, linking modules to the payroll processes that execute them.

These three relationships collectively define module typing, parameterization, and process association, making PAY_AU_MODULES a central hub for the Australian payroll generic code-caller framework.