Search Results pay_core_files




Overview
Explore in AI Chat

Overview

APPS.PAY_CORE_FILES is a core Oracle Payroll PL/SQL package body that provides the low-level file input/output infrastructure used throughout the Oracle E-Business Suite Payroll (PAY) application. Its principal business function is to abstract the mechanics of creating, writing to, reading from, and closing operating system files and temporary files on behalf of payroll processing programs, third-party payment file generation, magnetic tape (MAGTAPE) output, and inbound/outbound data exchange with external agencies such as banks and tax authorities.

The package is owned by the APPS schema and is documented under the ETRM 12.2.2 repository with an API classification of OTHER. It is a foundational utility rather than a business-rule API: individual payroll processes and concurrent programs delegate their physical file handling to this package so that directory naming conventions, character set handling, CLOB access, and raw-byte writing are implemented consistently. In Oracle EBS 12.1.1 and 12.2.2 the package remains valid and is referenced by 57 other database objects, confirming its role as a shared dependency across the Payroll technology stack. It is not referenced upward by any object that this package itself depends upon; it sits at the lower level of the payroll file-handling hierarchy.

Key Procedures and Functions

The package body exposes fourteen documented procedures and functions, grouped by the file operations they support:

  • OPEN_FILE — opens a file for writing, establishing the file handle used by subsequent write and close calls.
  • WRITE_TO_FILE — writes character (text) data to a previously opened file.
  • WRITE_TO_FILE_RAW — writes binary raw data to a previously opened file, used where fixed-format or encoded output is required.
  • CLOSE_FILE — closes an open file and releases its associated resources.
  • READ_FROM_CLOB — reads character content from a CLOB source.
  • READ_FROM_CLOB_RAW — reads binary raw content from a CLOB source.
  • FORM_READ_CLOB — supports reading CLOB data in the context of an Oracle Forms client, allowing form-based interfaces to consume generated file content.
  • OPEN_TEMP_FILE — opens a temporary file for intermediate processing.
  • CLOSE_TEMP_FILE — closes a temporary file and releases its handle.
  • RETURN_CLOB_LENGTH — returns the length of a CLOB, typically to size buffers or validate content before reading.
  • RETURN_LENGTH — returns the length of a file or data element.
  • WRITE_TO_MAGTAPE_LOB — writes LOB content destined for magnetic tape output, supporting the MAGTAPE file format used for payment and remittance transmissions.

Because ETRM documents only the procedure names, parameter lists are intentionally not reproduced here; callers should inspect the package specification in the APPS schema for exact signatures in their release.

Tables Accessed

The package operates primarily on external files and PL/SQL-supplied handles, and its documented table references are limited. Via APPS synonyms it references PAY_FILE_DETAILS and PAY_FILE_DETAILS_S, the base and sequence/interface objects that describe individual output files and their attributes, and PAY_ASSIGNMENT_ACTIONS and PAY_TEMP_OBJECT_ACTIONS, which represent processing actions performed against assignments and temporary payroll objects. These references allow file generation to be tied to the payroll action framework, so that a file written for an assignment or temporary object is recorded and tracked.

System-level dependencies include DBMS_LOB for LOB read, write, and length operations; UTL_RAW for binary manipulation; DUAL for single-row SQL evaluation; PLITBLM for character-set and byte-level utility handling; and the STANDARD package for base PL/SQL services. Additional Payroll dependencies include HR_UTILITY and HR_MX_UTILITY (the Mexico localization utility package), and PAY_MAG_TAPE, the magnetic tape processing package, reflecting the package's role in localized and tape-oriented payroll output.

Usage Notes

APPS.PAY_CORE_FILES is normally invoked indirectly. Payroll concurrent programs, payment file generation routines, magnetic tape processes, and localization routines call its procedures to open a destination file, stream formatted or raw records into it, and close it on completion. Oracle Forms interfaces may call FORM_READ_CLOB to display or validate generated CLOB content within the form session. Custom code should treat the package as an internal utility rather than a public integration API: because it is referenced by 57 other packages and carries an OTHER classification in ETRM, direct modification is not supported, and customizations should layer on top of it rather than alter it. Developers extending payroll output should verify the current package specification for exact parameter signatures in their specific 12.1.1 or 12.2.2 environment, since behavior and availability of individual procedures can vary by patch level.