Search Results bom_struct_sync_pub




Overview
Explore in AI Chat

Overview

APPS.BOM_STRUCT_SYNC_PUB is a public PL/SQL package in Oracle E-Business Suite that supports the synchronization of bill of material structures between Oracle EBS and external or downstream systems. The package is owned by the APPS schema and is classified as a PUB (public) API, indicating that it is intended to be called from outside the owning application and that its interface is considered stable for integration purposes. The documented body header identifies the source file as BOMSYNCB.pls (with an accompanying specification BOMSYNCS.pls) and records a creation date of 02-Jan-2008 by PGANDHIK. The package is part of the BOM (Bills of Material) product family, and its name reflects its role as a structure synchronization publisher: it extracts and formats bill of material structure data so that it can be consumed by external integration layers or service-oriented interfaces. The $Header$ line (120.1) indicates the file revision level, and the noship designation in the header is a source control annotation rather than a restriction on runtime use. In the context of release 12.1.1 and 12.2.2, the package provides a supported, encapsulated mechanism for obtaining BOM structure payloads without requiring custom code to query the base BOM tables directly.

Key Procedures and Functions

The documented package metadata for ETRM 12.2.2 identifies three public procedures or functions, each serving a distinct step in the synchronization flow:

  • GET_STRUCTURE_PAYLOAD — Assembles and returns the structure payload for a bill of material. This is the primary data extraction routine, producing the formatted representation of the BOM structure that downstream systems consume.
  • GET_ITEMS_TO_SYNCH — Determines which items require synchronization. This routine identifies the set of item identifiers eligible for structure publishing, allowing callers to drive incremental or bulk synchronization processes.
  • EXPLODE_STRUCTURE — Performs the structural explosion of a bill of material, resolving the parent-to-component relationships that constitute the BOM hierarchy. This is the core engine that supplies the exploded data used when building the payload.

The source excerpt also documents internal validation helpers, notably VALIDATE_ORG_ID and VALIDATE_ITEM_ID. VALIDATE_ORG_ID accepts an organization identifier and returns a status code while populating an error message output parameter; it raises the BOM message BOM_INVALID_ORGANIZATION when the organization identifier is null or empty. VALIDATE_ITEM_ID extends this by verifying that the supplied item exists in MTL_SYSTEM_ITEMS_B for the given organization and that it is orderable (CUSTOMER_ORDER_FLAG and CUSTOMER_ORDER_ENABLED_FLAG both set to 'Y'), raising BOM_NOT_ORDERABLE_TOP_ITEM when the check fails. These validation routines reflect the input-guarding pattern used by the public entry points. Parameter lists for the documented public procedures are not reproduced in the available metadata and are therefore not stated here.

Tables Accessed

The documented tables and objects referenced through APPS synonyms are:

  • BOM_EXPLOSIONS — The bill of material explosion view, used by EXPLODE_STRUCTURE to resolve the hierarchical parent-component relationships of a structure.
  • MTL_SYSTEM_ITEMS_B — The item master base table, used to validate item identifiers and to confirm orderability attributes such as CUSTOMER_ORDER_FLAG and CUSTOMER_ORDER_ENABLED_FLAG.
  • XMLTYPE — The Oracle XML datatype, used to construct and return the structured payload produced by GET_STRUCTURE_PAYLOAD.
  • XMLAGG — The SQL/XML aggregate function, used to concatenate multiple rows into a single XML document, which is the mechanism by which exploded structure rows are assembled into one payload.

The combination of XMLAGG and XMLTYPE confirms that the package emits XML-formatted output, consistent with a service-oriented or interface-table integration pattern.

Usage Notes

Because the package is classified as PUB, it is intended for invocation from external integration code, concurrent programs, and other Oracle EBS modules rather than being restricted to intra-package use. Typical invocation patterns include a concurrent program that calls GET_ITEMS_TO_SYNCH to identify candidate items, followed by GET_STRUCTURE_PAYLOAD for each item, with EXPLODE_STRUCTURE supplying the expanded structure data. Callers should perform organization and item validation before invoking the payload routines so that the BOM_INVALID_ORGANIZATION and BOM_NOT_ORDERABLE_TOP_ITEM errors are surfaced predictably. Custom code referencing this package should treat it as a public interface and avoid dependencies on internal helper routines. The ETRM metadata records no packages that reference BOM_STRUCT_SYNC_PUB, indicating it sits at the top of the call stack as an entry point. In 12.1.1 and 12.2.2 the package remains available under the APPS schema; as with all public BOM APIs, testing in a non-production environment is advisable before deployment.