Results for “send_message”

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

Overview

OKC_AQ_PUB is the public Advanced Queuing (AQ) interface for the Oracle Contracts (OKC) module in Oracle E-Business Suite. Its role is to provide a controlled, callable wrapper around Oracle Streams Advanced Queuing so that contract-related business events—such as contract approval outcomes, fulfillment events, and lifecycle notifications—can be enqueued to and dequeued from the OKC event queues. The package is classified as a PUB API, indicating it is a supported public interface intended for invocation by other Oracle EBS modules and by customer extensions rather than being reserved for internal use.

The package is declared AUTHID CURRENT_USER, meaning it executes with the privileges of the calling user, which is consistent with its position as a thin, reusable integration layer. Its header establishes the canonical queue names through constants bound to OKC_QUEUE_PVT.event_queue_name and OKC_QUEUE_PVT.outcome_queue_name, so consumers never hard-code queue identifiers. It also defines important AQ semantics, notably g_msg_expire (defaulting to dbms_aq.never) and a dequeue wait of five seconds.

Key Procedures and Functions

The package exposes a single documented entry point, SEND_MESSAGE. As documented, the procedure is overloaded to support both VARCHAR2 and CLOB message payloads, allowing callers to queue either short structured messages or large contract documents without changing the calling convention. The procedure follows the standard EBS API signature pattern, accepting an API version and an initialization flag that controls whether the message list is reset at the start of the call. Internally it relies on the subtype definitions in OKC_AQ_PVT (corrid_rec_typ and msg_tab_typ) to carry correlation identifiers and message collections. The header also declares g_exception_halt_validation and standard error-handling tokens (SQLerrm, SQLcode, G_UNEXPECTED_ERROR) so that AQ failures surface predictably to the calling application.

Tables Accessed

The only documented database object referenced through APPS synonyms is DBMS_AQ, the Oracle-supplied PL/SQL package that provides the enqueue and dequeue primitives. OKC_AQ_PUB does not query conventional contract tables directly; instead, all payload movement is mediated through the AQ infrastructure and the OKC private queue definitions. Other OKC packages supply the business data that becomes the message payload.

Usage Notes

OKC_AQ_PUB is typically invoked from other OKC APIs and from integration code that needs to publish contract events asynchronously to downstream consumers—whether internal subscribers such as Order Management or custom JMS/XML gateway subscribers. The ETRM metadata records that the package is referenced by 15 other packages, confirming that it functions as a shared messaging utility within the Contracts product family. Customizations should call SEND_MESSAGE through the documented public signature, respect the overloaded VARCHAR2/CLOB variants, and rely on the constants exposed in the header rather than embedding literal queue names. Because queue names are inherited from OKC_QUEUE_PVT, the package remains portable across EBS 12.1.1 and 12.2.2 without modification.