APIs Defined in ECX_TRADING_PARTNER_PVT

get_receivers_tp_info

PL/SQL Syntax

procedure get_receivers_tp_info
(p_party_id out number,
 p_party_site_id out number,
 p_org_id out pls_integer,
 p_admin_email out varchar2,
 retcode out pls_integer,
 retmsg out varchar2);

Description

Gets Trading Partner data using the receiver's trading partner ID maintained by the XML Gateway Execution Engine. The Trading Partner data is entered using the Define Trading Partners window.

Arguments (input)

None

Arguments (output)

p_party_id Trading Partner ID
p_party_site_id Site associated with the Trading Partner.
p_org_id Organization associated with the Trading Partner site.
p_admin_email E-mail address associated with the Trading Partner contact.
retcode Return code for the procedure
retmsg Return message for the procedure

get_senders_tp_info

PL/SQL Syntax

procedure get_senders_tp_info
(p_party_id out number,
 p_party_site_id out number,
 p_org_id out pls_integer,
 p_admin_email out varchar2,
 retcode out pls_integer,
 retmsg out varchar2);

Description

Gets Trading Partner data using the sender's trading partner ID maintained by the XML Gateway Execution Engine. The Trading Partner data is entered using the Define Trading Partners window.

Arguments (input)

None

Arguments (output)

p_party_id Trading Partner ID
p_party_site_id Site associated with the Trading Partner.
p_org_id Organization associated with the Trading Partner site.
p_admin_email E-mail address associated with the Trading Partner contact.
retcode Return code for the procedure
retmsg Return message for the procedure

get_sysadmin_email

PL/SQL Syntax

procedure get_sysadmin_email
(email_address out varchar2,
 retcode out pls_integer,
 errmsg out varchar2);

Description

Gets the system administrator e-mail address defined for the ECX: System Administrator Email Address profile option.

This procedure is not required if your are using the Send Error Message action to send notifications to the system administrator. The address for the system administrator is derived.

Arguments (input)

None

Arguments (output)

email_address E-mail address identified in the ECX: System Administrator Email Address system profile.
retcode Return code for the procedure
errmsg Return message for the procedure

getEnvelopeInformation

PL/SQL Syntax

procedure getEnvelopeInformation
(i_internal_control_number in pls_integer,
 i_message_type out varchar2,
 i_message_standard out varchar2,
 i_transaction_type out varchar2,
 i_transaction_subtype out varchar2,
 i_document_number out varchar2,
 i_party_id out varchar2,
 i_party_site_id out varchar2,
 i_protocol_type out varchar2,
 i_protocol_address out varchar2,
 i_username out varchar2,
 i_password out varchar2,
 i_attribute1 out varchar2,
 i_attribute2 out varchar2,
 i_attribute3 out varchar2,
 i_attribute4 out varchar2,
 i_attribute5 out varchar2,
 retcode out pls_integer,
 retmsg out varchar2);

Description

Retrieves message envelope data using the internal control number maintained by the XML Gateway Execution Engine.

See XML Gateway Envelope for information regarding the message envelope.

Arguments (input)

i_internal_control_number Internal control number maintained by the XML Gateway execution engine associated with the inbound message.

Arguments (output)

i_message_type The message type is defaulted to "XML"
i_message_standard The XML standard used for the business document received from the Trading Partner.
The XML standard is entered using the Define XML Standards window and used in the Define Transactions window.
i_transaction_type External transaction type associated with the business document received from the Trading Partner.
The external transaction type is entered using the Define Transactions window and is used in the Define Trading Partners window.
i_transaction_ subtype External transaction subtype associated with the business document received from the Trading Partner.
The external transaction subtype is entered using the Define Transactions window and is used in the Define Trading Partners window.
i_document_ number Unique identifier for the business document received from the Trading Partner. This field is not used by XML Gateway but is available for the Oracle E-Business Suite receiving application module.
i_party_id Not Used.
i_party_site_id The source Trading Partner Location Code entered using the Define Trading Partners window if no data is found in the Destination Trading Partner Location Code.
i_protocol_type The transmission method entered using the Define Trading Partners window.
i_protocol_address The address/URL associated with the transmission method. It is entered using the Define Trading Partners window.
i_username The username entered using the Define Trading Partners window.
i_password The password associated with the username. Entered using the Define Trading Partners window.
i_attribute1 User-defined field to pass data.
i_attribute2 User-defined field to pass data.
i_attribute3 Data in this field will trigger the creation of another XML message that is sent to the Trading Partner identified in the Destination Trading Partner Location Code field entered using the Define Trading Partners window.
i_attribute4 User-defined field to pass data.
i_attribute5 User-defined field to pass data.
retcode Return code for the procedure
retmsg Return message for the procedure

getOAGLOGICALID

PL/SQL Syntax

procedure getOAGLOGICALID
return varchar2;

Description

Gets the sender's logical ID defined for the ECX_OAG_LOGICALID system profile.

The value defined in the ECX_OAG_LOGICALID system profile is retrieved by the ECX_OAG_CONTROLAREA_TP_V view. The value is used to map to the OAG CNTROLAREA, LOGICALID element.

This function is not required if you are using the ECX_OAG_CONTROLAREA_TP_V view.

Arguments (input)

None

Arguments (output)

None