Search Results get_document

Overview

WSH_DOCUMENT_PUB is a public PL/SQL package in the Oracle E-Business Suite Shipping (WSH) module, owned by the APPS schema. Its documented API classification is "PUB," indicating that the package exposes a supported public interface intended for invocation by other Oracle application modules as well as by customer extensions. The package body header carries a version reference (120.1, dated 2006/01/18), and the package is implemented in the source file WSHPPACB.pls.

The business function of WSH_DOCUMENT_PUB centers on retrieving shipping documentation associated with outbound order lines. Shipping documents include packing slips, bills of lading (BOL), advance ship notices (ASN), and similar artifacts generated during the pick, pack, and ship workflow. The package abstracts the underlying document-instance data model so that callers can obtain the attributes of the currently open document for a given order line without directly querying the shipping tables. This is particularly relevant in Oracle EBS 12.1.1 and 12.2.2, where shipping execution and document generation are tightly integrated with Oracle Order Management and the Delivery-based fulfillment model.

Key Procedures and Functions

The ETRM metadata documents exactly one public procedure in this package: GET_DOCUMENT.

• GET_DOCUMENT — Returns, as an output parameter, a record containing all attributes of the currently open document of a specified type for a given OE order line. Documented input parameters include the standard API version (p_api_version), message-list initialization flag (p_init_msg_list), commit flag (p_commit), and validation level (p_validation_level), together with the OE order line identifier (p_order_line_id) and the document type code (p_document_type, covering types such as PACK_TYPE, BOL, and ASN). Documented output parameters include the standard message count (x_msg_count), message data (x_msg_data), and return status (x_return_status, returning 'S', 'E', or 'U'), plus the document record (x_document_rec) carrying the document attributes. The documented pre-condition states that only one open document of a specific type should exist per delivery; if more than one open document is found, the API returns the first available one.

Tables Accessed

The package references the following tables through APPS synonyms:

• WSH_DOCUMENT_INSTANCES — The core table of shipping document instances. GET_DOCUMENT reads this table to obtain the attributes of the open document instance of the requested type for the order line or delivery.
• WSH_DELIVERY_DETAILS — Stores delivery detail (line-level) information. It is used to resolve the relationship between the OE order line and its corresponding delivery detail, enabling the API to locate the relevant document.
• WSH_DELIVERY_LEGS — Holds delivery leg (itinerary/stop) information. This table is consulted to associate documents such as bills of lading with the correct delivery leg.

Usage Notes

WSH_DOCUMENT_PUB.GET_DOCUMENT is typically invoked when application logic requires the current open shipping document for a specific order line and document type, for example to print or display a packing slip, bill of lading, or ASN, or to pass document data to downstream processes. Callers should pass the OE order line identifier and the appropriate document type code, and should inspect x_return_status and the message stack before consuming x_document_rec.

Because the package is classified PUB, it is a supported integration point for custom code and for other Oracle modules; the ETRM metadata records that the package is referenced by one other package. Standard API conventions apply: callers may control message-list initialization and commit behavior through the provided flags, and no exceptions are documented, so error conditions are surfaced through the return status and message stack rather than raised exceptions. Given the documented pre-condition, callers should not assume deterministic selection when multiple open documents of the same type exist for a delivery.