Search Results pay_mag_utils




Overview
Explore in AI Chat

Overview

PAY_MAG_UTILS is a PL/SQL package body in the APPS schema that serves as a utility library for Oracle Payroll's magnetic media and report format generation framework. In Oracle EBS 12.1.1 and 12.2.2, magnetic media processing produces the electronic files required by tax authorities and financial institutions — such as BACS, ACH, and similar payment and tax filing formats. The PAY_MAG_UTILS package provides the shared infrastructure that magnetic media and report format business processes depend upon: resolving lookup values, managing payroll and assignment action lifecycle states, validating configuration data, and writing formatted output records.

The package is classified as an OTHER API within the ETRM repository and is currently VALID in the APPS schema. It is a supporting utility rather than an interface or business API exposed to external integrations. Because it is referenced by nine other packages, it functions as a foundational dependency for the broader magnetic media code path, and changes to its behavior can have wide-reaching effects across payroll output generation.

Key Procedures and Functions

The package exposes eighteen documented procedures and functions. These are grouped below by functional area; parameter lists are deliberately not reproduced, as the ETRM metadata documents only signatures by name.

  • Format and formula resolution: LOOKUP_FORMULA, LOOKUP_FORMAT, LOOKUP_JURISDICTION_CODE, and GET_PARAMETER resolve configuration values — the Oracle FastFormula driving a magnetic format, the report format definition, the applicable jurisdiction, and parameters supplied at runtime.
  • Action lifecycle management: CREATE_PAYROLL_ACTION, CREATE_ASSIGNMENT_ACTION, ERROR_PAYROLL_ACTION, and UPDATE_ACTION_STATUS create, error, and transition payroll and assignment actions that represent the execution instances of a magnetic media process.
  • Validation and duplicate prevention: CHECK_REPORT_UNIQUE prevents duplicate report generation, while BAL_DB_ITEM resolves balance database items referenced in the format rules.
  • User-defined field maintenance: INSERT_LOOKUP, UDF_EXISTS, and DELETE_UDF create lookups and manage user-defined fields attached to the magnetic format configuration.
  • Organizational and date handling: ORG_INFO_EXISTS, DATE_EARNED, and GET_DATES check organization information types and derive the date and earned-date values required for reporting periods.
  • Output and orchestration: WRITE emits the formatted output record stream, and MAIN acts as the primary driver that sequences the remaining utilities during a magnetic media run.

Tables Accessed

PAY_MAG_UTILS reads and writes across three functional table groups, all accessed through APPS synonyms. Payroll action tables — PAY_PAYROLL_ACTIONS, PAY_PAYROLL_ACTIONS_S, and PAY_ASSIGNMENT_ACTIONS — record the execution and status of magnetic media processes, supporting the action procedures listed above. Magnetic media definition tables — PAY_MAGNETIC_BLOCKS, PAY_MAGNETIC_RECORDS, PAY_REPORT_FORMAT_MAPPINGS_F, and PAY_STATE_RULES — store the block, record, format mapping, and state rule configuration that determine output layout and jurisdictional behavior. Oracle FastFormula and lookup tables — FF_ARCHIVE_ITEMS, FF_DATABASE_ITEMS, FF_FORMULAS_F, FF_FUNCTIONS, FF_FUNCTION_CONTEXT_USAGES, FF_FUNCTION_PARAMETERS, FF_USER_ENTITIES, HR_LOOKUPS, HR_ORG_INFORMATION_TYPES, and FND_NUMBER — supply formula definitions, database items, context usages, lookup codes, organization information types, and numeric formatting. SYS.DUAL is used for single-row evaluations.

Usage Notes

PAY_MAG_UTILS is not intended for direct invocation by end users. It is typically called from the magnetic media concurrent programs and report format generation processes within Oracle Payroll, from the payroll action framework, and from other packages in the magnetic media family. The nine documented dependent packages rely on its lookup, action, and write routines, so it should be treated as an internal utility layer. Developers extending magnetic media formats generally do so through the FastFormula and format mapping configuration rather than by calling this package directly; direct calls are appropriate only in controlled customizations that replicate the standard magnetic media execution sequence, and must observe the same action status transitions and uniqueness checks the package enforces.