Search Results inl_simulation_pvt




Overview
Explore in AI Chat

Overview

INL_SIMULATION_PVT is a private PL/SQL package in the Oracle E-Business Suite Logistics (INL) module, belonging to the Transportation and Logistics execution layer. It encapsulates the core business logic for creating, copying, and purging transportation shipment simulations. A simulation in Oracle Transportation Management integration represents a hypothetical or draft shipment plan that allows planners to model freight, charges, taxes, and vendor allocations before firming the plan into actual shipments. The package is declared with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking schema rather than the defining schema, a convention common to private (PVT) Oracle APIs that are designed to be called by other packages rather than directly by end users.

The $Header comment indicates the source file is INLVSIMS.pls and that the package has been part of the shipped codebase since at least 2011, with the 12.1.1 / 12.2.2 releases carrying the same API signature. The naming convention _PVT signals that this is an internal implementation package; external consumers are expected to call a corresponding public API (_PUB) or a forms/concurrent program layer instead.

Key Procedures and Functions

  • CREATE_SIMULATION — Creates a new simulation record and its associated child rows (charge lines, tax lines, associations). It accepts a simulation record typed as simulation_rec, which carries identifiers for the parent entity (parent_table_name, parent_table_id, parent_table_revision_num), vendor and vendor site, freight code, org, and the 15 descriptive flexfield attribute columns. The record is passed IN OUT NOCOPY so the procedure can return the generated simulation_id and firmed_flag back to the caller. It follows the standard Oracle API contract with p_api_version, p_init_msg_list, p_commit, and the three x_return_status, x_msg_count, x_msg_data messaging outputs.
  • COPY_SIMULATION — Duplicates an existing simulation identified by p_simulation_id, producing a new simulation with the same header, line, and charge composition. This supports "what-if" scenario planning where a planner iterates on a baseline simulation. It writes back standard return status and message outputs.
  • PURGE_SIMULATIONS — Removes simulation records and their dependent child rows in bulk, allowing cleanup of obsolete or firmed simulations. Purge is typically driven by administrative housekeeping or concurrent processing. Like the other routines, it exposes the standard API version and message-handling parameters.

The package also defines public PL/SQL types — from_association_rec, from_association_tbl, simulation_rec, and simulation_id_tbl — that shape the data exchanged between the private procedures and their callers, notably for handling parent-to-child associations and collections of simulation IDs.

Tables Accessed

The package reads and writes the INL simulation base tables and their _S (security/audit or shadow) counterparts. The primary targets are INL_SIMULATIONS and INL_SIMULATIONS_S, which hold the simulation header. Child simulation details are stored across INL_CHARGE_LINES, INL_TAX_LINES, and INL_SHIP_LINE_GROUPS, each with an underscore-S companion. The package also references shipment structures — INL_SHIP_HEADERS, INL_SHIP_HEADERS_ALL, INL_SHIP_LINES_ALL, and their _S tables — to derive or populate shipment context for a simulation. The INL_ASSOCIATIONS and INL_ASSOCIATIONS_S tables store the parent-table linkage that determines which source document the simulation belongs to. Because the package is PVT, all table access is via APPS synonyms, consistent with a sealed private API.

Usage Notes

INL_SIMULATION_PVT is not intended to be called directly from end-user code. It is referenced by three other packages, which form the public entry points such as INL_SIMULATION_PUB or concurrent program drivers. In a standard EBS deployment, the procedures are invoked from Oracle Forms shipping or freight planning screens when a user actions a "create simulation", "copy simulation", or purge function, and from concurrent programs that run bulk simulation generation or cleanup. Customizations should call the public wrapper rather than this private package. Key operational points: set p_init_msg_list to FND_API.G_TRUE when invoking standalone to clear the message stack, pass p_commit as G_FALSE to retain control over transaction boundaries, and always inspect x_return_status before proceeding. No database links or external integrations are implied by the metadata; all activity is confined to the EBS INL schema.