1. E-Business Suite Integration Guide
  2. Oracle Global Trade Management to XML Gateway (Oracle E-Business Suite)

Oracle Global Trade Management to XML Gateway (Oracle E-Business Suite)

Response communication to the XML Gateway (which is part of the Oracle E-Business Suite) can be performed through the Send Integration UI action, agent action, or a process management job from the Oracle Global Trade Management transaction line.

Key configuration elements are embedded inside an external system. You can define an external system per the Oracle E-Business Suite instance to which compliance status needs to be communicated.

Once an external system is configured for an Oracle E-Business Suite instance, the Oracle Global Trade Management Send Integration action can be triggered against the transaction line to send the compliance status.

Besides this, an initial setup is required for the integration to work. As part of this setup a user should be created and proper roles should be assigned to that user, as explained below:

In order to send data to Logistics Cloud, it is necessary that the remote system authenticate the user with valid credentials. In addition, this user must have the correct Access Control List entry points. To facilitate this, Logistics Cloud provides the following options, by default, for inbound integration users:

  • 'INTEGRATION' user role for your inbound integration users. Assign this user role to your user.
  • 'INTEGRATION' ACL for your inbound integration users. Assign this parent ACL to your own user role or your user.
  • 'External Integration' ACL for your inbound integration users. Assign this child ACL to your own user role or your user.

For further details, you can refer to the Oracle Logistics Cloud Getting Started Guide.

Oracle E-Business Suite XML Gateway

Oracle E-Business Suite XML Gateway needs to be configured in order to receive XML files from Oracle Global Trade Management. Details of the trading partner setup in the XML Gateway can be found in the Oracle® XML Gateway User's Guide.

The XML Gateway requires several properties to be included in the incoming http request apart from the payload (response) XML. Details on these properties can be found in the document listed above. In Oracle Global Trade Management these name/value pairs are modeled as a generic HTTP Profile object attached to the external system. Details can be found in HTTP Profile section of this document.

User (for Cloud Systems)

Cloud users have to perform the following steps for the initial user set-up for integration:

  1. Navigate to Configuration and Administration > User Management > User Manager.
  2. Create a user in GTM whose User Name and Password matches with that mentioned during ITM adapter’s setup in EBS.
  3. Give the user role as ‘INTEGRATION’.
  4. Add the access control list ‘INTEGRATION’ to its Access Control List, and select the Granted checkbox.

External System

To communicate with Oracle E-Business Suite, when using the Send Integration action you will need to provide an external system.

Oracle Global Trade Management does not ship with PUBLIC external systems defined. You need to create an external system to use. The important fields on the External System page are explained below.

Username and Password

Username and password information should be provided in the external system for authentication with the XML Gateway.

Log Response

Select the Log Response check box to turn on logging for the response. This is needed if you want to enable integration logging. Enabling the log response helps in checking through logs and transmission reports for the response communication that was sent from Oracle Global Trade Management and received by Oracle E-Business Suite.

URL

HTTPPost is the transport mechanism used to communicate with the Oracle E-Business Suite XML Gateway. The URL should be the URL of the XML Gateway on the Oracle E-Business Suite instance. A sample URL for Oracle E-Business Suite 12.1.3 is as follows:

http://<server:port>/webservices/TransportAgentServer

Trans Acknowledgement Expected

The Trans Acknowledgement Expected check box should be marked if the external system that Oracle Global Trade Management is communicating with will send a response. In the case of the Oracle E-Business Suite XML Gateway, Oracle Global Trade Management will receive an acknowledgement for every compliance response. So, this check box should always be marked for external systems used to communicate with the Oracle E-Business Suite XML Gateway.

Use Acknowledgement Status

The Use Acknowledgement Status check box should be marked if Oracle Global Trade Management needs to set the status on the transmission based on acknowledgement received from the external system.

For the XML Gateway, marking this check box is optional. If it is marked, Oracle E-Business Suite needs to provide a stylesheet profile for transforming the acknowledgement from the external system. If the check box is not marked, the status on the outbound transmission is set using the STATUS_CODE header on the acknowledgement.

Acknowledgement Stylesheet Profile ID

The external system can either directly send a “TransmissionAck” element as an acknowledgement or can send an HTML/XML which could be transformed to “TransmissionAck” by an XSL. You should register an XSL with the external system using the field Acknowledgement Stylesheet Profile ID for transforming the acknowledgement to a “TransmissionAck” element. In the case of the XML Gateway, this stylesheet profile is mandatory if the Use Acknowledgement Status check box is marked.

Oracle Global Trade Management forms an acknowledgement XML as follows:

<ResponseInput>
<OutboundTransmissionId>transmissionId</OutboundTransmissionId>
<OutboundTransmission>xml</OutboundTransmission>
<OriginalResponse>response</OriginalResponse> 
</ResponseInput>

In the acknowledgement XML:

  • transmissionId: ID of the original outbound transmission that was sent out to the XML Gateway
  • xml: Complete XML of the outbound transmission that was sent out
  • response: acknowledgement received from the XML gateway. For Oracle E-Business Suite 12.1.3, it may look something like this:
       HTTP Header
   HTTP/1.1 200 OK
   Server: Apache/1.2.0
   Date: Fri, 15 Jun 2002 16:20:46 GMT
   Content-Length: 567
   STATUS_CODE: 1000
   STATUS_DESCRIPTION: OK
   MESSAGE_RECEIPT_ID: A9876543210987654321
   Content-type: text/html
   HTTP Body
   <HTML><BODY> <TABLE> <TR><TD>Status Code</TD><TD>1000</TD></TR>
   <TR><TD>Status Description</TD><TD>Message Successfully
   received</TD></TR> <TR><TD>Message Receipt
   ID</TD><TD>A9876543210987654321</TD> </TR> </TABLE> </BODY></HTML>

Oracle Global Trade Management ships with a PUBLIC Stylesheet Profile (EBS_ACK_FOR_GTM_RESPONSE) which can be used as the Acknowledgement Stylesheet Profile. This stylesheet provides an out-of-the-box transformation to the “TransmissionAck” element using the above acknowledgement XML.

Response Generation via Translation

The external system also contains configuration information regarding generating the response XML for communicating the compliance status of trade transactions.

Within the External System Translations section, the Stylesheet Profile ID (which specifies the XSL file) is used for translating the data from Oracle Global Trade Management to a format acceptable by Oracle E-Business Suite.

Oracle Global Trade Management ships with a default response XSL for generating the Oracle E-Business Suite response. The name of the stylesheet profile is GTM_RESPONSE_TO_EBS. It can be updated and used as required.

HTTP Profile

HTTP Profile must be provided on the external system as it is mandatory when communicating with the XML Gateway. The HTTP Profile holds all of the communication parameters that are needed to communicate with the XML gateway.

The HTTP Profile holds all the name/value pairs required for communicating with the XML Gateway of the Oracle E-Business Suite instance. These name/value pairs are actually posted to the XML Gateway along with the compliance status XML. These are mandated by XML Gateway as defined in the XML Gateway documentation. In addition, a missing property or parameter could result in a communication failure. Some important parameters include USERNAME, PASSWORD, URL, PARTY_SITE_ID, and DOCUMENT_TYPE which are all case-sensitive.

Oracle Global Trade Management ships with a PUBLIC HTTP Profile (EBS_HTTP_PROFILE) that’s tested with Oracle E-Business Suite 12.1.3.

There are a couple of fields on the HTTP Profile which address acknowledgement processing:

HTTP Header for Response

The HTTP Header for Response field should be set to the name of the http header that is read to find the response status from the external system. For example, in the case of the Oracle E-Business Suite ITM – Oracle Global Trade Management integration case, xmlgateway is the defined external system.

The XML Gateway sends an acknowledgement on receipt of a compliance status request from a trading partner (Oracle Global Trade Management). An example of the acknowledgement HTML is shown above. Along with HTML, an http header is sent, which provides the success status of inbound compliance status processing. The name of the header is ‘STATUS_CODE’.

Therefore, any HTTP profiles attached to an external system and configured for communication with the XML Gateway should have ‘STATUS_CODE’ as the value for the HTTP Header for Response field. The PUBLIC HTTP Profile (EBS PROFILE) that’s tested with Oracle E-Business Suite and shipped with Oracle Global Trade Management has ‘STATUS_CODE’ as its value for this field.

HTTP Response Success Values

This field is related to the HTTP Header for Response field discussed above. The HTTP Header for Response field tells Oracle Global Trade Management about the HTTP header that should be read for the status. The HTTP Response Success Values field defines the status codes that should be treated as success. Text entered in this field specifies the string which indicates a success value.

In the case of the Oracle Global Trade Management-ITM integration, in the acknowledgements received from the XML Gateway, the value 1000 is treated as the success value. 1000 means the XML Gateway successfully processed the compliance status XML from Oracle Global Trade Management. Subsequently, the related transmission status is set to PROCESSED based on the success value of 1000. Any other values in the http header would indicate a failure and set the transmission status to ERROR.

The XML Gateway does provide many other codes which denote different issues while processing the compliance request. Therefore, the HTTP Header for Response and HTTP Response Success Values fields set the status of transmissions to ERROR for any other error codes from Gateway.

Acknowledgment Processing

The acknowledgement received from the XML Gateway can be used to set the status on the outbound transmission which has sent the response to the XML Gateway.

This status setting is optional and, if enabled by providing the correct values for specific fields in the HTTP profile and external system, the status on the outbound transmission is set accordingly. The details on how Oracle Global Trade Management determines the status to set is shown in the following flow.The details on how Oracle Global Trade Management determines the status to set is shown in this flow.