Results for “ieu_msg_producer_pub”

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

Overview

The APPS.IEU_MSG_PRODUCER_PUB package is a public (PUB-classified) PL/SQL API within the Oracle E-Business Suite Interaction and Escalation Management / Universal Work Queue messaging infrastructure. Its header revision (120.0) and the module name IEUPMSGS.pls indicate it belongs to the IEU (Interaction/Email/Universal) messaging layer that orchestrates work items, notifications, and message records across CRM and service-oriented flows.

The package's business purpose is to act as a message producer: it accepts caller-supplied message content and metadata and persists a new outbound message record into the IEU messaging tables. It abstracts the physical insert and identifier retrieval so that callers—typically other PL/SQL APIs, concurrent programs, or workflow-enabled components—do not need to manage the underlying table structures directly.

The package is declared with AUTHID CURRENT_USER, meaning its SQL executes with the privileges of the invoking schema rather than the defining schema, and all referenced IEU tables are accessed through APPS synonyms. This is consistent with the standard Oracle EBS public API convention.

Key Procedures and Functions

The ETRM metadata documents exactly one public procedure:

• SEND_PLAIN_TEXT_MSG — The sole documented entry point. It produces a plain-text message and returns the newly created message identifier to the caller. Following the Oracle EBS PL/SQL API standard, the procedure accepts an API version, an initialization flag, and a commit flag; identifies the owning application and the target resource (with an associated resource type defaulting to RS_INDIVIDUAL); carries the message title and body; and links the message to a work item through a work item object code and primary key identifier. Output parameters return the generated message ID along with the standard return status, message count, and message data fields used for error reporting.

The package also declares two named exceptions:

• REQUIRED_PARAM_NULL (error -20000) — raised when a mandatory parameter is not supplied.
• PARAM_EXCEEDS_MAX (error -20001) — raised when a supplied parameter exceeds its permitted maximum length.

No other procedures or functions are documented for this package. Writers and maintainers should treat SEND_PLAIN_TEXT_MSG as the supported, stable interface and avoid calling internal helpers directly.

Tables Accessed

The documented table references resolve through APPS synonyms:

• IEU_MSG_MESSAGES — The primary message table. SEND_PLAIN_TEXT_MSG inserts the new plain-text message here, capturing the resource, title, body, and work item linkage. The generated message identifier returned via x_message_id originates from this table.
• IEU_MSG_MESSAGES_S1 — The sequence associated with the messages table. It supplies the surrogate primary key for each inserted message row, ensuring unique, gap-tolerant identifiers.
• DUAL — Referenced for standard single-row expressions such as sequence access or constant validation.

Because the package is documented as referenced by one other package, callers should expect both read and write activity against IEU_MSG_MESSAGES whenever the producer is invoked.

Usage Notes

• Invoke SEND_PLAIN_TEXT_MSG whenever application logic needs to generate a plain-text IEU message tied to a work item, rather than inserting into IEU_MSG_MESSAGES directly.
• Callers must always supply the required parameters—application ID, resource ID, title, and body—or the procedure raises REQUIRED_PARAM_NULL. Length violations raise PARAM_EXCEEDS_MAX.
• Honor the standard API contract: pass FND_API.G_FALSE for p_init_msg_list unless a fresh message stack is desired, and set p_commit according to transaction ownership. The procedure returns status via x_return_status, x_msg_count, and x_msg_data.
• The API is typically called from PL/SQL within forms, concurrent programs, workflow components, or custom extensions; it is not intended for direct end-user SQL execution.
• Given AUTHID CURRENT_USER, the invoking schema must possess the necessary privileges on the underlying IEU objects.