Search Results get_rec_statistics




Overview
Explore in AI Chat

Overview

BEN_EXT_UTIL (Extract Utility) is a PL/SQL utility package owned by the APPS schema within the Oracle E-Business Suite Benefits module. Its stated purpose, per the package header, is to provide "utility style processes for the Benefits Extract System." The extract system is responsible for producing the flat-file or interface output that carries benefits enrollment, eligibility, and related data to external carriers, payroll systems, and third-party administrators. BEN_EXT_UTIL does not itself define extract business rules; rather it supplies the shared helper logic that the extract engine and its companion packages rely on. These helpers cover record name/number mapping, processing statistics, error and warning counters, extract date derivation, change and comparison date calculation, and a legacy record-counting routine.

The package was created in October 1998 and has been maintained continuously, with the header showing revisions through version 115.16 in April 2008. The 12.1.1 and 12.2.2 documentation lists the package as API classification UTIL, meaning it is intended for internal callers within the Benefits extract framework rather than as a public integration API. It is referenced by 16 other packages, confirming its role as a shared dependency in the extract subsystem.

Key Procedures and Functions

The documented program units (12 total) are:

  • WRITE_ERR — Records an error message against the extract processing context, supporting the diagnostics surfaced by the extract results tables.
  • GET_REC_NAM_NUM — Returns record name and number pairing, used to label and identify extract record layouts during processing.
  • GET_REC_STATISTICS — Returns record-level statistics for an extract run, such as counts of records processed.
  • GET_PER_STATISTICS — Returns person-level statistics for an extract run.
  • GET_ERR_WARN_STATISTICS — Returns the counts of errors and warnings generated during an extract.
  • GET_STATISTICS_TEXT — Produces the formatted textual representation of the statistics gathered by the preceding routines.
  • GET_VALUE — A general value-fetching function, originally migrated from benxsttl.pkh, used to retrieve extract-related attribute values.
  • GET_CHG_DATES — Derives change dates applicable to extract processing.
  • GET_CM_DATES — Derives comparison dates used by the extract logic.
  • GET_EXT_DATES — Derives extract (effective) dates.
  • CALC_EXT_DATE — Calculates an extract date; the history notes that a pl_pl_id parameter was added in version 115.14.
  • ENTRIES_AFFECTED — Determines the number of entries affected by an action. The history records that this procedure was moved from PQP to BEN in version 115.15, and that an additional parameter for "penserver" was added in version 115.16. This is the object associated with the user search term.

Tables Accessed

Through APPS synonyms, the package reads and writes the core extract definition and results tables, including BEN_EXT_RCD, BEN_EXT_CRIT_TYP, BEN_EXT_CRIT_VAL, BEN_EXT_DFN, BEN_EXT_RCD_IN_FILE, BEN_EXT_RSLT, BEN_EXT_RSLT_DTL, and BEN_EXT_RSLT_ERR. These support record definitions, extract criteria, and result/error capture. Date derivation draws on BEN_POPL_YR_PERD and BEN_YR_PERD for period boundaries. ENTRIES_AFFECTED additionally depends on payroll-side objects: PAY_DATED_TABLES, PAY_DATETRACKED_EVENTS, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_TYPE_RULES, and PAY_EVENT_GROUP_USAGES, reflecting its origin as a Payroll (PQP) routine.

Usage Notes

BEN_EXT_UTIL is invoked by the Benefits extract concurrent programs and by the other Benefits packages that orchestrate extraction. Its statistics and error routines populate the reporting shown on extract results, while the date and entries-affected functions are called during record selection and retroactive-change evaluation. Because it is classified as a utility package and is referenced widely within the Benefits extract subsystem, custom code should call it only when reproducing extract behavior, and should treat its signature as version-sensitive.