XML Gateway has provided special purpose procedures and functions for use in the Message Designer to perform the following tasks:
Set event details to raise a business event for inbound transactions
Get event details using the event name maintained by the XML Gateway Execution Engine
Perform string manipulations
Get Trading Partner information using the sender's or receiver's Trading Partner ID maintained by the XML Gateway Execution Engine
Get message envelope data for inbound message
Get delivery data for outbound message
Get document logging information for a business document
Set message delivery status
Get System Administrator e-mail address from ECX: System Administrator Email Address system profile
Get sender logical ID from ECX_OAG_LOGICALID system profile
Set Error Exit
Use the Message Designer, Procedure Call or Function Call actions to initiate the APIs.
Attention: With the exception of ECX_ERRORLOG.external_system, the procedures and functions in this appendix are meant for use in the Message Designer only and should not be used in any other context.
Most procedures include input and output arguments. You can map a source or target variable to the input arguments. The output arguments can be used in conjunction with the Send Error Message action for warnings or the ECX_ACTIONS.set_error_exit_program API for serious errors to send a notification. The notification may be sent to the Trading Partner contact, the system administrator (identified in the ECX: System Administrator Email Address system profile), or both.
If the successful completion of an API is critical to the success of your transaction, you may wish to use the Exit Program action to terminate the transaction if the API fails to process completely.
The following APIs are described in this section:
Package: ECX_STANDARD
Package: ECX_DOCUMENT
Package: ECX_CONDITIONS
Package: ECX_TRADING_PARTNER_PVT
Package: ECX_ERRORLOG
Package: ECX_ACTIONS
Package: ECX_ATTACHMENT
Package: ECX_ENG_UTILS