The Get Predefined Variable Value action maintains predefined variables for the following:
Inbound message envelope
Code conversion status
Transaction status
The values of these predefined variables are maintained by the XML Gateway Execution Engine and are available for inquiry and mapping to the Application Open Interface table column or Application API parameter.
You can control the process flow based on the values found in the predefined variables.
See Map Action Editor - Overview for details on the common components of the window.
Select the source, target, or global variable to store the value of the predefined variable selected.
Select the predefined variable whose value you are interested in. The variables exposed by the XML Gateway Execution Engine are as follows:
Select the source column enabled for code conversion. The code conversion process will search the trading partner-specific code conversions and then the standard-specific list, followed by the universal list.
The status of the code conversion is assigned to the result variable. The return status codes are shown in the following table:
| Return Status Code | Description |
|---|---|
| 0 | Code conversion was successful. |
| 1 | Code conversion process failed to find a match for the source column, the source value is copied to the target column. This is a warning only. It will not stop the XML Gateway Execution Engine. However, you may wish to take some action to control the process flow based on this status. The possible causes of this failure are: invalid code category passed to the code conversion API or code conversion cross-reference not found. Verify that the code category identified for the source column is valid (Refer to Seeded Code Categories) and that a code conversion cross-reference is defined in the trading partner-specific list, the standard-specific list, or the universal list. Make the necessary corrections to prevent this error from occurring again. |
| 2 | Code conversion process encountered unexpected error, session is terminated. Check the process log file for the details, make the necessary correction, and reprocess the message. |
Internal Control Number
The Internal Control Number is a system-generated number that uniquely identifies the XML message being processed. This number is useful for sending acknowledgments, for document audits, for document archival, and for troubleshooting.
The value for the Internal Control Number is assigned to the result variable identified for the action.
The Internal Control Number can be used to get envelope information. Refer to ECX_TRADING_PARTNER_PVT.getEnvelopeInformation API for more information.
Return Code
The Return Code is the error code associated with the error message. The error message may be returned to the trading partner contact or the XML Gateway system administrator using the Send Error Message action.
Multiple return codes can be concatenated in a single predefined variable. The value for the Return Code is assigned to the result variable.
The possible return codes are shown in the following table:
| Return Code | Description |
|---|---|
| 0 | Success |
| 1 | Warning. The XML Gateway Execution Engine will not be stopped. |
| 2 | Failure. Check the process log file for the details, make the necessary corrections, and reprocess the message. |
Return Message
The Return Message is the text associated with the return code. The error message may be returned to the trading partner contact or the XML Gateway system administrator using the Send Error Message action.
Multiple return messages can be concatenated in a single predefined variable. The value for the Return Message is assigned to the result variable.
Receiver Trading Partner ID
The Receiver Trading Partner ID is a unique identifier for the receiver of the XML message. The ID can be used to derive the trading partner name and other pertinent data.
Use the ECX_TRADING_PARTNER_PVT.get_receivers_tp_info procedure to derive the Party ID, Party Site ID, Organization ID, and Administrator e-mail Address associated with the Receiver Trading Partner ID. Refer to XML Gateway APIs for more information.
The Receiver Trading Partner ID is maintained for outbound messages and pass-through messages.
The value for the Receiver Trading Partner ID is assigned to the result variable.
Sender Trading Partner ID
The Sender Trading Partner ID is a unique identifier for the sender of the XML message. The ID may be used to derive the trading partner name and other pertinent data.
Use the ECX_TRADING_PARTNER_PVT.get_senders_tp_info procedure to derive the Party ID, Party Site ID, Organization ID, and Administrator e-mail Address associated with the Sender Trading Partner ID. Refer to XML Gateway APIs for more information.
The Sender Trading Partner ID is maintained for inbound messages and pass-through messages.
The value for the Sender Trading Partner ID is assigned to the result variable.
Organization ID
The Execution Engine derives the organization ID associated with the Sender or Receiver Trading Partner ID. The combination of the organization ID and the Sender or Receiver Trading Partner ID uniquely identifies a trading partner in the Oracle E-Business Suite.