Search Results retrieve_variable




Overview
Explore in AI Chat

Overview

PAY_AU_GENERIC_CODE_CALLER is an Oracle HRMS and Payroll package owned by the APPS schema that provides a generic execution framework for Australian (AU) legislative and business logic within Oracle E-Business Suite 12.1.1 and 12.2.2. Rather than hard-coding business rules directly into the payroll engine, the package acts as a runtime interpreter: it reads module, process, and parameter definitions from configuration tables (PAY_AU_MODULES, PAY_AU_MODULE_TYPES, PAY_AU_MODULE_PARAMETERS, PAY_AU_PROCESSES, PAY_AU_PROCESS_MODULES, and PAY_AU_PROCESS_PARAMETERS) and then dynamically invokes the procedures, functions, or formulas that those definitions point to. This design allows Australian payroll and HR functionality to be extended or reconfigured without modifying compiled code, since the actual executable logic is resolved at runtime from metadata.

The package is declared AUTHORID CURRENT_USER, and the shipped header dates to the late 1990s with a 2002 revision that renamed objects from an "NZ" to an "AU" country identifier and added NOCOPY hints for parameter passing efficiency. It is classified as an OTHER API in ETRM rather than an open public API, indicating it is intended primarily for internal HRMS framework use.

Key Procedures and Functions

The package exposes nine documented subprograms. GET_MODULE_PARAMETERS retrieves the parameter definitions associated with a given module, populating the internal parameter store used by subsequent calls. STORE_VARIABLE and RETRIEVE_VARIABLE manage a name/value store of variables (typed through the t_variable_store_rec structure, which captures internal name, data type, and constant value), allowing values to be passed between successive executed code units.

  • EXECUTE_PROCESS — drives execution of a configured AU process, resolving its constituent modules and parameters.
  • EXECUTE_PROCEDURE — dynamically invokes a stored procedure identified through the module metadata.
  • EXECUTE_FUNCTION — dynamically invokes a stored function and captures its return value.
  • EXECUTE_PROCEDURE_FUNCTION — handles call targets that behave as a combined procedure/function construct.
  • EXECUTE_FORMULA — resolves and evaluates an Oracle FastFormula, which is the specific entry point relevant to users searching on that term.
  • SAVE_RESULT — persists execution output, including result values and error message information, back through the framework.

The parameter store record includes flags for input, context, output, result, error message, and function return, which is how the caller distinguishes argument direction and maps values to and from the invoked code unit.

Tables Accessed

The package reads configuration from PAY_AU_MODULES, PAY_AU_MODULE_TYPES, PAY_AU_MODULE_PARAMETERS, PAY_AU_PROCESSES, PAY_AU_PROCESS_MODULES, and PAY_AU_PROCESS_PARAMETERS, which together define what code may be run and with which parameters. It interacts with the FastFormula dictionary through FF_FORMULAS_F, FF_CONTEXTS, FF_DATABASE_ITEMS, FF_ROUTES, FF_ROUTE_CONTEXT_USAGES, FF_USER_ENTITIES, and FF_ARCHIVE_ITEMS, supporting formula resolution and context derivation for EXECUTE_FORMULA. FND_SESSIONS supplies session context, while PAY_ASSIGNMENT_ACTIONS reflects payroll processing state during execution.

Usage Notes

PAY_AU_GENERIC_CODE_CALLER is normally invoked indirectly by the Australian payroll and HRMS framework rather than called directly by end users. It is triggered during payroll runs, assignment action processing, and formula-driven calculations where AU-specific logic must be evaluated. ETRM records that it is referenced by two other packages, confirming its role as a supporting engine beneath higher-level AU payroll APIs. Because it is classified as OTHER and is not a published open interface, customizations should avoid calling it directly where a supported API exists; direct use is appropriate only for tightly scoped extensions that must honour the existing PAY_AU_MODULE_PARAMETERS configuration model.