Oracle E-Business Suite Message Service

The Oracle E-Business Suite Message service encodes messages in the HTTP POST format that is expected by Oracle and decodes HTTP POST messages received from Oracle.

The following table provides an overview of the Oracle® E-Business Suite Message service:

Category Description
System name OracleEBusinessMessageService
Graphical Process Modeler (GPM) categories All Services, Applications > ERP
Description The Oracle E-Business Suite Message service is a custom service developed for the Oracle E-Business adapter. It is used to encode messages in the HTTP POST format expected by Oracle, and to decode HTTP POST messages received from Oracle.
Business usage Oracle XML Gateway requires parameters in addition to the XML document being transmitted. This service gathers all of the parameters and constructs a message in the format Oracle expects (HTTP POST). For receiving messages, it parses the incoming HTTP POST message from Oracle to extract the XML payload and all the other parameters.
Usage example A user wants to use the Oracle E-Business adapter to send a purchase order (PO) to Oracle. The user defines all the Oracle parameters using the Oracle E-Business Suite Adapter Configuration service, and places the PO into the primary document. This service constructs a message in the format required by Oracle. Oracle sends an invoice to Sterling B2B Integrator. The Oracle E-Business Suite Message service is used to parse the message, putting the invoice XML into the primary document and storing all other message parameters in process data.
Preconfigured? No
Requires third-party files? OAG DTDs must be checked in to Sterling B2B Integrator for each document type exchanged with Oracle.
Platform availability All supported Sterling B2B Integrator platforms
Related services Oracle E-Business Suite adapter (BPML-based adapter), Oracle E-Business Suite Adapter Configuration service
Application requirements The user must have a valid username and password for the Oracle E-Business Suite
Initiates business processes? None
Invocation Runs by Oracle E-Business Suite business processes.
Business process context considerations None
Returned status values Possible values are:
  • Success: The service successfully encoded or decoded the message
  • Error: The service was unable to encode or decode the message.
Restrictions None. Any number of configurations can be created, but typically a single configuration of the service is used by a number of business processes.
Persistence level System default (Full)
Testing considerations To test it, create a configuration, then run it from a business process as shown in the business process examples.

Implementing the Oracle E-Business Suite Message Service

To implement the Oracle E-Business Suite Message service, complete the following tasks:
  1. Create an Oracle E-Business Suite Message service configuration. For information, see Managing Services and Adapters.
  2. Configure the Oracle E-Business Suite Message service. For information, see Configuring the Oracle E-Business Suite Message Service.
  3. Use the Oracle E-Business Suite Message service in a business process.

Configuring the Oracle E-Business Suite Message Service

To configure the Oracle E-Business Suite Message service, you must specify settings for the following fields in the GPM:

Field Description
Config Name of the adapter configuration.
ATTRIBUTE1 OTA parameter. Optional.
ATTRIBUTE2 OTA parameter. Optional.
ATTRIBUTE3 OTA parameter. Optional.
ATTRIBUTE4 OTA parameter. Optional.
ATTRIBUTE5 OTA parameter. Optional.
DOCUMENT_NUMBER OTA parameter. Required if MODE is ENCODE.
MESSAGE_STANDARD OTA parameter. Required if MODE is ENCODE. Valid value and default are OAG.
MESSAGE_TYPE OTA parameter. Value must be XML with version 11.5.8 of XML gateway. Required if MODE is ENCODE.
MODE Valid values are ENCODE (for sending a message to Oracle) and DECODE (for receiving a message from Oracle). Required.
PARTY_SITE_ID OTA parameter PARTY_SITE_ID. Should match the Source Location Code in E-Business Suite trading partner definition. Required if MODE is ENCODE.
PARTYID OTA parameter. Optional.
PASSWORD OTA parameter. Valid password for the selected user name in obscured format (not clear text). The Oracle E-Business Suite Adapter Configuration service stores the password in the obscured format in the element OracleEBusiness/PASSWORD. Required if MODE is ENCODE. Valid value is a valid password for the selected user name (in obscured format).
PROTOCOL_ADDRESS OTA parameter. Optional.
PROTOCOL_TYPE OTA parameter. Required if MODE is ENCODE. Valid values are HTTP and HTTPS.
REQUEST_TYPE OTA parameter REQUEST_TYPE. Valid values are SEND, AUTH, AUTH2, and EME. Default value is SEND. Required if mode is ENCODE.
TRANSACTION_SUBTYPE OTA parameter TRANSACTION_SUBTYPE. Should match External Transaction SubType in E-Business Suite Transaction setup. Required if MODE is ENCODE.
TRANSACTION_TYPE OTA protocol TRANSACTION_TYPE. Should match External Transaction Type in E-Business Suite Transaction setup. Required if MODE is ENCODE.
TRANSPORT_PROTOCOL OTA parameter. Value must be OXTA with version 11.5.8 of XML gateway. Required if MODE is ENCODE.
TRANSPORT_PROTOCOL_VERSION OTA parameter. Value must be 1.0 with version 11.5.8 of XML gateway. Required if MODE is ENCODE.
USERNAME OTA parameter. Required if MODE is ENCODE. Valid value is any valid user name for Oracle E-Business Suite.

Parameters Passed from Service to Business Process

In ENCODE mode, the service will output a single parameter: PrimaryDocument. In DECODE mode, the service will output PrimaryDocument, and any other OTA parameters in the message (except PASSWORD) will be output within the parent element OracleEBusiness/Recv_OTA_Params. The OTA parameters will be output only if they are present in the message.

The following table describes the parameters passed from the service to a business process:

PrimaryDocument:
  • ENCODE mode: an HTTP POST message to send to Oracle.
  • DECODE mode: The XML payload from the incoming Oracle message.
OTA Parameters:
OracleEBusiness/Recv_OTA_Params/ REQUEST_TYPE
OracleEBusiness/Recv_OTA_Params/ TRANSACTION_TYPE
OracleEBusiness/Recv_OTA_Params/ TRANSACTION_SUBTYPE
OracleEBusiness/Recv_OTA_Params/ DOCUMENT_NUMBER
OracleEBusiness/Recv_OTA_Params/ PARTYID
OracleEBusiness/Recv_OTA_Params/ PARTY_SITE_ID
OracleEBusiness/Recv_OTA_Params/ PROTOCOL_TYPE
OracleEBusiness/Recv_OTA_Params/ USERNAME
OracleEBusiness/Recv_OTA_Params/ TRANSPORT_PROTOCOL
OracleEBusiness/Recv_OTA_Params/ TRANSPORT_PROTOCOL_VERSION
OracleEBusiness/Recv_OTA_Params/ MESSAGE_TYPE
OracleEBusiness/Recv_OTA_Params/ MESSAGE_STANDARD
OracleEBusiness/Recv_OTA_Params/ PROTOCOL_ADDRESS
OracleEBusiness/Recv_OTA_Params/ ATTRIBUTE1
OracleEBusiness/Recv_OTA_Params/ ATTRIBUTE2
OracleEBusiness/Recv_OTA_Params/ ATTRIBUTE3
OracleEBusiness/Recv_OTA_Params/ ATTRIBUTE4
OracleEBusiness/Recv_OTA_Params/ ATTRIBUTE5

Business Process Examples

The following examples illustrate using the Oracle E-Business Suite Message service in ENCODE and DECODE modes:

ENCODE Mode

<operation name="encode message"> 
  <participant name="OracleEBusinessMessageService"/> 
  <output message="outmsg"> 
    <assign to="OTAMessageServiceMode">ENCODE</assign> 
    <assign to="REQUEST_TYPE" from="OracleEBusiness/REQUEST_TYPE/text()"/> 
    <assign to="TRANSACTION_TYPE" from="OracleEBusiness/Noun/text()"/> 
    <assign to="TRANSACTION_SUBTYPE" from="OracleEBusiness/Verb/text()"/> 
    <assign to="DOCUMENT_NUMBER" from="OracleEBusiness/REFERENCEID/text()"/> 
    <assign to="PARTY_SITE_ID" from="DocToDOM(PrimaryDocument)//CNTROLAREA/
                SENDER/LOGICALID/text()"/> 
    <assign to="PROTOCOL_TYPE" from="OracleEBusiness/PROTOCOL_TYPE/text()"/> 
    <assign to="USERNAME" from="OracleEBusiness/USERNAME/text()"/> 
    <assign to="PASSWORD" from="OracleEBusiness/PASSWORD/text()"/> 
    <assign to="ObscurePassword" from="OracleEBusiness/ObscurePassword/text()"/>
    <assign to="TRANSPORT_PROTOCOL">OXTA</assign> 
    <assign to="TRANSPORT_PROTOCOL_VERSION">1.0</assign> 
    <assign to="MESSAGE_TYPE">XML</assign> 
    <assign to="MESSAGE_STANDARD">OAG</assign> 
    <assign to="." from="*"/> 
  </output> 
  <input message="inmsg"> 
    <assign to="." from="*"/> 
  </input> 
</operation>

DECODE Mode

<operation name="decode message"> 
  <participant name="OracleEBusinessMessageService"/> 
  <output message="outmsg"> 
    <assign to="OTAMessageServiceMode">DECODE</assign> 
    <assign to="." from="*"/> 
  </output> 
  <input message="inmsg"> 
    <assign to="." from="*"/> 
  </input> 
</operation>