APIs Defined in ECX_STANDARD

setEventDetails

PL/SQL Syntax

procedure setEventDetails
(eventname in varchar2,
 eventkey in varchar2,
 parameter1 in varchar2,
 parameter2 in varchar2,
 parameter3 in varchar2,
 parameter4 in varchar2,
 parameter5 in varchar2,
 parameter6 in varchar2,
 parameter7 in varchar2,
 parameter8 in varchar2,
 parameter9 in varchar2,
 parameter10 in varchar2,
 retcode out pls_integer,
 retmsg out varchar2);

Description

Sets event details to raise a business event for inbound transactions.

This is defined at the root level as a post-process action to indicate that an inbound message has been processed. Any event subscription defined in the Oracle E-Business Suite interested in this inbound message will proceed to consume it.

This procedure must be used for all inbound transactions. The argument values vary by transaction with the exception of the confirmation message where the argument values are specific. See How to Implement an OAG Confirmation BoD to see how the event details are defined.

Arguments (input)

eventname Unique identifier for the business event associated with the inbound message. The event name consists of the following components:
ORACLE.APPS.<COMPONENT>.<TASK>.<EVENT>
where:
COMPONENT is based on the internal transaction type entered using the Define Transactions window. It represents the product short code.
TASK is based on the internal transaction subtype entered using the Define Transactions window. It represents a description of the object.
EVENT is a literal that describes the business function of the message.
Following is an example of an Event Name that identifies a confirmation event associated with an outbound purchase order ORACLE.APPS.PO.POO.CONFIRM
eventkey Unique identifier for the business document from the Oracle E-Business Suite associated with the business event.
parameter1 through parameter10 User-defined parameters to pass data of interest to the event subscription defined in the Oracle E-Business Suite for the inbound business document.

Arguments (output)

retcode Return code for the procedure.
retmsg Return message for the procedure.

getEventDetails

PL/SQL Syntax

procedure getEventDetails
(eventname out varchar2,
 eventkey out varchar2,
 itemtype out varchar2,
 itemkey out varchar2,
 parentitemtype out varchar2,
 parentitemkey out varchar2,
 retcode out pls_integer,
 retmsg out varchar2);

Description

Gets event details using the event name maintained by the XML Gateway Execution Engine.

Arguments (input)

None.

Arguments (output)

eventname Event name passed internally to the procedure. It is a unique identifier for the business event associated with the transaction.
eventkey Event key associated with the event name passed.
itemtype Unique identifier for a group of objects that share the same set of item attributes (also known as variables).
Item types are created using the Workflow Builder and are used by Oracle e-Business Suite application modules to group related functions.
itemkey Unique identifier for an item in an item type
parentitemtype Parent item type for the item type
parentitemkey Parent item key for the item key
retcode Return code for the procedure
retmsg Return message for the procedure

getEventSystem

PL/SQL Syntax

(from_agent out varchar2,
 to_agent out varchar2,
 from_system out varchar2,
 to_system out varchar2,
 retcode out pls_integer,
 retmsg out varchar2);

Description

Gets event details related to the system and agent using the event name maintained by the XML Gateway Execution Engine.

The procedure is context-sensitive, so you will receive return values relevant to the context. The "from" parameters are for inbound transactions. The "to" parameters are for outbound transactions.

Arguments (input)

None

Arguments (output)

from_agent Workflow agent (queue) the inbound message is dequeued from.
to_agent Workflow agent (queue) the outbound message is enqueued to.
from_system System processing the inbound message
to_system System processing the outbound message
retcode Return code for the procedure
retmsg Return code for the message

getReferenceID

PL/SQL Syntax

function getReferenceID
return varchar2;

Description

Returns the value associated with the REFERENCEID element of the OAG CONTROLAREA. The field contains a concatenated value consisting of system name, event name, and event key delimited by ":". This function is used for message maps in which the OAG standard is not used.

For message maps created using the OAG standard, the ECX_OAG_CONTROLAREA_TP_V view is used to retrieve the reference_id identified by the business event. This value is used to map to the OAG CNTROLAREA, REFERENCEID element.

Arguments (input)

None.

Arguments (output)

None.