Oracle E-Business Suite Adapter Configuration Service

The Oracle E-Business Suite Adapter Configuration service sets configuration parameters for the adapter BPML. It populates process data with values specified in the service configuration.

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

Category Description
System name OracleEBusinessConfig
Graphical Process Modeler (GPM) categories All Services, Applications > ERP
Description The Oracle E-Business Suite Adapter Configuration service is a custom service developed for the Oracle E-Business Suite Adapter. It is used to set configuration parameters for the adapter BPML. It does this by populating process data with values specified in the service configuration.
Business usage The Oracle E-Business Suite adapter is BPML-based. The Oracle E-Business Suite Adapter Configuration service enables you to configure the adapter using Sterling B2B Integrator.
Usage example If you want to use the Oracle E-Business Suite adapter, you specify configuration parameters using this service. The BPML below provides a usage example: 
<operation name="Config">
  <participant name=
    "OracleEBusinessAdapterConfig"/> 
  <output message="Xout">
    <assign to="." from="*"/>
  </output>
  <input message="Xin">
    <assign to="." from="*"/>
  </input>
</operation>
Preconfigured? No. An instance named OracleEBusinessAdapterConfig is installed but must be configured. OracleEBusinessAdapterConfig is the default configuration used by the OracleEBusinessReceive business process.
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services Oracle E-Business Suite adapter (BPML-based adapter), Oracle E-Business Suite Message service
Application requirements None
Initiates business processes? No
Invocation This adapter disregards parameters sent from the BPML in the output message, so the configuration parameters cannot be overridden with the GPM. The service configuration parameter values are used to populate process data (via the input message to the BPML).
Business process context considerations See Invocation.
Returned status values Returned status values:
  • Success – The service successfully populated process data with the configuration parameters.
  • Error – A system error occurred.
Restrictions None. Any number of configurations can be created, but typically a single configuration can be used by any number of business processes.
Persistence level Default (Full)
Testing considerations To test it, create a configuration, then run it from a business process as shown in the example business process. Verify that process data contains all the parameters listed in the Parameters Passed from Service to Business Process section.

Implementing the Oracle E-Business Suite Adapter Configuration Service

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

Configuring the Oracle E-Business Suite Adapter Configuration Service

This service uses only the parameter values configured for the service configuration through the Sterling B2B Integrator Administration console. It disregards any parameters that are set using the GPM (in the output message) or in the BPML. Therefore, the service configuration parameters cannot be overridden using the GPM or BPML.

The Output Element column shows the element name populated in process data by the service at run time. They are output parameters only. Notice that all elements are contained within the parent element OracleEBusiness.

To configure the Oracle E-Business Suite Adapter Configuration service, you must specify settings for the following fields in Sterling B2B Integrator:

Field Name Description
Name Unique and meaningful name for the service configuration. Required.
Description Meaningful description for the service configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
The Trading Partner Contract for sending Contract used for sending messages to Oracle e-Business suite. Required. Valid value is any valid trading partner contract ID.
Insert Date and Time into OAG doc at run time Insert Date and Time into OAG doc CNTROLAREA at run time. Required. Valid values are true and false.
Time out (minutes) to wait for Confirm BOD Number of minutes to wait for a Confirm BOD response from Oracle. Required. Valid value is any non-negative integer.
Business Process to handle received messages The name of business process to handle incoming messages from Oracle. If not specified, a business process named OracleEBusinessRecv_<VERB>_<NOUN> will handle incoming messages, where <VERB> and <NOUN> are taken from the CNTROLAREA of the incoming message. Optional. Valid value is any valid business process name.
Business Process to handle unknown Confirm BODs Name of the business process that runs if a Confirm BOD is received and no matching request can be found. Optional. Valid value is any valid business process name.
Automatically send Confirm BOD for received messages? Determines if the adapter automatically sends a Confirm BOD when required. Required. Valid values are true and false. If false, you are responsible for sending a confirm BOD, if required.
Name of Confirm BOD template file Name of file containing the Confirm BOD template. Required if value in Automatically send Confirm BOD for received messages field is true. Valid value is any valid file name.
Directory of Confirm BOD template file The directory containing the Confirm BOD template file. Required if value in Automatically send Confirm BOD for received messages field is true. Valid value is any valid directory name.
Request Type The OTA protocol REQUEST_TYPE parameter. The default value SEND should be used for normal transactions. Required. Valid values are:
  • SEND (default)
  • AUTH
  • AUTH2
  • EME
For information about these values, see your Oracle documentation.
Protocol The OTA protocol PROTOCOL_TYPE parameter. Required. Valid values are HTTP and HTTPS.
Oracle EBusiness Suite user name Valid user name for the Oracle E-Business Suite. Required. Valid value is any valid username for Oracle E-Business Suite.
Oracle EBusiness Suite password Valid password for the selected user name. Required. Valid value is a valid password for the selected user name.

Parameters Passed from Business Process to Service

No parameters are passed from the business process to the service; the service will ignore any parameters that are passed to it from a business process.

Output from Service to Business Process

The following table contains the parameters passed from the Oracle E-Business Suite Adapter Configuration service to a business process:

Note: The output parameters are all contained within the parent element OracleEBusiness.
Field Name Description
The Trading Partner Contract for sending(OracleEBusiness/ SendingContractID) Contract used for sending messages to Oracle e-Business suite. Required. Valid value is any valid trading partner contract ID.
Insert Date and Time into OAG doc at run time(OracleEBusiness/ InsertDateTime) Insert Date and Time into OAG doc CNTROLAREA at run time. Required. Valid values are true and false.
Time out (minutes) to wait for Confirm BOD(OracleEBusiness/ ConfirmBodTimeoutMinutes) Number of minutes to wait for a Confirm BOD response from Oracle. Required. Valid value is any non-negative integer.
Business Process to handle received messages(OracleEBusiness/ ReceiveMessageBPName) The name of business process to handle incoming messages from Oracle. If not specified, a business process named OracleEBusinessRecv_<VERB>_<NOUN> will handle incoming messages, where <VERB> and <NOUN> are taken from the CNTROLAREA of the incoming message. Optional. Valid value is any valid business process name.
Business Process to handle unknown Confirm BODs(OracleEBusiness/ UnknownConfirmBodBPName) Name of the business process that runs if a Confirm BOD is received and no matching request can be found. Optional. Valid value is any valid business process name.
Automatically send Confirm BOD for received messages?(OracleEBusiness/ AutoSendConfirmBod) Determines if the adapter automatically sends a Confirm BOD when required. Valid values are true and false. If false, you are responsible for sending a confirm BOD, if required. Required. Valid values are true and false.
Name of Confirm BOD template file(OracleEBusiness/ ConfirmBodTemplateFileName) Name of file containing the Confirm BOD template. Required if value in Automatically send Confirm BOD for received messages field is true. Valid value is any valid file name.
Directory of Confirm BOD template file(OracleEBusiness/ ConfirmBodTemplateDirectory) The directory containing the Confirm BOD template file. Required if value in Automatically send Confirm BOD for received messages field is true. Valid value is any valid directory name.
Request Type(OracleEBusiness/ REQUEST_TYPE) The OTA protocol REQUEST_TYPE parameter. The default value SEND should be used for normal transactions. Default is SEND. Required. Valid values are:
  • SEND
  • AUTH
  • AUTH2
  • EME
For more information about these values, see your Oracle documentation.
Protocol(OracleEBusiness/ PROTOCOL_TYPE) The OTA protocol PROTOCOL_TYPE parameter. Required. Valid values are HTTP and HTTPS.
Oracle EBusiness Suite user name(OracleEBusiness/ USERNAME) Valid user name for the Oracle E-Business Suite. Required. Valid value is any valid username for Oracle E-Business Suite.
Oracle EBusiness Suite password(OracleEBusiness/ PASSWORD) Valid password for the selected user name. The password will be in an obscured format rather than clear text. The obscured password is required as input to the Oracle E-Business Suite Message Service. Required. Valid value is a valid password for the selected user name.