Search Results ar_br_format_wrapper_pkg




Overview
Explore in AI Chat

Overview

APPS.AR_BR_FORMAT_WRAPPER_PKG is a wrapper package in the Oracle E-Business Suite Receivables (AR) module, specific to the Brazilian localization ("BR" in the name). Its documented purpose is to provide a simplified entry point for submitting report formats used by Brazilian fiscal and statutory reporting requirements, most notably the generation of formatted output tied to Receivables transaction and payment data. The package is declared with AUTHID CURRENT_USER, meaning its SQL executes with the privileges of the invoking user rather than the definer, a common pattern for localization code that must respect the calling session's security context. The package header carries a version marker dated 2002, indicating it is a long-standing component whose interface has remained stable across release 12.1.1 and 12.2.2. In practical terms, the package exists to decouple the internal format-generation logic from the calling form or concurrent program, exposing a single documented procedure that callers use instead of invoking underlying report submission APIs directly. This abstraction allows Oracle to change the internals while preserving the public interface.

Key Procedures and Functions

ETRM documents a single public procedure for this package:

  • SUBMIT_FORMATS — The only documented routine. It accepts an error buffer and return code (the standard concurrent program callback parameters errbuf and retcode), a FORMAT identifier, a BR numeric parameter, optional AFROM and ATO range parameters (both defaulting to NULL), and a SOB set of books parameter. This signature confirms that the procedure is designed to be invoked as a concurrent program executable: the errbuf/retcode out-parameters are the conventional mechanism by which a PL/SQL concurrent program signals success or failure to the Concurrent Manager. The FORMAT argument selects which Brazilian report layout to produce, while AFROM, ATO, and SOB supply the data range and accounting context. No additional parameters should be assumed beyond those documented in the package header.

Tables Accessed

ETRM records the following tables as referenced through APPS synonyms:

  • RA_CUSTOMER_TRX and RA_CUST_TRX_TYPES_ALL — Supply the transaction data and transaction type definitions that populate the formatted report output.
  • AR_PAYMENT_SCHEDULES — Provides installment and payment-schedule detail associated with the selected transactions, supporting the payment-oriented Brazilian formats.
  • AP_PAYMENT_PROGRAMS — References the payment program definitions used to drive or associate the report's payment context.
  • FND_CONCURRENT_REQUESTS — Used to track and correlate the submitted concurrent request, consistent with the procedure's role as a concurrent program entry point.

The package therefore reads transactional and payment data and writes/tracks concurrent request state; it does not appear to be a maintenance API for base Receivables entities.

Usage Notes

Because SUBMIT_FORMATS follows the concurrent program calling convention, this package is most commonly invoked as the executable of a concurrent program registered in the Receivables responsibility — a user searching for "submit_formats" is typically looking for that concurrent program definition or the function name behind it. The FORMAT parameter lets a single concurrent program serve multiple report layouts, while AFROM/ATO allow date- or range-scoped runs and SOB scopes the set of books. Standard usage is through the Submit Request form or the Concurrent Manager rather than direct PL/SQL calls from a form; however, the package can also be called from custom code or a wrapper program provided the standard errbuf/retcode handling is implemented. As localization code, it should be treated as Oracle-supported but sensitive to patch level, and its AUTHID CURRENT_USER declaration means callers must have appropriate privileges on the referenced AR and AP objects. ETRM notes it is referenced by zero other packages, confirming it is a leaf-level component driven by concurrent submission rather than by other PL/SQL APIs.