Search Results pay_mx_sua_mag




Overview
Explore in AI Chat

Overview

PAY_MX_SUA_MAG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the Mexican SUA interface extract. SUA (Sistema Único de Autodeterminación) is the statutory Mexican payroll reporting mechanism administered through IMSS, and this package is responsible for producing the extract file that employers submit for social security contribution determination. The package is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than the defining user, a convention typical of Oracle HRMS payroll utilities that must respect session-level security and localization context. The header comment identifies its purpose concisely as "Used for SUA Interface Extract." The package file is paymxsuamag.pkh, and the change history shows an initial version by vpandya in April 2005, incremental additions covering range code, action creation code, and XML generation, a revision that dynamically fetches the IANA charset for XML encoding, a revision removing the XML header so that PYUGEN emits headers instead, and a July 2007 addition of a new INIT procedure under bug 6198089. In the 12.1.1 and 12.2.2 file systems the packaged body follows the same version lineage, and the extracted object is classified under the generic API classification OTHER in the E-Business Suite Technical Reference Manual.

Key Procedures and Functions

The package exposes seven documented program units:

  • GET_START_DATE — a function returning a start date, accepting a mode indicator (documented as FULL versus INCREMENT) and a GRE identifier. It establishes the lower boundary of the extraction window.
  • RANGE_CURSOR — a procedure that prepares the range of persons to be processed for a given payroll action, returning a SQL statement string through an OUT parameter.
  • ACTION_CREATION — a procedure that creates the payroll action records required to drive the extract.
  • GEN_XML_HEADER — a procedure that generates the XML header fragment for the extract output.
  • GENERATE_XML — the principal procedure responsible for assembling the SUA XML payload.
  • INIT — an initialization procedure added in the 2007 revision to set up package state before extraction.
  • GEN_XML_FOOTER — a procedure that emits the closing XML fragment, complementing the header generator.

The split between header, body, and footer generation reflects the design decision noted in the change list to externalize XML header emission to PYUGEN while retaining fragment-level control within this package.

Tables Accessed

The package reads and writes a set of standard Oracle HRMS payroll and assignment objects through APPS synonyms. Payroll action state is managed through PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, PAY_ASSIGNMENT_ACTIONS_S, and PAY_ACTION_INFORMATION, with PAY_ACTION_INTERLOCKS providing action sequencing and locking semantics. Person and assignment data are drawn from PER_ALL_ASSIGNMENTS_F and organizational context from HR_ORGANIZATION_INFORMATION. Population and processing control rely on PAY_POPULATION_RANGES, PAY_PROCESS_EVENTS, and PAY_EVENT_UPDATES. DUAL supports scalar evaluation, while DBMS_LOB, UTL_RAW, and PLITBLM provide large-object handling and raw conversion used when materializing the XML extract.

Usage Notes

PAY_MX_SUA_MAG is not intended for direct interactive invocation. It is typically called from the Mexican SUA extract concurrent program, which supplies the payroll action context and drives INIT, RANGE_CURSOR, ACTION_CREATION, and the XML generation routines in sequence. Because the package is documented as referenced by no other packages in the ETRM extract, it functions as a terminal utility rather than a reusable service layer. Customizations should avoid modifying the packaged body; instead, extensions should be layered through supported localization hooks or a wrapper concurrent program so that patch application and upgrade to 12.2.2 remains viable.