Search Results sync_ship_partial_cache




Overview
Explore in AI Chat

Overview

The APPS.ONT_SHIP_PARTIAL_DEF_UTIL package is a utility (helper) package within the Oracle Order Management (ONT) module of Oracle E-Business Suite. Its name reflects its role: Ont for Order Management, Ship_Partial for the shipping partial-allowed attribute, and Def_Util for the definition utility that supports attribute-value handling. The package is classified as a UTIL API in the ETRM repository, indicating it is not a public business API but an internal support component used by other Order Management code.

The package centers on the view/entity OE_AK_SHIP_PARTIAL_V, which represents the "Ship Partial Allowed" attribute record. Shipping partial criteria govern whether an order line may be shipped in multiple shipments or must ship in full. The utility provides cached, programmatic access to the attributes of that entity and a synchronization routine to refresh the cache when the underlying shipping-partial setting changes. This design pattern is consistent with Oracle's AK (Attribute Knowledge) framework, where generated "Def_Util" packages wrap descriptive-flexfield-style attribute access for a specific entity.

Key Procedures and Functions

  • GET_ATTR_VAL_VARCHAR2 — Returns the value of a named attribute from a OE_AK_SHIP_PARTIAL_V%ROWTYPE record, cast as a VARCHAR2. It is a typed attribute accessor used to read text-typed values from a shipping-partial record.
  • GET_ATTR_VAL_DATE — Returns the value of a named attribute from a OE_AK_SHIP_PARTIAL_V%ROWTYPE record, cast as a DATE. It is the date-typed counterpart to the VARCHAR2 accessor, used for date attributes on the same entity.
  • SYNC_SHIP_PARTIAL_CACHE — Synchronizes the package's cached record (g_cached_record) with the current shipping-partial setting, accepting the allowed value as input and returning a NUMBER status. This routine keeps the in-memory cache consistent with the persisted "Ship Partial Allowed" configuration.

The package also declares a global variable, g_cached_record, of type OE_AK_SHIP_PARTIAL_V%ROWTYPE, which holds the cached entity row. The package is compiled with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than the definer.

Tables Accessed

The documentation excerpt identifies the entity OE_AK_SHIP_PARTIAL_V as the structure underpinning the package. In Oracle EBS this is a view over Order Management shipping/shipping-partial attribute data, exposed to the APPS schema. The package does not directly document base tables; its data access is mediated through this view and the cached %ROWTYPE record. The cache synchronization routine implies an underlying configuration store (the shipping-partial allowed setting) that the cache mirrors.

Usage Notes

As a UTIL-classified package, ONT_SHIP_PARTIAL_DEF_UTIL is invoked internally rather than by end users. Typical invocation points include Order Management forms and other ONT packages that need to evaluate whether partial shipment is permitted on an order or line, and concurrent or batch processes that read shipping-partial attributes during order import, shipping, or pick-release processing. The ETRM metadata indicates the package is referenced by one other package, confirming its role as a dependency of higher-level Order Management logic. The cache-synchronization function is typically called whenever the shipping-partial value is changed, so that subsequent attribute reads return current data without repeated queries. Custom code should generally prefer the higher-level public Order Management APIs rather than calling this utility directly; direct calls are appropriate only when mirroring Oracle's internal attribute-access pattern and after confirming the view and cache behavior across releases. The package header dates to 2009 (script OEXDFWKB.pls), and it is present in both 12.1.1 and 12.2.2 environments.