Results for “stop_action”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

WSH_TRIP_STOPS_PUB is a public PL/SQL API package in the Oracle E-Business Suite Logistics Execution / Transportation Management module. It provides the programmatic interface for managing the individual stops that make up a trip or trip leg within Oracle Shipping. A trip represents a planned movement of goods, and each trip stop identifies a discrete location at which the vehicle is scheduled to arrive, depart, pick up, or deliver freight. The package encapsulates the business logic for creating, updating, and transitioning these stops through their lifecycle states — planned, unplanned, arrived, closed, released for picking, and deleted — while insulating callers from the underlying WSH schema implementation details. As a PUBLIC-classified API, it is designed for external invocation by other application modules, forms, and customer extensions rather than being restricted to internal package use. Its published interface enforces the standard Oracle API conventions, including FND-style message list handling and consistent return status reporting.

Key Procedures and Functions

The ETRM metadata documents two procedures within the package body:

• CREATE_UPDATE_STOP — The core data maintenance entry point. This procedure inserts a new trip stop or modifies an existing one depending on the identifying information supplied by the caller. It is the primary target for the search term "create_update_stop," reflecting its role in the standard create-or-update pattern common to Oracle EBS public APIs. Because Oracle's create/update procedures are dual-purpose, callers typically supply a stop identifier or a unique natural key (such as a combination of trip and stop location) to signal an update; the absence of such a key indicates a new stop record should be created.
• STOP_ACTION — A state-transition procedure that performs a named action against an existing stop. Per the embedded source header, valid action codes are PLAN, UNPLAN, ARRIVE, CLOSE, PICK-RELEASE, and DELETE. The stop to be acted upon is identified either directly by stop ID or by a unique combination of trip ID/trip name, stop location ID/stop location code, and planned departure date. Standard API parameters include the API version number, an initialization flag for the message list, and the return status, message count, and message data output parameters.

Tables Accessed

The documented table references are limited and are accessed through APPS synonyms rather than direct schema-qualified names:

• WSH_LOCATIONS — The location master referenced when validating or resolving stop location identifiers and codes. Trip stops must point to valid locations for routing and scheduling purposes, so this table supports the lookup logic that connects a stop to its physical place.
• PLITBLM — A general-purpose EBS storage table (the "PL/SQL integer table, line-level message" structure) used for message and buffer handling. Its presence in the metadata indicates the package supports bulk or table-driven message propagation, consistent with the message list semantics declared in the API signature.

The base trip stop table itself is implied by the package's function but not enumerated in the supplied excerpt.

Usage Notes

WSH_TRIP_STOPS_PUB is invoked whenever stop-level information for a trip must be created, amended, or advanced in status without going through the Shipping Transactions form. Typical callers include:

• Oracle Shipping forms and related transportation UI flows that record planning, arrival, and closure actions against trip stops.
• Other PL/SQL packages — the metadata records six referencing packages — that orchestrate trip planning, pick release, or delivery consolidation and need to manipulate stops programmatically.
• Customer and partner extensions, interfaces, and concurrent programs that build or maintain trips via the public API layer rather than by direct DML.

Callers should always honor the standard API contract: pass a valid API version, check x_return_status for FND_API.G_RET_STS_SUCCESS, and iterate the message list using the returned message count and data when errors occur. Because the package is classified PUB and is referenced across multiple modules, direct table updates to trip stop data should be avoided in favor of these procedures to preserve validation, action-code enforcement, and message consistency across EBS 12.1.1 and 12.2.2 environments.