Search Results overlay_segments




Overview
Explore in AI Chat

Overview

AP_CREATE_PAY_DISTS_PKG is an Oracle Payables (AP) database package that supports the construction of payment distributions by resolving account combinations against the Oracle General Ledger Accounting Flexfield. Its principal documented routine, overlay_segments, performs the segment-level merge of two Accounting Flexfield structures — a "primary" segment array and an "overlay" segment array — and returns the validated combination identifier (CCID) for the resulting account, or the reason the combination could not be flexbuilt.

The package therefore serves a narrowly scoped but critical role in the Payables accounting flow: when a payment distribution must inherit some but not all segments from another account (for example, when only the balancing segment or only the natural account segment should be carried over), this package computes the merged segment string and validates it through the flexfield APIs before the distribution is written. The header comment dates the shipped version (120.4, 2004) and identifies the file as appdistb.pls, indicating the source object is the payment distributions builder. The package is classified in the ETRM metadata as "OTHER" rather than as a public API, reflecting its internal, helper-level purpose.

Key Procedures and Functions

The ETRM metadata documents a single procedure for this package:

  • OVERLAY_SEGMENTS — Performs either an Account segment overlay or a Balancing segment overlay on two input segment arrays and returns the validated CCID of the resulting overlay combination, together with an "unbuilt flex" indicator and a reason code when flexbuilding fails. The procedure accepts the primary segment array, the overlay segment array, the number of segments, the chart of accounts identifier, the target flexfield segment number, a flex qualifier name (documented values are GL_ACCOUNT and GL_BALANCING), a segment delimiter, and a calling sequence for diagnostic traceability.

Two documented overlay cases govern its behaviour:

  • Case 1 — Account segment overlay (qualifier GL_ACCOUNT): the resulting segment array is derived from the overlay segments in every position except the designated flexfield segment, where the primary segment is retained. Conceptually, all segments originate from the overlay account except the natural account segment, which originates from the primary account.
  • Case 2 — Balancing segment overlay (qualifier GL_BALANCING): the resulting segment array is derived from the primary segments in every position except the designated flexfield segment, where the overlay segment is retained. Conceptually, all segments originate from the primary account except the balancing segment, which originates from the overlay account.

The procedure loops across the segment array using the supplied segment count, assigns each position according to the applicable case, and then invokes flexfield validation to obtain the CCID. Failure to build the combination is reported through the output parameters rather than by raising an unhandled exception, allowing the caller to degrade gracefully.

Tables Accessed

The ETRM metadata for this object does not record any directly referenced tables. The package operates on in-memory flexfield segment arrays of type FND_FLEX_EXT.SEGMENTARRAY and relies on the FND flexfield server APIs for validation of the constructed combination; any table access against key flexfield definitions and combination tables occurs indirectly through those APIs rather than through direct DML by this package.

Usage Notes

AP_CREATE_PAY_DISTS_PKG is an internal package body, and the ETRM metadata records no packages that reference it directly. It is not intended as a public integration point and is not exposed as a standalone concurrent program. Typical invocation is from other Payables internal code paths that assemble payment distributions, where account segments must be selectively overlaid from a source account onto a target account before the distribution is created.

  • Because the ETRM classification is "OTHER" and public references are absent, custom code should not depend on this package. Customizations that need account overlay behaviour should implement equivalent logic using supported FND_FLEX_EXT flexfield APIs.
  • The P_calling_sequence parameter is intended to be chained by callers so that debug and error messages identify the full call stack; callers should supply and prepend their own identifier as demonstrated in the procedure body.
  • Any caller must interpret the P_unbuilt_flex and P_reason_unbuilt_flex outputs rather than assuming the CCID is valid; a non-null "unbuilt" flag indicates that the overlaid combination did not pass flexfield validation.