Search Results get_valid_reference_id




Overview
Explore in AI Chat

Overview

WSH_ITM_ASYN_MSGMAP_ASSISTANT is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the asynchronous message-mapping and acknowledgment-processing framework used by Oracle Shipping Execution (WSH) integration flows. Its name reflects its role: it is an "assistant" utility that maps inbound and outbound integration messages, tokenizes message and party identifiers, and manages the lifecycle of response messages exchanged with external trading partners or middleware. The package is classified by Oracle ETRM as an OTHER-type API rather than a public user-facing API, meaning it is an internal implementation component invoked by the broader WSH item/integration messaging stack rather than being called directly by end users.

Key Procedures and Functions

The ETRM metadata documents eleven procedures and functions within the package. The following describes their purpose based on documented naming and behavior:

  • TO — A conversion/routing helper, typically used to move or transform a message or value into the target mapping structure.
  • INSERT_ERROR — Records error information into the integration error-handling repository when a message fails validation or processing.
  • TOKENIZE_MESSAGEID — Parses and extracts tokenized components from a message identifier, enabling the framework to isolate the individual key elements (such as organization, transaction type, and sequence) embedded in the composite message ID.
  • TOKENIZE_PARTYID — Parses and extracts tokenized components from a trading-partner or party identifier, allowing the framework to resolve the sender or receiver of a message.
  • PROCESS_ACK_RECEIPT — Handles inbound acknowledgment messages, processing the receipt confirmation returned by the external partner.
  • UPDATE_DENIED_PARTY_MATCH — Updates matching records when a party is identified as denied, supporting restricted-party or denied-party compliance checks.
  • GET_RESPONSE_HDR — Retrieves the response header record associated with an outbound or inbound message.
  • MESSAGE_POSTPROCESS — Performs post-processing activities after the primary message mapping/processing step completes, such as status updates and follow-on bookkeeping.
  • INITIALIZE_DEBUG — Initializes debug/logging behavior for the package session, aiding diagnostics during integration troubleshooting.
  • GET_VALID_REFERENCE_ID — Returns a validated reference identifier used to correlate messages across the integration exchange.

The full procedure list also includes one additional documented routine; all are internal helpers within the asynchronous message-mapping framework.

Tables Accessed

The package reads and writes several WSH integration tables accessed through APPS synonyms:

  • WSH_ITM_PARAMETER_SETUPS_B — Stores parameter configuration used to drive message mapping and integration behavior.
  • WSH_ITM_REQUEST_CONTROL — Controls request-level processing, tracking the state and routing of integration requests.
  • WSH_ITM_RESPONSE_HEADERS and WSH_ITM_RESPONSE_HEADERS_S — Base and translation tables holding response header information for messages exchanged.
  • WSH_ITM_RESPONSE_LINES — Holds line-level details of responses, supporting granular acknowledgment content.
  • DUAL — Used for singleton SQL evaluations and simple computations.
  • PLITBLM — The standard PL/SQL table-of-varchar2 type referenced in package declarations.
  • UTL_FILE — Oracle-supplied package used for file I/O, likely for logging or debug output.

Usage Notes

WSH_ITM_ASYN_MSGMAP_ASSISTANT is invoked internally by the WSH asynchronous messaging and acknowledgment framework, typically through concurrent programs, messaging listener processes, or orchestration code that handles inbound/outbound partner messages. It is not intended for direct invocation by end users from Oracle Forms. The package is not referenced by other documented packages in ETRM (0 dependents), confirming that it sits at the lower layer of the stack and is consumed by the messaging runtime rather than being called from higher-level application APIs. Custom code extending WSH integration flows may reference these routines for message tokenization and acknowledgment handling, but development should treat them as internal APIs subject to change between releases. Because the package is documented as VALID in both 12.1.1 and 12.2.2, it remains available across those releases without significant structural difference in documented dependencies.