Installing Oracle E Integrated SOA Gateway

Installing Oracle E-Business Suite Integrated SOA Gateway, Release 12.
2 To
(Doc ID 1311068.1) Bottom
Oracle E-Business Suite Integrated SOA Gateway (ISG) enables supported interface types
published in Oracle Integration Repository. These interfaces can be transformed into SOAP
and REST web services as explained below. This document enlists the setup tasks that must
be performed to configure ISG on a fresh installation of Oracle E-Business Suite, as well as
on an instance upgraded from an earlier release.
Note: To provide high availability of Oracle E-Business Suite services, Oracle

recommends configuring your Oracle E-Business Suite environment with multiple nodes.
The configuration and setup tasks described in this document are also applicable to an
Oracle E-Business Suite environment configured with multiple nodes in the application
tier.
Note: The setup tasks described in this document guide you through ISG configuration
for Oracle E-Business Suite On-Premises. For information on configuring ISG for Oracle
E-Business Suite Release 12.2 on Oracle Cloud, see:
 Document 2675815.1, Configuring Oracle E-Business Suite Integrated SOA

Gateway for Oracle E-Business Suite Release 12.2 on Oracle Cloud Infrastructure
 Document 2386478.1, Configuring Oracle E-Business Suite Integrated SOA
Gateway for Oracle E-Business Suite Release 12.2 on Oracle Cloud Infrastructure
Classic
This document will be updated with latest information as and when available. You are
advised to periodically check this Document 1311068.1 on My Oracle Support for updates.
The most current version of this document can be obtained in My Oracle Support
Knowledge Document 1311068.1.
There is a change record at the end of this document.
Configuration Tasks In This Document
The following table lists the configuration tasks required for setting up Oracle E-Business
Suite web services available through Oracle E-Business Suite Integrated SOA Gateway and
the tasks required when your Oracle E-Business Suite instance or database is upgraded from
an earlier release or Oracle E-Business Suite is cloned from an existing instance:
Note: If you are using both REST and SOAP services, configure your system by
following the instructions described in both Part A and Part B.

Configuration Scenarios Implementation Tasks
 Section 1: Configuring Oracle E-Business Suite
Integrated SOA Gateway for REST Services
Part A: Configuring Oracle E-  Section 2: Validating Oracle E-Business Suite
Business Suite REST Services Integrated SOA Gateway Setup for REST
Services
 Section 3: Performing Prerequisites Tasks for

SOAP Services:
o Section 3.1: Installing Oracle WebLogic
Server and Oracle SOA Suite for SOAP
Services
o Section 3.2: Enabling TLS on Oracle
SOA Suite
Integrated SOA Gateway for SOAP Services on a
New Installation of Release 12.2.3 or Later
Part B: Configuring Oracle E-
o Section 4.1: Setup Tasks on Oracle E-
Business Suite SOAP Services
Business Suite Release 12.2.3 or Later
o Section 4.2: Configuration Steps on
Oracle SOA Suite to Integrate with Oracle
E-Business Suite
 Section 5: Validating Oracle E-Business Suite
Integrated SOA Gateway Setup for SOAP
Services
 Section 6: Deploying Generic XML Gateway
Services for SOAP Services (Optional)
Part C: Configuring Oracle E-  Section 7: Configuring Oracle E-Business Suite

Business Suite Integrated SOA Integrated SOA Gateway on Release 12.2.x
Gateway for Upgrading and Cloned From an Existing 12.2.x Environment
Cloning Scenarios  Section 8: Configuring Oracle E-Business Suite
Integrated SOA Gateway for REST Services on
Release 12.2.x Upgraded From Oracle E-
Business Suite Release 12.1.x
Integrated SOA Gateway for SOAP Services on
Release 12.2.x Upgraded From Oracle E-
Business Suite Release 12.1.x
 Section 10: Upgrading Oracle SOA Suite 11g to
Oracle SOA Suite 12c in an Existing
Configuration
 Section 11: Performing Post-Oracle E-Business
Suite Database Upgrade Tasks for ISG-
Configured Instances
o Section 11.1: Setup Tasks on Oracle E-
Business Suite
o Section 11.2: Setup Tasks on Oracle SOA
Suite
o Section 11.3: Validating the Setup for
Post-Database Upgrade
Note: For more information about Oracle E-Business Suite Integrated SOA Gateway
Release 12.2, see the following Knowledge Documents on My Oracle Support:
 Document 2693640.1: Oracle E-Business Suite Integrated SOA Gateway Release

Notes for Release 12.2.10
Notes for Release 12.2.7 and 12.2.8
 Document 1317697.1: Oracle E-Business Suite Integrated SOA Gateway
Troubleshooting Guide, Release 12.2
 Document 1332262.1: Setting Up SAML Token Security for Oracle E-Business
Suite Integrated SOA Gateway Release 12.2
For information about Oracle E-Business Suite Integrated SOA Gateway Release 12.1,
see My Oracle Support Knowledge Document 556540.1, Installing Oracle E-Business
Suite Integrated SOA Gateway, Release 12.
Note: For consistency with the naming convention being adopted by other Oracle products, Oracle E-Busin
with a release version in the following format:
year_quarter_fortnight within a quarter
For example, ISG Consolidated Patch for Release 12.2 (20_3_5) indicates the patch is released in the fifth f
Part A: Configuring Oracle E-Business Suite REST Services
REST-based web services are deployed on an Oracle E-Business Suite application server.
They do not depend on Oracle SOA Suite and Oracle E-Business Suite Adapter. Hence, the
configuration steps for REST services are required to be performed only on Oracle E-
Business Suite.
Note: Interface types enabled for REST services are PL/SQL, Java Bean Services,
Application Module Services, Concurrent Program, Business Service Object, and Open
Interface Tables and Views.
The section includes the following topics:
 Section 1: Configuring Oracle E-Business Suite Integrated SOA Gateway for REST
Services
 Section 2: Validating Oracle E-Business Suite Integrated SOA Gateway Setup for
REST Services
Section 1: Configuring Oracle E-Business Suite Integrated SOA Gateway

for REST Services
Preparation for Oracle E-Business Suite Integrated SOA Gateway REST Services in a
Multi-node Environment
To provide high availability of Oracle E-Business Suite REST services, Oracle E-Business
Suite Integrated SOA Gateway recommends multiple nodes of an Oracle E-Business Suite
environment.
The following diagram represents the high level architecture for Oracle E-Business Suite
REST services in a multi-node environment. This diagram contains a hardware load balancer
configuration with a single entry point in Oracle E-Business Suite to load balance the web
application running on Oracle E-Business Suite application servers 1 and 2. All users access
Oracle E-Business Suite application through a single URL.
For information on configuring Oracle E-Business Suite Release 12.2 with multiple nodes,
see Using Load-Balancers with Oracle E-Business Suite Release 12.2, My Oracle Support
Note: Ensure that your Oracle E-Business Suite instance is on the latest AD TXK Delta
level and has the recommended technology patches in place. See:
 My Oracle Support Knowledge Document 1617461.1, Applying the Latest AD and

TXK Release Update Packs to Oracle E-Business Suite Release 12.2
 My Oracle Support Knowledge Document 1594274.1, Oracle E-Business Suite
Release 12.2: Consolidated List of Patches and Technology Bug Fixes, for
recommended list of technology patches
Apply the consolidated Patch 31764501:R12.OWF.C, ISG Consolidated Patch for Release

12.2 (20_3_5), to your instance if it has not already been applied. This patch is required
for your instance regardless of a single node or a multi-node environment. Please note that
this patch has two prerequisite patches listed in the patch readme which require adop
phase=fs_clone to be run after the patch application, if your Oracle E-Business Suite
instance is earlier than Release 12.2.9.
Perform the following tasks to configure Oracle E-Business Suite Integrated SOA Gateway
for REST services.
1. Source the run file system and run the following script:
Note: If your Oracle E-Business Suite instance is configured with multiple nodes,
perform this step on the Oracle E-Business Suite primary node.
a. Source the applications run file system environment file:
source <EBS_INSTALL_BASE>/EBSapps.env
Enter 'R' for the run file system.
b. Run the following script:

perl $FND_TOP/patch/115/bin/ISGRestSetup.pl
The script prompts you to enter the following information:
 Enter the password for APPS user:
'APPS' is the default Oracle E-Business Suite database user name.

Provide the associated password for the user.
 Enter Oracle E-Business Suite's WebLogic Server Admin User Name:

[weblogic]
'weblogic' is the default Oracle WebLogic Server Admin user name.
 Enter the password for weblogic user:
Provide the associated password for above Oracle WebLogic Server

Admin user 'weblogic'.
When the script starts to configure the environment for REST services, the
following message appears:
Configuring Oracle E-Business Suite Integrated SOA Gateway for REST Services.
Please wait, as this may take a few minutes.
Log file for each step is located at
/u01/R122_EBS/fs1/EBSapps/appl/fnd/12.0.0/patch/115/binn
2. Note that the setup may take a few minutes to complete. The completion status
would be displayed on terminal. Log files are written in the current directory.
3. Once the configuration script completes successfully, you can check the log
file for more information. If the script ends with errors, then errors and
warnings are listed in the log file and other log files in the same directory.
Note: The above script creates and deploys the data source

"ISGDatasource" on the Oracle E-Business Suite WebLogic Admin server
and "oafm_cluster1" server. You can size up the data source connection
pool as per the REST service request volume.
4.
5. (Conditional) Only if your Oracle E-Business Suite release is earlier than 12.2.9, then
run adop phase=fs_clone on Oracle E-Business Suite 12.2 enabled for Online
Patching to copy the REST configurations done above to the other file system. Refer
to step 5 in Section 4.1: Setup Tasks on Oracle E-Business Suite Release 12.2.3 or
Later for details.
This step is not required for Oracle E-Business Suite 12.2.9 and onwards.
Important: If SOAP services are also used, complete the entire setup tasks for
both SOAP and REST services before running the adop
phase=fs_clone command. For information on configuring Oracle E-Business
Suite SOAP services, refer to Part B: Configuring Oracle E-Business Suite SOAP
Services.
After configuring Oracle E-Business Suite REST services, validate the setup by following
steps described in Section 2: Validating Oracle E-Business Suite Integrated SOA Gateway
Setup for REST Services.
Section 2: Validating Oracle E-Business Suite Integrated SOA Gateway

Setup for REST Services
After completing the setup tasks for REST services described in Section 1, you can perform
the validation through the following ways:
 Perform the design-time activities from the Integration Repository user interface
For more information on deploying and undeploying REST services through the
Integration Repository user interface, refer to Administering REST Web Services
Through Integration Repository, Oracle E-Business Suite Integrated SOA Gateway
Implementation Guide.
 Perform the design-time activities through the backend script
This section describes how to validate the setup using the script.
Perform the following steps to validate the Oracle E-Business Suite Integrated SOA Gateway
setup using an Ant script $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml:
1. Source the applications run file system environment file:

2. Run the following command and verify the reports generated

at $JAVA_TOP/oracle/apps/fnd/isg/ant, for any errors:
ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml
-Dfile=$JAVA_TOP/oracle/apps/fnd/isg/ant/isg_service.xml -Dverbose=OFF
3. Copy and paste the following URL in a web browser and you should be able to access
Oracle E-Business Suite applications from this URL:
http(s)://<EBS host name>:<port>/webservices/rest/provider/isActive/
When prompted, provide Oracle E-Business Suite System Administration user

credentials. You should see a response, similar to the following in the browser:
<?xml version = '1.0' encoding = 'UTF-8'?>
<isActive_Output>
<OutputParameters>
<Output>ACTIVE</Output>
...
</OutputParameters>
</isActive_Output>
For more information on how to use the Ant script, refer to Managing REST Service
Lifecycle Activities Using an Ant Script, Oracle E-Business Suite Integrated SOA Gateway
Part B: Configuring Oracle E-Business Suite SOAP Services
In Oracle E-Business Suite Integrated SOA Gateway (ISG) Release 12.2, SOAP-based web
services are deployed on Oracle SOA Suite running on Oracle WebLogic Server. The steps to
configure SOAP services span across Oracle E-Business Suite as well as Oracle SOA Suite.
ISG Release 12.2 Certification Matrix
To enable Oracle E-Business Suite SOAP services, Oracle E-Business Suite Integrated SOA
Gateway Release 12.2 has the following product dependencies:
ISG Release 12.2 Product Dependencies and Certificati

Oracle E-Business Suite Adapter
Oracle SOA Suite
(Oracle Applications Adapter)
12.2.1.4.0 12.2.1.4.0
12.2.1.3.0 12.2.1.3.0
Release 12c (12.2.1.x.x) 12.2.1.2.0 12.2.1.2.0
12.2.1.1.0 12.2.1.1.0
12.2.1.0.0 12.2.1.0.0
Release 12c (12.1.3) 12.1.3 12.1.3
Release 11g 11.1.1.9.0 11.1.1.9.0
Note: Interface types enabled for SOAP services are PL/SQL, Concurrent Program, XML Gateway (Inbound
Business Service Object.
Preparing Oracle E-Business Suite Integrated SOA Gateway in a Multi-node Environment
To provide high availability of Oracle E-Business Suite services, Oracle E-Business Suite
Integrated SOA Gateway recommends multiple nodes of an Oracle E-Business Suite
environment and each node is configured with multiple nodes of Oracle SOA Suite.
The following diagram represents the high level architecture for Oracle E-Business Suite
Integrated SOA Gateway Release 12.2 in a multi-node environment. In this diagram, a
hardware load balancer configuration with a single entry point in Oracle E-Business Suite to
load balance the web application running on Oracle E-Business Suite application servers 1
and 2. In this configuration, all users access Oracle E-Business Suite application through a
single URL. Similarly, a separate load balancer is configured for Oracle SOA Suite to load
balance the web application running on Oracle SOA Suite application servers.
Preparing Oracle E-Business Suite in a Multi-node Environment
Oracle E-Business Suite environments can be scaled up to handle large numbers of

concurrent users by load-balancing across multiple application middle tier servers. For
information on configuring Oracle E-Business Suite Release 12.2 with multiple nodes,
see Using Load-Balancers with Oracle E-Business Suite Release 12.2, My Oracle Support
This section includes the following topics:
 Section 3: Performing Prerequisites Tasks for SOAP Services:

o Section 3.1: Installing Oracle WebLogic Server and Oracle SOA Suite for
SOAP Services
o Section 3.2: Enabling TLS on Oracle SOA Suite
 Section 4: Configuring Oracle E-Business Suite Integrated SOA Gateway for SOAP
Services on a New Installation of Release 12.2.3 or Later
o Section 4.1: Setup Tasks on Oracle E-Business Suite Release 12.2.3 or Later
o Section 4.2: Configuration Steps on Oracle SOA Suite to Integrate with Oracle
E-Business Suite
 Section 5: Validating Oracle E-Business Suite Integrated SOA Gateway Setup for
SOAP Services
 Section 6: Deploying Generic XML Gateway Services for SOAP Services (Optional)
Section 3: Performing Prerequisites Tasks for SOAP Services
As mentioned earlier SOAP services are deployed on Oracle SOA Suite running on Oracle
WebLogic Server, before you begin the configuration for Oracle E-Business Suite SOAP
services, you must have the following tasks in place:
 Install and configure Oracle SOA Suite 11g or Oracle SOA Suite 12c on a separate
Oracle WebLogic Server (Section 3.1)
 Enable TLS on Oracle SOA Suite (Section 3.2)
Section 3.1: Installing Oracle SOA Suite and Oracle WebLogic Server for SOAP Services
To configure Oracle E-Business Suite Integrated SOA Gateway for SOAP services, ensure
you have Oracle SOA Suite, Oracle WebLogic Server, and Oracle Database in place. For the
supported release versions of Oracle SOA Suite and Oracle WebLogic Server, refer to ISG
Release 12.2 Certification Matrix described earlier in Part B.
Preparing Oracle SOA Suite in a Multi-node Environment
Oracle E-Business Suite Integrated SOA Gateway follows the reference topology mentioned
in Section 2.1.1.1 MySOACompany Topology with Oracle Access Manager, Oracle Fusion
Middleware Enterprise Deployment Guide for Oracle SOA Suite. Ensure to configure LDAP
as policy store for the ISG-SOA Oracle WebLogic Server domain created while installing
Oracle SOA Suite. Refer to Section 2.4 About LDAP as Credential and Policy Store, Oracle
Fusion Middleware Enterprise Deployment Guide for Oracle SOA Suite. Refer to the flow
chart illustrated in Figure 2-5, Section 2.6.1 Flow Chart of the Oracle SOA Enterprise
Deployment Process, Oracle Fusion Middleware Enterprise Deployment Guide for Oracle
SOA Suite. However, skip or ignore the steps for Oracle Business Activity Monitoring
(BAM), Oracle Business Process Management (BPM), and Oracle Service Bus (OSB).
For more information on configuring Oracle SOA Suite, see the Oracle Fusion Middleware
Enterprise Deployment Guide for Oracle SOA Suite.
Note: To upgrade an existing Oracle SOA Suite instance from 11g to Oracle SOA Suite
12c, see Section 10: Upgrading Oracle SOA Suite 11g to Oracle SOA Suite 12c in an
Existing Configuration.
For new installation of Oracle SOA Suite:
Install Oracle WebLogic Server and Oracle SOA Suite using either one of the following
options from Oracle Software Delivery Cloud (https://edelivery.oracle.com) or Oracle
Technology Network (https://download.oracle.com).
 For Oracle SOA Suite 12c and Oracle E-Business Suite Adapter 12c on Oracle
WebLogic Server 12c
Refer to Roadmap for Installing and Configuring the Standard Installation Topologies, as
described in Oracle Fusion Middleware Installing and Configuring Oracle SOA Suite and
Business Process Management.
 Ensure to install Oracle WebLogic Server as part of the "Install Fusion

Middleware Infrastructure" step. For more information, see Oracle Fusion
Middleware Installing and Configuring the Oracle Fusion Middleware
Infrastructure.
For Oracle WebLogic Server installation, refer to Oracle Fusion Middleware

Installing and Configuring Oracle WebLogic Server and Coherence.
 Create and configure a new Oracle WebLogic Server domain for ISG-SOA,
instead of extending an existing WebLogic domain.
 For Oracle SOA Suite 11g and Oracle Applications Adapter 11g on Oracle WebLogic
Server 11g
Refer to Oracle Fusion Middleware Installation Guide for Oracle SOA Suite and Oracle
Business Process Management Suite. While following steps in Oracle SOA Suite Installation
Roadmap, ensure to:
 Install Oracle WebLogic Server as part of the "Install an Application Server"

step.
For Oracle WebLogic Server installation, refer to the Oracle Fusion Middleware Installation
Guide for Oracle WebLogic Server 10.3.6.
 Create and configure a new Oracle WebLogic Server domain for ISG-SOA,
instead of extending an existing WebLogic domain.
For an existing Oracle SOA Suite installation:
Follow the installation roadmap mentioned above for your Oracle SOA Suite version, but
begin with the "Create a WebLogic domain" step for Oracle SOA Suite 12c or the "Create
and configure your Oracle WebLogic Server Domain" step for Oracle SOA Suite 11g.
Instead of extending an existing WebLogic domain, create and configure a new Oracle
WebLogic Server domain for ISG-SOA.
Section 3.2: Enabling TLS on Oracle SOA Suite
To enable TLS on Oracle SOA Suite with a single node configuration, perform the following
tasks to import a CA-issued SSL certificate to Oracle SOA Suite administration server and
managed servers:
Note: For Oracle SOA Suite with multi-node configuration, follow the steps in Section 19.1.2
Enabling SSL Communication Between the Middle Tier and the Hardware Load
Balancer, Oracle Fusion Middleware Enterprise Deployment Guide for Oracle SOA Suite.
1. Create a keystore for identity and Certificate Signing Request (CSR) through the
following steps:
a. Create a keystore for identity on Oracle SOA Suite, as shown in the example
below:
cd /u01/data/domains/SOA_domain/security
keytool -genkey -alias mykey -keyalg RSA -sigalg SHA256withRSA -keysize 2048
-keystore soaidentity.jks -keypass password -storepass password -validity 3650
-dname "CN=<SOAHOST>,O=Oracle Corporation,L=Redwood City,ST=California,C=US"
b. Create a CSR for the above keystore. For example, the following command
creates a CSR in the file server_oc.csr:
keytool -certreq -sigalg SHA256withRSA -alias myKey -keystore soaidentity.jks
-file server_oc.csr
c. Submit the CSR to CA.

d. Copy the certificates received on Oracle SOA Suite.
e. Import the certificates into the keystore through the following sequence:
keytool -import -alias root -trustcacerts -file rootCA.pem -keystore
soaidentity.jks -storepass password
keytool -import -alias intermediate -trustcacerts -file interCA.pem -keystore

keytool -import -alias mykey -trustcacerts -file serverCert.crt -keystore

2. Configure custom identity and custom trust using the following steps:
a. Log in to Oracle WebLogic Server Administration Console.
In the Administration Console, expand Environment and then

select Servers from the Domain Structure. On the Servers page, click the
name of the server <server_name_where_ssl_has_to_be_configured>. To
configure the Oracle SOA Suite administration server, click the administration
server name. To configure an Oracle SOA Suite managed server, click the
managed server name.
Select the Configuration tab, then the General subtab and then select

the SSL Listen Port Enabled check box.
You may use the default SSL Listen Port mentioned for the server.
b. Select the Keystores subtab under the Configuration tab.

1. Click the drop-down menu next to Keystores and select "Custom
Identity and Custom Trust".
2. Enter the following information:
 In the Identity section, define attributes for the identity
keystore:
 Custom Identity Keystore:
enter <LOCATION_OF_IDENTITY_KEYSTORE_THAT_YOU_HAVE_
CREATED>. For
example, /u01/data/domains/SOA_domain/security/soa
identity.jks.
By default Oracle WebLogic Server will look for this

keystore file in the domain_home location.
 Custom Identity Keystore Type : jks

 Custom Identity Keystore Passphrase: enter
<your_storepass>, such as password.
 In the Trust section, define attributes for the trust keystore:
 Custom Trust Keystore:
enter <LOCATION_OF_IDENTITY_KEYSTORE_THAT_YOU_HAVE_
CREATED>. For
example, /u01/data/domains/SOA_domain/security/soa
identity.jks.
By default Oracle WebLogic Server will look for this

keystore file in the domain_home location.

Custom Trust Keystore Type : jks

Custom Trust Keystore Passphrase: enter
<your_storepass>.
 Save the changes.
c. Click the SSL subtab under the Configuration tab.
Enter the following information:
1. Private Key Alias: Enter <your_certificate_alias>, such as mykey.

2. Private Key Passphrase: Enter <your_keypass>, such as password.
3. Save the changes.
4. Click the Advanced field, and set the "Hostname Verification:" to
'None' from the drop-down menu.
Select the hostname verification as 'None' if the CN of the certificate is

not the same as the hostname of the machine where Oracle WebLogic
Server is installed.
 Additionally, to enforce TLSv1.2 only on Oracle SOA Suite, add the

following JVM option to the JAVA_OPTIONS settings in
the setDomainEnv.sh file:
JAVA_OPTIONS="${JAVA_OPTIONS} -Dweblogic.security.SSL.minimumProtocolVersion=TLSv1.2
-Dhttps.protocols=TLSv1.2"
export JAVA_OPTIONS
Restart Oracle SOA Suite servers.
 Verify your TLS configuration.
 If you are configuring the Oracle SOA Suite administration server,

access your Oracle WebLogic Server Administration Console over the
following URL and verify the secure icon is present:
https://<SOAHOST>:<SSL_PORT_FOR_ADMIN_SERVER>/console/
 If you are configuring Oracle SOA Suite managed servers, access the
following URL in a web browser:
https://<SOAHOST>:<SSL_PORT_FOR_MANAGED_SERVER>/soa-infra/

for SOAP Services on a New Installation of Release 12.2.3 or Later
Note: Ensure that your Oracle E-Business Suite instance is on the latest AD TXK Delta
level and has the recommended technology patches in place. See:
 My Oracle Support Knowledge Document 1617461.1, Applying the Latest AD and

TXK Release Update Packs to Oracle E-Business Suite Release 12.2
 My Oracle Support Knowledge Document 1594274.1, Oracle E-Business Suite
Release 12.2: Consolidated List of Patches and Technology Bug Fixes, for
recommended list of technology patches
Apply the consolidated Patch 31764501:R12.OWF.C, ISG Consolidated Patch for Release

12.2 (20_3_5), to your instance if it has not already been applied. This patch is required
for your instance regardless of a single node or a multi-node environment. Please note that
this patch has two prerequisite patches listed in the patch readme which require adop
phase=fs_clone to be run after the patch application, if your Oracle E-Business Suite
instance is earlier than Release 12.2.9.
Perform the setup tasks described in the following sections:
 Section 4.1: Setup Tasks on Oracle E-Business Suite Release 12.2.3 or Later
 Section 4.2: Configuration Steps on Oracle SOA Suite to Integrate with Oracle E-
Business Suite
Section 4.1: Setup Tasks on Oracle E-Business Suite Release 12.2.3 or Later
Perform the following steps to configure Oracle E-Business Suite Integrated SOA Gateway
on Oracle E-Business Suite Release 12.2.3 or later:
1. Source the environment and run the ISGSoapSetupEBS script:

a. Source the applications run file system environment file:
b. Run the ISGSoapSetupEBS script using the following command:
Note: If your Oracle E-Business Suite instance is configured with multiple

nodes, perform this step on each Oracle E-Business Suite node of the
multi-node environment.
c. perl $FND_TOP/patch/115/bin/ISGSoapSetupEBS.pl
d. The script prompts you to enter the following information:
i. Enter the password for APPS user:
'APPS' is the default Oracle E-Business Suite database user name.

Provide the associated password for the user.
ii. Enter Oracle E-Business Suite's WebLogic Server Admin User Name
[weblogic]:
'weblogic' is the default Oracle WebLogic Server Admin user name.
iii. Enter the password for ${weblogicUser} user:
Provide the associated password for above Oracle WebLogic Server

Admin user.
iv. Enter Oracle E-Business Suite WebLogic Admin Server's URL

(<EBS_ADMIN_SERVER_HOST>:<EBS_ADMIN_SERVER_PORT
>) :
Provide the Oracle E-Business Suite WebLogic administration server's

<hostname>:<port>. For example, host01.example.com:7001.
v. Is Oracle E-Business Suite configured in multiple nodes (Y/ N) :
Enter 'Y' if Oracle E-Business Suite is configured in multiple nodes.

Enter 'N' if Oracle E-Business Suite is configured in a single node.
If your Oracle E-Business Suite is configured in multiple nodes, the

following additional prompt appears:
Is this the primary node for the setup? Y/N
 Enter 'Y' if this is the primary node.

 Enter 'N' if this is your secondary node.
vi. Is Oracle SOA Suite configured in a Cluster (Y/ N) :
If your Oracle SOA Suite is configured in a cluster environment,

see: Oracle SOA Suite in Multiple Nodes.
If your Oracle SOA Suite is not configured in a cluster environment,
see: Oracle SOA Suite in a Single Node.
Oracle SOA Suite in Multiple Nodes
The following prompts appear if your Oracle SOA Suite is in a cluster

environment:
 Enter Oracle SOA Suite WebLogic Admin Server's URL

(http(s)://<SOA_ADMIN_SERVER_HOST>:<SOA_ADMIN_
SERVER_PORT>) :
Provide the Oracle SOA Suite WebLogic administration

server's URL with non-TLS (HTTP) listen port in the following
format:
http://<SOA_ADMIN_SERVER_HOST>:<SOA_ADMIN_SE
RVER_PORT>
Note: If the Oracle SOA Suite WebLogic administration

server is configured with virtual host, provide the virtual
host and port of that administration server.
 Enter Oracle SOA Suite's Cluster URL
(http(s)://<SOA_CLUSTER_HOST>:<SOA_CLUSTER_POR
T>) :
Provide the Oracle SOA Suite Cluster URL (load balancer

URL of the SOA managed server) in the following format:
http(s)://<SOA_CLUSTER_HOST>:<SOA_CLUSTER_PORT
>
 Enter Oracle SOA Suite Server's Hostnames separated by

comma (<SOAHOST1.DOMAIN>, <SOAHOST2.DOMAIN>)
:
Provide the fully qualified hostnames of the Oracle SOA Suite

server separated by comma. For
example, soahost1.example.com, soahost2.example.com.
If you have configured the virtual hosts for Oracle SOA Suite
servers, provide the physical fully qualified hostname of each
of the SOA nodes.
 Enter IP addresses of above Oracle SOA Suite Servers

separated by comma (<IP Address1>, <IP Address2>) :
Provide the IP addresses of the Oracle SOA Suite servers

separated by comma. For
example, xx.xxx.xx.xx, xx.xxx.xx.xx.
If you have configured the virtual hosts and virtual IPs for
Oracle SOA Suite servers, provide the IP address
corresponding to the physical hostnames of each of the SOA
nodes. Ensure that you provide the IP addresses in the same
order as the hostnames provided in the previous prompt.
Oracle SOA Suite in a Single Node
If your Oracle SOA Suite is not configured with multiple nodes, the
following prompts appear:
 Enter Oracle SOA Suite WebLogic Admin Server's URL

(http(s)://<SOA_ADMIN_SERVER_HOST>:<SOA_ADMIN_
SERVER_PORT>) :

server's URL with non-TLS (HTTP) listen port in the following
format:
http://<SOA_ADMIN_SERVER_HOST>:<SOA_ADMIN_SE
RVER_PORT>
 Enter Oracle SOA Suite's Managed Server URL

(http(s)://<SOA_MANAGED_SERVER_HOST>:<SOA_MA
NAGED_SERVER_PORT>) :
Provide the Oracle SOA Suite managed server's URL in the

following format:
http(s)://<SOA_MANAGED_SERVER_HOST>:<SOA_MAN
AGED_SERVER_PORT>
 Enter Oracle SOA Suite Server's Hostname

(<SOAHOST.DOMAIN>) :
Provide the fully qualified hostname of the Oracle SOA Suite

server. For example, soahost.example.com.
 Enter IP address of above Oracle SOA Suite Server (<IP

Address>) :
Provide the IP address of the Oracle SOA Suite server. For

example, xx.xxx.xx.xx.
Note: This configuration may take a few minutes to complete. The completion

status would be displayed on terminal. Log files are written in the current
directory.
2. As part of the script run, you would see the message like:
3. Generating DBC file for Host: soahost1.example and IP: xx.xxx.xx.xx ...
DBC file generation completed successfully.
Check../logs/appl/rgf/TXK/EBS_BPEL_payload_host01.example.zip
4. For Oracle SOA Suite with multiple nodes, the EBS_BPEL_payload zip file would be
created for each SOA node. Record the zip file generated for each SOA host. The zip
file, such as EBS_BPEL_payload_host01.example.zip shown above, would be placed in
a respective SOA node as described in Section 4.2.
5. To restrict access to Oracle E-Business Suite database from external nodes, various
tasks should be performed based on your Oracle E-Business Suite database.
a. For an Oracle Real Application Clusters (RAC) database with grid listener:
Note: This step applies to an Oracle E-Business Suite database 19c, 12c,

or an earlier release.
 Update sqlnet.ora in the Grid home of each database node,
with the following properties:
tcp.validnode_checking = yes
tcp.invited_nodes=(<Secure_Host_List_from_FND_NODES_tabl
es>)
SQLNET.INBOUND_CONNECT_TIMEOUT = 60
 Stop the database listener from the Grid home using the
following command:
srvctl stop listener
 Stop the scan listener from the Grid home using the following
command:
srvctl stop scan_listener
 Start the database listener from the Grid home using the
following command:
srvctl start listener
 Start the scan listener from the Grid home using the following
command:
srvctl start scan_listener
b. For an Oracle RAC database with local listener, perform the following steps
on each database node. In an environment that does not use Oracle RAC,
follow the steps in a database node:
i. If your Oracle E-Business Suite database is 19c, perform the following

tasks:
 Source the PDB database tier environment file.
source <RDBMS ORACLE_HOME>/<PDB_SID>_<HOSTNAME>.env
 Run AutoConfig on the database tier.

sh $ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/adautocfg.sh
 Verify that $TNS_ADMIN/sqlnet.ora contains the following

properties:
es>)
$TNS_ADMIN/sqlnet.ora will
be updated only if the profile
option FND_SQLNET_ACCESS is set to
ALLOW_RESTRICTED.
 Source the CDB database tier environment file.

source <RDBMS ORACLE_HOME>/<CDB_SID>_<HOSTNAME>.env
 Stop the database listener using the following command:

$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/adcdblnctl.sh stop
$ORACLE_SID
 Start the database listener using the following command:

$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/adcdblnctl.sh start
$ORACLE_SID
ii. If your Oracle E-Business Suite database is 12c or an earlier release,

perform the following tasks:
 Source the database tier environment file.
source <RDBMS ORACLE_HOME>/<SID>_<HOSTNAME>.env
 Run AutoConfig on the database tier.
 Stop the database listener using the following command:
$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/addlnctl.sh stop $ORACLE_SID
 Verify that $TNS_ADMIN/sqlnet.ora contains the following

properties:
es>)
ALLOW_RESTRICTED.
 Start the database listener using the following command:
$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/addlnctl.sh start $ORACLE_SID
a. Conditional) Only if your Oracle E-Business Suite release is earlier than 12.2.9, then
perform the following step on Oracle E-Business Suite 12.2 enabled for Online
Patching to copy the SOAP configurations done above to the other file system. This
step is not required for Oracle E-Business Suite 12.2.9 and onwards.
Important: If REST services are also used, complete the entire setup tasks for
both SOAP and REST services before running the adop
phase=fs_clone command. For information on configuring REST services, refer
to Section 1: Configuring Oracle E-Business Suite Integrated SOA Gateway for
REST Services.
adop phase=fs_clone
Note: Oracle E-Business Suite Integrated SOA Gateway would be configured on

the other file system once the above command is run and the second file system
will be active when a patch is applied using the following commands for Online
Patching:
1. adop phase=prepare
2. adop phase=apply
3. adop phase=cutover
During the cutover phase of online patching, Oracle E-Business Suite Integrated
SOA Gateway services would be unavailable. Service invocation should resume
once the cutover phase is complete.
After the cutover, isgagent.properties on Oracle E-Business Suite is not

synchronized between both file systems.
Additional Information: Online Patching stores multiple application editions in

the database, and has the provision of a dual application tier file system. At any
given point in time, one of these file systems is active and designated as the 'run'
file system (part of the running system) and the other as the 'patch' file system
(either being patched or awaiting the start of the next patching cycle). Whichever
is the current run file system appears to the user in exactly the same way as the
single application tier file system did in Oracle E-Business Suite releases prior to
Release 12.2.
Please note that for a successful setup, either both the systems should be TLS
enabled or none of them should be TLS enabled. For more information about
Online Patching, see Oracle E-Business Suite Release 12.2: Online Patching
FAQ, My Oracle Support Knowledge Document 1583902.1 and the Oracle E-
Business Suite Maintenance Guide.
Section 4.2: Configuration Steps on Oracle SOA Suite to Integrate with Oracle E-Business
Suite
Perform the following setup steps on Oracle SOA Suite to integrate with Oracle E-Business
Suite:
Note: Perform the following steps 1, 2, 3a, and 3b in this section only if Oracle E-
Business Suite is TLS (HTTPS) enabled. These steps may be required only if Oracle E-
Business Suite is TLS enabled and the root CA certificate for Oracle E-Business Suite is
not present in cacerts of Oracle SOA Suite.
Step 3c should be performed, irrespective of whether Oracle E-Business Suite is TLS
enabled or not.
1. Verify if the CA certificate to be imported from issuing authority is valid. Browse the
secure EBS Login URL(https://<HOST>:<PORT>/OA_HTML/AppsLogin). Click on the
Certificate Error icon. Ensure that there is no error message like "Invalid certificate".
Invalid certificate might cause TLS handshake errors later in service generation. A
valid self-signed certificate can be like:
2. Import the CA certificate of the issuing authority from Oracle E-Business Suite into
Oracle SOA Suite.
Copy {s_web_ssl_directory}/Apache/<certificate-name>.crt from Oracle E-Business Suite

to your Oracle SOA Suite server.
Note: Location of the CERTS directory is controlled using context

variable <s_web_ssl_directory>.
Use the following methods to locate which jre is being used by Oracle SOA Suite:
 source
<DOMAIN_HOME>/bin/setDomainEnv.sh (or <DOMAIN_HOME>\bin\setDomainEnv.cm
d on Windows).
 echo $JAVA_HOME: This will show which jdk is being used.
 <JRE_HOME> environment variable might not be set, but $JAVA_HOME/jre could
be used as <JRE_HOME> location.
Note: If your Oracle SOA Suite instance is configured with multiple

nodes, <DOMAIN_HOME> should be that of Oracle SOA Suite administration and
managed servers.
Note: If $JAVA_HOME is in the shared file system, you may perform this step once from
the home directory of your Oracle SOA Suite administration or managed server.
Navigate to the <JRE_HOME>/lib/security directory and import the Oracle E-Business Suite
certificate into the default keystore (cacerts) using the following command:
keytool -import -alias ApacheServer -file <path_of_certificate-name.crt> -trustcacerts -v
-keystore cacerts -storepass <certificate_store_password>
For example,
keytool -import -alias ApacheServer -file /tmp/<certificate-name>.crt -trustcacerts -v
-keystore ./cacerts -storepass password
Note: If the keytool command fails with keytool error, java.io.FileNotFoundException:

cacerts (Permission denied), try the import with super user.
3. In the setDomainEnv script, perform the following tasks:
Note: If your Oracle SOA Suite instance is configured with multiple nodes,
perform this step on the domain home directory of both the Oracle SOA Suite
administration and managed servers.
a. Set JAVA_OPTIONS with property for truststore:
Note that <JRE_HOME> mentioned here indicates the same as described earlier in

Step 2 of this section.
a. In setDomainEnv.sh for UNIX/Linux:
JAVA_OPTIONS="${JAVA_OPTIONS}
-Djavax.net.ssl.trustStore=<JRE_HOME>/lib/security/cacerts"
export JAVA_OPTIONS
b. In setDomainEnv.cmd for Windows:
set JAVA_OPTIONS=%JAVA_OPTIONS%
-Djavax.net.ssl.trustStore=<JRE_HOME>\lib\security\cacerts
b. Set JAVA_OPTIONS with property for JSSE (Oracle SOA Suite 11g only):
o In setDomainEnv.sh for UNIX/Linux:
JAVA_OPTIONS="${JAVA_OPTIONS} -Dweblogic.ssl.JSSEEnabled=true"
export JAVA_OPTIONS
o In setDomainEnv.cmd for Windows:
set JAVA_OPTIONS=%JAVA_OPTIONS% -Dweblogic.ssl.JSSEEnabled=true
c. Search and set the WLS_JDBC_REMOTE_ENABLED property to enable exception

handling (Oracle SOA Suite 11g only):
o In setDomainEnv.sh for UNIX/Linux:
WLS_JDBC_REMOTE_ENABLED="-Dweblogic.jdbc.remoteEnabled=true"
o In setDomainEnv.cmd for Windows:
set WLS_JDBC_REMOTE_ENABLED=-Dweblogic.jdbc.remoteEnabled=true
4. Create a temporary folder (designated here as <TEMP>) on the Oracle SOA Suite
server. Please note that this folder can be created in any directory with write
permission on the server.
Note: For Oracle SOA Suite configured with multiple nodes, the <TEMP> folder

should be created in the shared file system.
5. Create a folder called <DBC> on the Oracle SOA Suite server for the DBC file. This
folder can be created in any directory with write permission on the server.
Note: For Oracle SOA Suite configured with multiple nodes, the <DBC> folder

should be created in the non-shared file system on each Oracle SOA Suite node.
Use the same folder name <DBC> in the same directory path on all Oracle SOA
Suite nodes.
For example, if you create the <DBC> folder in the /scratch/u01/ directory on the

non-shared file system of the Oracle SOA Suite node1, then other Oracle SOA
Suite nodes should also have the <DBC> folder in the /scratch/u01/ directory on
their non-shared file system.
6. Copy the EBS_BPEL_payload.zip file created as part of the step 1 in Section 4.1 from
Oracle E-Business Suite (/$INST_TOP/logs/appl/rgf/TXK/EBS_BPEL_payload.zip) to
the <TEMP> folder on the Oracle SOA Suite server.
For Oracle SOA Suite configured with multiple nodes, the EBS_BPEL_payload.zip file

for each SOA node should be copied to the <TEMP> folder on the Oracle SOA Suite
server. For example, zip files, such
as EBS_BPEL_payload_host01.example.com.zip and EBS_BPEL_payload_host02.example
.com.zip should be copied to the <TEMP> directory.
7. Download and copy either one of the following application patch into
the <TEMP> directory based on your Oracle SOA Suite version:
o For Oracle SOA Suite 12.2.1.4.0, apply Patch 31783707.

o For Oracle SOA Suite 12.2.1.3.0 or earlier, apply Patch 31764510.
Unzip and extract the contents in the downloaded patch into

the <TEMP> directory.
o Ensure that the following are in place before proceeding to next step:
o Oracle SOA Suite administration and managed servers are running.

o Node Manager is also up and running on all nodes.
o boot.properties file with user credentials for stopping and starting the servers
in background is in place
($DOMAIN_HOME/servers/SERVER_NAME/security directory of all
servers).
o Listen address is configured for the administration and SOA managed servers.
o For a multi-node configuration, load balancer is up and running. It is
accessible from the SOA administration and SOA managed servers.
o SOA administration and managed servers are able to access Oracle E-Business
Suite servers.
o Run the setup script:
Note: If your Oracle SOA Suite instance is configured with multiple nodes or in a
cluster, you may have a separate domain home directory for Oracle SOA Suite
administration and managed servers. This step should be performed for each
domain home directory of Oracle SOA Suite administration and managed servers.
While following the instructions in this step, ensure to:
1. First, run the script on the secondary nodes (SOA node n). Then,
run the script on the primary node (SOA node 1).
2. On the secondary nodes:
Run the script by sourcing the setDomainEnv.sh file in the domain home

directory of the SOA managed servers (as mentioned in substep 'a'). In this
case, provide the value for soaIsPrimaryNode as 'No' (as mentioned in
substep 'c').
3. On the primary node:

 If a separate domain home directory exists for the SOA
managed server, run the script by sourcing the setDomainEnv.sh file
in the domain home directory of the SOA managed server (as
mentioned in substep 'a'). In this case, provide the value
for soaIsPrimaryNode as 'No' (as mentioned in substep 'c').
 Run the script by sourcing the setDomainEnv.sh file in the
domain home directory of the SOA administration server (as
mentioned in substep 'a'). In this case, provide the value
for soaIsPrimaryNode as 'Yes' (as mentioned in substep 'c').
1. Source the following files:

source <WL_HOME>/server/bin/setWLSEnv.sh
source <DOMAIN_HOME>/bin/setDomainEnv.sh
<DOMAIN_HOME> represents the ISG-SOA Domain home.
2. Change directory to the <TEMP> folder:

cd <path to the TEMP folder>
3. Run the setup script using the similar command by changing the information
based on your Oracle E-Business Suite and Oracle SOA Suite server
configuration and current node information:
java oracle.apps.fnd.isg.setup.SoapSetup ebsUrl=<http(s)://EBS Host:port>
soaAdminUrl=<http://SOA Admin Host:port> soaManagedUrl=<http(s)://SOA Managed
Server Host:port> soaWeblogicUser=<weblogic user> ebsDbsid=<EBS DB SID>
soaOracleHome=<SOA Oracle Home> appsUser=<EBS Apps User> soaIsCluster=<Yes/ No>
soaClusterName=<soa_cluster> soaIsPrimaryNode=<Yes/ No>
soaServerName=<soa_server> dbcDirectory=<DBC>
1. ebsUrl:
Enter your Oracle E-Business Suite URL in the following format:
http(s)://<EBS Host>:<port>
2. soaAdminUrl: Enter your Oracle SOA Cloud Service administration sever URL
with non-TLS (HTTP) listen port in the following format: http://<SOA Admin
Host>:<port>
3. soaManagedUrl: Enter your Oracle SOA Suite managed sever URL in the
following format: http(s)://<SOA Managed Server Host>:<port>
For a multi-node configuration, provide the load-balanced host and port in the
same format mentioned here.
4. soaWeblogicUser:
Enter your WebLogic server user name.
5. ebsDbsid: Enter Oracle E-Business Suite database SID information.
6. soaOracleHome: Enter Oracle SOA Suite Oracle Home.
7. appsUser: Enter Oracle E-Business Suite application user name.
8. soaIsCluster: Enter 'Yes' if your Oracle SOA Suite is configured in multiple
nodes; and enter 'No' if it is not.
9. soaClusterName: Enter your Oracle SOA Suite cluster name, such as
soa_cluster.
10. soaIsPrimaryNode: Enter 'Yes' if this is your primary node and if you have
sourced the setDomainEnv.sh file of the SOA administration server domain
home directory; enter 'No' for other cases.
11. soaServerName: Enter the Oracle SOA Suite server name, such as soa_server.
For Oracle SOA Suite in a cluster environment with multiple SOA managed
servers on the node, enter the Oracle SOA Suite server name of any one SOA
managed server on the node.
12. dbcDirectory: Enter the DBC directory information.
For help on the options passed, run java oracle.apps.fnd.isg.setup.SoapSetup

-help.
o If Oracle SOA Suite 11g is installed on AIX, Solaris, or HP-UX Itanium
platform, modify the setting of the POST_CLASSPATH variable in
the <DOMAIN_HOME>/bin/setDomainEnv.sh file as follows:
if ["${POST_CLASSPATH}" != "" ]; then
POST_CLASSPATH="${COMMON_COMPONENTS_HOME}/modules/oracle.jrf_11.1.1/jrf-
client.jar${CLASSPATHSEP}${POST_CLASSPATH}"
POST_CLASSPATH="${COMMON_COMPONENTS_HOME}/modules/oracle.jrf_11.1.1/jrf.jar$
{CLASSPATHSEP}${POST_CLASSPATH}"
export POST_CLASSPATH
else
POST_CLASSPATH="${COMMON_COMPONENTS_HOME}/modules/oracle.jrf_11.1.1/jrf-
client.jar"
POST_CLASSPATH="${COMMON_COMPONENTS_HOME}/modules/oracle.jrf_11.1.1/jrf.jar$
{CLASSPATHSEP}${POST_CLASSPATH}"
export POST_CLASSPATH
fi
Stop and restart all Oracle SOA Suite administration and managed servers from the
command prompt. If Oracle SOA Suite is configured for multiple SOA nodes, ensure
the SOA load balancer and node managers are up and running.
After configuring Oracle E-Business Suite Integrated SOA Gateway Release 12.2.3 or later,
validate the setup by following steps described in Section 5: Validating Oracle E-Business
Suite Integrated SOA Gateway Setup for SOAP Services.
Section 5: Validating Oracle E-Business Suite Integrated SOA Gateway

Setup for SOAP Services
To ensure the successful installation or upgrade to Release 12.2.x, you can validate the setup
tasks for SOAP services through the following ways:
 Perform the design-time activities from the Integration Repository user interface
For more information on performing the design-time activities through the Integration
Repository user interface, refer to Administering SOAP Web Services Through
Integration Repository, Oracle E-Business Suite Integrated SOA Gateway
 Run the diagnostic tests through backend processing
Oracle E-Business Suite Integrated SOA Gateway uses an Ant

script $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml to run the diagnostic tests
through backend processing. This section describes how to validate the setup using the script.
Perform the following steps to validate the Oracle E-Business Suite Integrated SOA Gateway
setup using the diagnostic script:
1. Source the applications run file system environment file:

2. Run the following commands and verify the reports generated

at $JAVA_TOP/oracle/apps/fnd/isg/ant, for any errors:
ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml DiagnoseAPPSetup -Dverbose=ON
This command runs configuration checks on the Oracle SOA Suite side.
ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml DiagnoseAGENTSetup
-Dverbose=ON
This command runs configuration checks on the Oracle E-Business Suite side.
ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml DiagnoseISGFunctionality
-Dverbose=ON
This command runs all design-time operations for all types of interfaces in Oracle E-
Business Suite Integrated SOA Gateway.
Note: When running this command, you may find the following errors for Java
APIs for Forms. These errors may be shown in
the ISGFunctionalDiagnosticsReport.xml report.
oracle.apps.fnd.isg.common.error:ISGException: ISG_SERVICE_GENERATE_ERROR: Error in
generating JAVA package
<oracle.apps.fnd.isg.diagnostics.agent.FunctionalTests.checkSOAPFORMSOperations
status="Failed" message="Unexpected Error : null, Unable to suggest any corrective
action." level="1"/>
Since Java APIs for Forms are not serviceable interfaces and cannot be exposed as
SOAP services in this release 12.2 (see Document 966982.1 for information about
the desupport of Java APIs for Forms), you can ignore these errors for Java APIs
for Forms.
If there are any failures in the diagnostic reports, please verify the setups. For more
information on how to use the script, see Oracle E-Business Suite Integrated SOA Gateway
Diagnostic Tests, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Additionally, you can validate the setup for SOAP services using command line tool. Refer
to Managing SOAP Service Lifecycle Activities Using an Ant Script, Oracle E-Business
Suite Integrated SOA Gateway Implementation Guide.
Section 6: Deploying Generic XML Gateway Services for SOAP Services
If your system is upgraded from an earlier Oracle E-Business Suite release and you have been
using generic XML Gateway services, the generic XML Gateway services can be displayed
for a selected XML Gateway interface. To successfully display the generic XML Gateway
service WSDL URL in the Generic XML Gateway Service subregion within the Web Service
region, the following conditions must be met:
Note: In this release, Oracle XML Gateway web services depend on Oracle E-Business
Suite Integrated SOA Gateway. If your system is upgraded from an earlier Oracle E-
Business Suite release and you have been using XML Gateway services, then install
Oracle SOA Suite first, before the upgrade to Release 12.2.
 The "FND: XML Gateway Map Generic Service" profile value must be set to "Yes".
Use this profile option to display or hide the Generic XML Gateway Service subregion for
the selected XML Gateway interface. Once it is set to "Yes",the Generic XML Gateway
Services subregion will be displayed within the Web Service region.
 The generic XML Gateway service must be deployed.
Once a generic XML Gateway service has been deployed, the deployed service WSDL URL
is populated as the profile value for the "ISG: Generic Service WSDL URL for XMLG"
profile option. The WSDL URL is also displayed in the Generic XML Gateway Service
subregion. If the generic XML Gateway service is not deployed, the profile value will not be
shown and hence no WSDL URL is displayed in the subregion for the selected XML
Gateway interface.
Use the following steps to deploy generic XML Gateway services:
1. Run script <JAVA_TOP>/oracle/apps/fnd/isg/ant/isgDesigner.xml as follows:

ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml deployGenericXMLG
-Dverbose=<ON|OFF>
2. Search for an XML Gateway interface in the Integration Repository. Observe that
generic XML Gateway service is deployed. Click on the WSDL link to see the
deployed generic XML Gateway WSDL description.
Part C: Configuring Oracle E-Business Suite Integrated SOA Gateway for

Upgrading and Cloning Scenarios
This section includes the following topics:
 Section 7: Configuring Oracle E-Business Suite Integrated SOA Gateway on Release

12.2.x Cloned From an Existing 12.2.x Environment
 Section 8: Configuring Oracle E-Business Suite Integrated SOA Gateway for REST
Services on Release 12.2.x Upgraded From Oracle E-Business Suite Release 12.1.x
 Section 9: Configuring Oracle E-Business Suite Integrated SOA Gateway for SOAP
Services on Release 12.2.x Upgraded From Oracle E-Business Suite Release 12.1.x
 Section 10: Upgrading Oracle SOA Suite 11g to Oracle SOA Suite 12c in an Existing
Configuration
 Section 11: Performing Post-Oracle E-Business Suite Database Upgrade Tasks for
ISG-Configured Instances
Note: For information on upgrading Oracle SOA Suite 11g to Oracle SOA Suite 12c for
Oracle E-Business Suite SOAP services, refer to Section 10: Upgrading Oracle SOA Suite
11g to Oracle SOA Suite 12c in an Existing Configuration.
Section 7: Configuring Oracle E-Business Suite Integrated SOA Gateway on
Release 12.2.x Cloned From an Existing 12.2.x Environment
This configuration applies to an Oracle E-Business Suite instance either with or without
Oracle E-Business Suite Integrated SOA Gateway configuration being cloned.
1. Enable your Oracle E-Business Suite Integrated SOA Gateway by following

instructions as described in Section 1 for REST services or Section 4 for SOAP
services.
Note: Ensure that you have applied the patches mentioned in Section

1 and Section 4.
2. Log in to Oracle E-Business Suite middle tier and run the following script:
ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml -Dactions="postclone"
-Dverbose=ON
Enter Service Type : (SOAP, [REST], BOTH)
Important: If an API has overloaded methods, the postclone script may not work

as expected. Hence, before running the script, make a note of the deployed
overloaded methods. Additionally, after running the script, redeploy the
overloaded methods from Oracle Integration Repository UI page or using backend
script.
Note that the postclone script for cloning REST services is currently certified with
Oracle E-Business Suite shared file system.
o To clone SOAP services, select "SOAP" as the Service Type value.
A report file PostCloneResults.txt is generated. This file is created on the

Oracle SOA Suite instance
in <DBSID>.ISG_TEMP_DIRECTORY_LOCATION mentioned in
the <TEMP>/appsutil/<CONTEXT>/bpel/isg_contextfile.properties file.
o To clone REST services, leave the default selection "REST" as the Service
Type value.
The script writes results to the $INST_TOP/soa/RESTPostCloneResults.txt file.

It includes postclone status and WADL URL for each deployed interface. If
the script fails to redeploy an interface, it is also mentioned in this file.
o To clone both SOAP and REST services, select "BOTH" as the Service Type
value.
The script writes results to PostCloneResults.txt for SOAP services

and RESTPostCloneResults.txt for REST services.
Important: There is no change in the Oracle E-Business Suite Integrated SOA Gateway

services when the postclone method is called except the Service End Point (Service
Location) URL of these services. The new Service End Point (Service Location) URL is
listed in the file <INST_TOP>/soa/PostCloneResults.txt for SOAP services or
the RESTPostCloneResults.txt file for REST services. It is also available in the Interface
Detail page of the Integration Repository.
for REST Services on 12.2.x Upgraded From Oracle E-Business Suite
Release 12.1.x
Release 12.2.x upgraded from Oracle E-Business Suite Release 12.1.x:
1. Follow the upgrade information in the Oracle E-Business Suite Upgrade

Guide: Release 12.0 and 12.1 to 12.2 to upgrade Oracle E-Business Suite
Release 12.2.2 from Release 12.1.x.
Note: Oracle E-Business Suite Upgrade Guide: Release 12.0 and 12.1 to 12.2 is
required by Release 12.0 and Release 12.1 customers applying Release 12.2.2.
2. If you are upgrading from Release 12.1.x to Release 12.2.3 or later, complete
the upgrade of Oracle E-Business Suite Release 12.2.0, including the
preparing for the upgrade tasks and post-upgrade steps, before you apply
Oracle E-Business Suite Release 12.2.3 or later.
Oracle E-Business
Relevant Resources
Suite
o Document 2666934.1, Oracle E-Business
Suite Release 12.2.10 Readme
Oracle E-Business Suite
o Document 2661861.1, Applying the
Release 12.2.10
R12.ATG_PF.C.Delta.9 Release Update Pack
Release 12.2.9

Release 12.2.8

Release 12.2.7

Release 12.2.6

Release 12.2.5

Release 12.2.4

Release 12.2.3
Additionally, refer to My Oracle Support Knowledge Document

1581299.1, Oracle E-Business Suite Release 12.2 Information Center, for
more information and relevant resources.
3. To configure REST services, follow all the steps described in Section 1:

Configuring Oracle E-Business Suite Integrated SOA Gateway for REST
Services.
4. (Optional) If custom interfaces are used for Oracle E-Business Suite release
12.1.x, Integration Repository Parser (IREP Parser) needs to be configured
again for custom interface validation. For information on setting up the IREP
Parser and performing required tasks for updated custom interfaces,
see Setting Up and Using the Integration Repository Parser and Performing
Administrative Tasks for Custom Integration Interfaces and Services, Oracle
E-Business Suite Integrated SOA Gateway Implementation Guide.

for SOAP Services on Release 12.2.x Upgraded From Oracle E-Business
Suite Release 12.1.x
for SOAP services on Release 12.2.x upgraded from Oracle E-Business Suite Release 12.1.x:
1. Follow the upgrade information in the Oracle E-Business Suite Upgrade

Guide: Release 12.0 and 12.1 to 12.2 to upgrade Oracle E-Business Suite
Release 12.2.2 from Release 12.1.x.
Note: Oracle E-Business Suite Upgrade Guide: Release 12.0 and 12.1 to 12.2 is
required by Release 12.0 and Release 12.1 customers applying Release 12.2.2.
2. If you are upgrading from Release 12.1.x to Release 12.2.3 or later, complete
the upgrade of Oracle E-Business Suite Release 12.2.0, including the
preparing for the upgrade tasks and post-upgrade steps, before you apply
Oracle E-Business Suite Release 12.2.3 or later.
Oracle E-Business
Relevant Resources
Suite
Release 12.2.10

Release 12.2.9

Release 12.2.8

Release 12.2.7
Oracle E-Business Suite o Document 2114016.1, Oracle E-Business

Release 12.2.6 Suite Release 12.2.6 Readme

Release 12.2.5

Release 12.2.4

Release 12.2.3
Additionally, refer to My Oracle Support Knowledge Document

1581299.1, Oracle E-Business Suite Release 12.2 Information Center, for
more information and relevant resources.
Note that if your system is upgraded from Oracle E-Business Suite Release
12.0 or 12.1, and you have leveraged Oracle XML Gateway web services or
Oracle E-Business Suite Integrated SOA Gateway feature, install Oracle SOA
Suite 11g first, before the upgrade to Release 12.2.
3. Follow all the steps described in Section 4: Configuring Oracle E-Business

Suite Integrated SOA Gateway for SOAP Services on a New Installation of
Release 12.2.3 or Later.
4. (Optional) If custom integration interfaces are used for Oracle E-Business
Suite release 12.2.x, Integration Repository Parser (IREP Parser) needs to be
configured again for custom interface validation. For information on setting up
the IREP Parser and performing required tasks for updated custom interfaces,
see Setting Up and Using the Integration Repository Parser and Performing
Administrative Tasks for Custom Integration Interfaces and Services, Oracle
E-Business Suite Integrated SOA Gateway Implementation Guide.
5. (Optional) If SAML Token security is used, follow the setup instructions
described in My Oracle Support Knowledge Document 1332262.1, Setting Up
SAML Token Security for Oracle E-Business Suite Integrated SOA Gateway
Release 12.2.
6. Log in to Oracle E-Business Suite Middle tier and run the following script:
ant -f <JAVA_TOP>/oracle/apps/fnd/isg/ant/isgDesigner.xml -Dactions=upgrade
-Dverbose=ON
A report file is created in directory <INST_TOP>/soa/ISGUpgrade.txt which

contains the 'Upgrade' Action summary. This summary contains the Service
Names and new Service End Point (Service Location) URLs.
Important: There is no change in Oracle E-Business Suite Integrated SOA
Gateway services when migrated from 12.1.x to Oracle E-Business Suite Release
12.2.x except Service End Point (Service Location) URL of the deployed services.
New Service End Point (Service Location) URL is listed in the
file <INST_TOP>/soa/ISGUpgrade.txt. It is also available in the Interface Detail
page of the Integration Repository user interface. To ensure backward
compatibility, the previous 12.1.x service endpoint (services deployed in Oracle E-
Business Suite) will continue to work at runtime after the upgrade. New service
endpoint from Oracle SOA Suite server will be shown in the interface detail page
and should be used for client programs.
7. (Optional) If you have been using generic XML Gateway services in an earlier
Oracle E-Business Suite release, perform the steps described in Section 6:
Deploying Generic XML Gateway Services to deploy generic XML Gateway
services.
Section 10: Upgrading Oracle SOA Suite 11g to Oracle SOA Suite 12c in an
Existing Configuration
If your Oracle E-Business Suite Integrated SOA Gateway is already configured with Oracle
SOA Suite 11g (11.1.1.9.0) for SOAP-based services and if such Oracle SOA Suite needs to
be upgraded to Oracle SOA Suite 12c (12.2.1.2), perform the following steps:
1. Perform the Oracle Fusion Middleware Pre-Upgrade Tasks, as described in Oracle

Fusion Middleware Upgrading SOA Suite and Business Process Management.
Additionally, ensure the following tasks are in place:
a. Back up the setDomainEnv.sh, setSOADomainEnv.sh, and config.xml files.

b. If you are using the file-based policy store, create and reassociate OPSS and
Audit service to use the database-based or LDAP-based policy store as
mentioned in Reassociating the OPSS Security Store, Oracle Fusion
Middleware Securing Applications with Oracle Platform Security Services.
c. Upgrade JDK certified for Oracle SOA Suite 12c. Ensure you uptake the latest
policy files for encryption and decryption.
2. Perform the upgrade by following the instructions described in Upgrading SOA Suite
and Business Process Management from 11g, Oracle Fusion Middleware Upgrading
SOA Suite and Business Process Management.
Note: Before running reconfig.sh to reconfigure the domain, ensure to remove

the following text from <DOMAIN_HOME>/config/config.xml:
<sec:authentication-provider xmlns:orac="oracle.apps.fnd.isg" xsi:type="orac:isg-
authenticatorType">
<sec:name>ebssid_IsgAuthenticator</sec:name>
<sec:control-flag>SUFFICIENT</sec:control-flag>
<orac:ebs-connection-reference>jdbc/ebssid </orac:ebs-connection-reference>
</sec:authentication-provider>
3. For information about upgrading Oracle SOA Suite in a multi-node environment,

see Upgrading a Clustered SOA Environment, Oracle Fusion Middleware Upgrading
SOA Suite and Business Process Management.
4. Additionally, ensure the following tasks are in place:
a. Install 12c binaries on the SOA secondary nodes where only managed servers
are running. Use the same path as used for installing 12c binaries on the
primary node for this installation.
b. Ensure to stop Oracle SOA Suite administration and managed servers as well
as associated processes in the sequence, as described in Stopping Servers and
Processes, Oracle Fusion Middleware Upgrading SOA Suite and Business
Process Management.
c. Perform a complete upgrade of 11g environment on the primary node by
following the tasks listed in the upgrade roadmap table in Upgrading a
Clustered Topology.
d. After a successful upgrade, propagate the domain configuration of the primary
node (for example, SOAHOST1) to a secondary node (for example, SOAHOST2).
 On SOA Primary Node (SOAHOST1):
 Step 1: Run the pack command on the SOA primary node
(See Executing the pack command on the server where the
Admin Server and one of the Managed Servers is installed)
cd /12c_ORACLE_HOME/oracle_common/common/bin
./pack.sh -domain=/11g_DOMAIN_HOME
-template=domainupgradetemplate.jar
-template_name=domainupgradetemplate -managed=true
 Step 2: Copy the template you just created from the previous
step to the secondary node SOAHOST2 (See Copying the template
file created in the previous step to SOAHOST2)
scp domainupgradetemplate.jar
company@SOAHOST2:12c_ORACLE_HOME/oracle_common/common/bin
 On SOA Secondary Node (SOAHOST2):

 Step 3: Run the unpack command on the SOA secondary node
(See Executing the unpack Command from the 12c Oracle
Home on SOAHOST2)
Ensure to empty the contents of 11g_DOMAIN_HOME on the

SOA secondary node. Back up your files if this is not already
performed.
cd /12c_ORACLE_HOME/oracle_common/common/bin
./unpack.sh -template=domainupgradetemplate.jar -
domain=11g_DOMAIN_HOME
e. Perform validation checks to ensure domain structures are successfully created

by following the instructions in Completing the following verification steps
after the unpack.
f. Start the Oracle SOA Suite administration and managed servers by performing
the tasks as described in Starting the Admin Server and SOA Managed
Servers.
g. Remove Oracle Web Services Manager (OWSM) targets from SOA and OSB
clusters by performing the tasks as described in Removing OWSM Targets
from SOA and OSB Clusters.
h. Rewire the OWSM Policy Manager components by following the instructions
as described in Updating OWSM Cross-Component Wiring.
5. Perform the post-upgrade tasks by following the instructions in Performing Post
Upgrade Tasks. Before proceeding, ensure
that setDomainEnv.sh and setSOADomainEnv.sh have SOA_ORACLE_HOME set
to 12C ORACLE_HOME.
Oracle recommends applying the latest ISG consolidated patch described in Section 4.
After applying the latest ISG consolidated patch, you need to follow the steps
in Section 4.1 and Section 4.2 to reconfigure Oracle E-Business Suite for ISG SOAP
services. If you opt to apply the patch at a later point of time, ensure to follow the
steps listed below:
a. Import Oracle E-Business Suite certificates to a new jdk truststore by

following the instructions as described in step 2 of Section 4.2 in this
document.
b. Update isg_contextfile.properties from
the <TEMP>/appsutil/<CONTEXT>/bpel directory by adding the following:
#<DBSID>.ISG_FMW_VERSION=12C
<DBSID>.ISG_FMW_VERSION=12C
Provide a new Oracle SOA Suite 12c Oracle Home

for ISG_SOA_ORACLE_HOME as:
(For Windows, provide an absolute path with forward slash instead of back
slash, for example, C:/fmwhome/oracle_soa.)
#ISG_SOA_ORACLE_HOME=<NEW_12C_SOA_ORACLE_HOME>
ISG_SOA_ORACLE_HOME=/u01/Oracle/Middleware12212/Oracle_Home/soa
c. Perform the following tasks to run the txkISGConfigurator.xml setup script:
Note: If your Oracle SOA Suite instance is configured with multiple nodes
or in a cluster, you may have a separate domain home directory for Oracle
SOA Suite administration and managed servers. Perform this step for each
domain home directory of the Oracle SOA Suite administration and
managed servers.
 First, run txkISGConfigurator.xml setup on the

SOA node SOAHOST2 (secondary nodes). When prompted, provide
target type as "cluster", and select "No" when prompted to stop the
WebLogic servers.
 Then, run txkISGConfigurator.xml setup on the
SOA node SOAHOST1 (primary node). When prompted, provide
target type as "cluster", and select "Yes" when prompted to stop the
WebLogic servers.
 Change to Bash shell and source the following files:

source <NEW_12C_WL_HOME>/server/bin/setWLSEnv.sh
Note that <NEW_12C_WL_HOME> is the new Oracle SOA Suite 12c

WebLogic Home; <DOMAIN_HOME> is the existing ISG-SOA domain
home.
 Start the Oracle SOA Suite administration and managed servers from

the command prompt if they are not in running state prior to
performing the next step. If Oracle SOA Suite is configured for
multiple SOA nodes, ensure the SOA load balancer and node managers
are up and running.
 Ensure that no changes are active on the Oracle SOA Suite
administration and managed servers before running
the txkISGConfigurator.xml script using the following command from
the <TEMP>/appsutil/<CONTEXT>/bpel folder:
ant -f txkISGConfigurator.xml setup
Respond as shown below to the various prompts that appear:
 Enter Oracle WebLogic Server Administration Console URL

(host:port) :

server's <host>:<port>. For
example, host01.example.com:7001.
Note: For Oracle SOA Suite configured with multiple

nodes, if the Oracle SOA Suite WebLogic administration
server is configured with virtual host, provide the virtual
host and port of that administration server.
 Enter Oracle WebLogic Server Admin User Name : [weblogic]
'weblogic' is the default Oracle WebLogic Server Admin user

name.
 Enter the password for user ${wlsuser} :
Provide the associated password for above Oracle WebLogic

Server Admin user name.
 Enter the absolute path to the DBC File :
Enter the path to the DBC file: <DBC>/<sid>.dbc
 Enter the EBS database SID : [<EBS DB SID>]

Accept the default value. If the default value is empty, provide
Oracle E-Business Suite database SID as defined in Oracle E-
Business Suite applications context file.
 Enter the target type : ([server], cluster)
If Oracle SOA Suite is in a single node setup environment,

press the [Enter] key for the default selection of 'server'.
Otherwise, enter "cluster" for Oracle SOA Suite in multi-node
setup.
 Enter the SOA Server Name : [soa_server1]
If "server" is selected as the target type, then [soa_server1] is

shown. If "cluster" is selected as the target type, then
[soa_cluster] is displayed instead.
Provide the Oracle SOA Suite managed server name, such

as soa_server1, or soa_cluster.
 The script will forcefully stop the Oracle WebLogic Servers

now. Do you want to proceed (yes/no)?
If Oracle SOA Suite is in a single node setup environment,

enter yes to stop the server. If it is in a multi-node environment,
 When the script is run in a secondary node, enter No.

 When the script is run in the primary node, enter yes to
stop the server.
Note: This ant -f txkISGConfigurator.xml
setup command performs the following tasks:
 Copy isgmjf.jar to $
{WL_HOME}/server/lib/mbeantypes/isgmjf.jar.
 Copy fndext.jar to $
{DOMAIN_HOME}/lib/fndext.jar.
 Create isg.properties
and update it with required values.
 Update setSOADomainE
nv.sh script to set the context file in the
JAVA_OPTIONS.
 Copy soamon.jar to
the $ORACLE_SOA_HOME/soa/modules/oracle.soa.ext
_11.1.1 directory. Rebuild oracle.soa.ext.jar by
running build.xml.
After running the txkISGConfigurator.xml
setup command, isg.properties will have the following
default values for optional scheduler properties:
 ISG_SCHEDULER_CONFIG
_FILE = DEFAULT
 ISG_SCHEDULER_LOG_EN
ABLED = false
To start the scheduler, ISG_SCHEDULER_CONFIG_FILE property

needs to be set to DEFAULT. It indicates that the default
scheduler configuration file will be used.
The value for property ISG_SCHEDULER_LOG_ENABLED is case

sensitive. Value can be either "true" or "false". The
property ISG_SCHEDULER_LOG_ENABLED needs to be set to 'true'
only when you need scheduler logs to be written. It is
written to a file "ISGScheduler.log" in the ISG temporary
directory location.
If the following error occurs while running the command,

then Oracle SOA Suite servers may not be stopped. Please
stop the servers and try it again.
"Unable to rename old file (%FMW_HOME

%\Oracle_SOA1\soa\modules\oracle.soa.ext_11.1.1\oracl
e.soa.ext.jar) to temporary file."
 Start the Oracle SOA Suite administration and managed
servers from the command prompt if they are not in
running state prior to performing the next step.
 Ensure that no changes are active on the Oracle SOA
Suite administration and managed servers before
running txkISGConfigurator.xml
updateSecurityRealms using the following commands
from the <TEMP>/appsutil/<CONTEXT>/bpel folder:
Note: In a multi-node environment, this script should be run on the SOA

node SOAHOST1 (primary node).
source <NEW_12C_WL_HOME>/server/bin/setWLSEnv.sh
ant -f txkISGConfigurator.xml updateSecurityRealms -DauthenticatorName=isgauth1
 Stop and restart all Oracle SOA Suite administration

and managed servers from the command prompt.
Ensure to source setDomainEnv.sh before starting the
servers.
Note: Follow the sequence mentioned in this section to stop the servers

(step 2b) and restart the servers (step 2f) for a multi-node environment.
If Oracle SOA Suite is configured with multiple nodes or in a cluster,

ensure the load balancer and node manager are up.
ii. After the upgrade, verify the setup for SOAP services as described in Section 5.
Note: For troubleshooting information, refer to Troubleshooting the Upgrade, Oracle

Fusion Middleware Upgrading SOA Suite and Business Process Management.
Section 11: Performing Post-Oracle E-Business Suite Database Upgrade

Tasks for ISG-Configured Instances
When your Oracle E-Business Suite is configured for Oracle E-Business Suite Integrated
SOA Gateway (ISG) and your database is upgraded, you need to perform some setup tasks to
ensure Oracle E-Business Suite SOAP services provided through ISG work properly. These
post-upgrade tasks are required to be performed on Oracle E-Business Suite and Oracle SOA
Suite for SOAP services:
 Section 11.1: Setup Tasks on Oracle E-Business Suite

 Section 11.2: Setup Tasks on Oracle SOA Suite
 Section 11.3: Validating the Setup for Post-Database Upgrade
Note: If your Oracle E-Business Suite is configured for REST services and your database
is upgraded, there is no additional setup task specifically for REST services. However,
you need to validate the existing REST services setup by following the instructions
in Section 11.3 to ensure that REST services work as expected.
Section 11.1: Setup Tasks on Oracle E-Business Suite
Perform the following steps to set up tasks on Oracle E-Business Suite:
1. Apply Patch 31764501:R12.OWF.C, if not already applied.

2. Regenerate the DBC file by running the following command from Oracle E-Business
Suite to register the external Oracle SOA Suite server with the Oracle E-Business
Suite:
ant -f $JAVA_TOP/oracle/apps/fnd/bpel/util/txk_integration_packager.xml createDBC
-DFMWNodeName=<SOAHOST.DOMAIN> -DFMWIpAddress=<SOA_SUITE_IP>
This script will generate a desktop DBC

file, $JAVA_TOP/oracle/apps/fnd/bpel/util/<SID>_<SOAHOST.DOMAIN>.dbc.
Tip: To obtain the Oracle SOA Suite IP address for parameter "-
DFMWIpAddress", log on to Oracle SOA Suite from backend, and then run the
command ping <SOAHOST> to fetch the information.
The txk_integration_packager.xml script updates the fnd_nodes table with the IP
address of Oracle SOA Suite specified in the input parameter "-DFMWIpAddress"
which can be verified using the following query:
select node_name,server_address,server_id from fnd_nodes where
node_name=UPPER('<SOAHOST.DOMAIN>');
Note: If there are two nodes for external Oracle SOA Suite, run the following
command for each node. For example,
-DFMWNodeName=<SOANODE1.DOMAIN> -DFMWIpAddress=<SOA1_SUITE_IP>

-DFMWNodeName=<SOANODE2.DOMAIN> -DFMWIpAddress=<SOA2_SUITE_IP>
Each command will generate a DBC file. The desktop DBC file should be copied
to the respective node as mentioned in Step 3 of the Section 11.2: Setup Tasks on
Oracle SOA Suite.
3. To restrict access to Oracle E-Business Suite database from external nodes, various
tasks should be performed based on your upgraded Oracle E-Business Suite database.
a. For an Oracle RAC database with grid listener:
Note: This step applies to an Oracle E-Business Suite database upgraded

to 19c, 12c, or an earlier release.
i. Update sqlnet.ora in the Grid home of each database node,
with the following properties:
es>)
ii. Stop the database listener from the Grid home using the
following command:
srvctl stop listener
iii. Stop the scan listener from the Grid home using the following
command:
srvctl stop scan_listener
iv. Start the database listener from the Grid home using the
following command:
srvctl start listener
v. Start the scan listener from the Grid home using the following
command:
srvctl start scan_listener
b. For an Oracle RAC database with local listener, perform the following steps
on each database node. In an upgraded environment that does not use Oracle
RAC, follow the steps in a database node:
i. If you have upgraded Oracle E-Business Suite database to 19c,

perform the following tasks:
i. Source the PDB database tier environment file.
source <RDBMS ORACLE_HOME>/<PDB_SID>_<HOSTNAME>.env
ii. Run AutoConfig on the database tier.

iii. Verify that $TNS_ADMIN/sqlnet.ora contains the following

properties:
es>)
ALLOW_RESTRICTED.
iv. Source the CDB database tier environment file.

source <RDBMS ORACLE_HOME>/<CDB_SID>_<HOSTNAME>.env
v. Stop the database listener using the following command:

$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/adcdblnctl.sh stop
$ORACLE_SID
vi. Start the database listener using the following command:

$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/adcdblnctl.sh start
$ORACLE_SID
ii. If you have upgraded Oracle E-Business Suite database to 12c or an

earlier release, perform the following tasks:
i. Source the database tier environment file.

source <RDBMS ORACLE_HOME>/<SID>_<HOSTNAME>.env
ii. Run AutoConfig on the database tier.

iii. Stop the database listener using the following command:

$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/addlnctl.sh stop
$ORACLE_SID
iv. Verify that $TNS_ADMIN/sqlnet.ora contains the following

properties:
es>)
ALLOW_RESTRICTED.
v. Start the database listener using the following command:

$ORACLE_HOME/appsutil/scripts/<CONTEXT_NAME>/addlnctl.sh start
$ORACLE_SID
b. Have the following files ready as you will copy them from Oracle E-Business Suite to
Oracle SOA Suite:
a. $JAVA_TOP/oracle/apps/fnd/txk/util/txkISGConfigurator.xml
b. DBC file, generated in Step 2 above for each SOA node
Section 11.2: Setup Tasks on Oracle SOA Suite
Perform the following steps to set up tasks on Oracle SOA Suite:
1. Navigate to the <TEMP> folder created on the Oracle SOA Suite server. Replace the
existing txkISGConfigurator.xml file located
at <TEMP>/appsutil/<CONTEXT>/bpel with the one from Oracle E-Business Suite
($JAVA_TOP/oracle/apps/fnd/txk/util/txkISGConfigurator.xml).
Note: For Oracle SOA Suite configured with multiple nodes, the <TEMP> folder

will be created in the shared file system as described earlier in step 4 of Section
4.2.
2. Navigate to the <DBC> folder created on the Oracle SOA Suite server for the DBC file.
Note: For Oracle SOA Suite configured with multiple nodes, the <DBC> folder will
be created in the non-shared file system on each Oracle SOA Suite node as
described earlier in step 5 of Section 4.2.
3. Copy the DBC file created as part of the step 2 of Section 11.1: Setup Tasks on Oracle
E-Business Suite from Oracle E-Business Suite
($JAVA_TOP/oracle/apps/fnd/bpel/util/<SID>_<SOAHOST.DOMAIN>.dbc) to
the <DBC> folder on the Oracle SOA Suite server.
a. Copy the DBC file <SID>_<SOAHOST.DOMAIN>.dbc to the <DBC> folder.
b. Remove existing <SID>.dbc file.
c. Rename the DBC file <SID>_<SOAHOST.DOMAIN>.dbc to <SID>.dbc.
Note: For Oracle SOA Suite configured with multiple nodes, the DBC file
is generated for each Oracle SOA Suite node. There is one-to-one mapping
of the DBC file to the Oracle SOA Suite node. The DBC file should be
copied to the <DBC> folder of the respective Oracle SOA Suite node. For
example, the <SID>_<SOANODE1.DOMAIN>.dbc file should be copied to
the <DBC> folder on Oracle SOA Suite node1. It should also be renamed
to <SID>.dbc. The <SID>_<SOANODE2.DOMAIN>.dbc file should be copied and
renamed to <SID>.dbc on Oracle SOA Suite node2.
4. Restart the data source using the following steps:
a. Log in to Oracle WebLogic Server Administration Console of Oracle SOA
Suite.
b. From Domain Structure on the left pane, navigate to ISG-SOA
Domain > Services > DataSources. The Summary of JDBC Data Sources
page appears.
c. Click <SID> data source.
d. For the <SID> data source, navigate to the Control tab.
e. Select all deployed instances of the data source and click Shutdown.
f. When prompted for confirmation, click Yes to continue.
Wait for the state to be "Shutdown" and the status of the last action to be
"Success".
g. Select all deployed instances of the data source and click Start.

h. When prompted for confirmation, click Yes to continue.
The state should be "Running" and the status of the last action should be
"Success" for all servers.
Section 11.3: Validating the Setup for Post-Database Upgrade
Perform the following validation tasks to ensure SOAP and REST services work as expected:
1. Verify and test the runtime invocation of all SOAP and REST services that were
deployed before the database upgrade.
While testing the runtime invocation of the services that were deployed before the
database upgrade, if you encounter an exception, for example:
Error while processing the execution of the XXX.XXX.XXX$XXX interaction. An error
occurred while processing the interaction for invoking the XXX.XXX.XXX$XXX. Cause:
java.sql.SQLException: invalid name pattern: XXX.XXX
Check to ensure that the XML containing parameter data matches the parameter
definitions in the XSD.
Then, perform the following tasks to redeploy your services:
a. Log in to Oracle E-Business Suite Home Page as a user who has the
FND_IREP_ADMIN role.
b. Select the Integrated SOA Gateway responsibility from the navigation menu
and then select the Integration Repository link. Click Search.
c. Locate a desired API by Name or Internal Name and click Go to run the
search. Click the API name link from the search results table. The Interface
Detail page for the selected interface appears.
d. For SOAP services, use the following steps to redeploy your SOAP service:
i. Click the "SOAP Web Service" tab. Record the deployed method
names and authentication method that will be used later.
ii. Click Reset to change the SOAP Service Status to 'Not Generated'.
iii. Once 'Not Generated" is shown as the service status, you need to
generate the SOAP service again by selecting the same method names
that you recorded earlier and click Generate.
iv. Once 'Generated" is shown as the service status, select the same
Authentication Method that you recorded earlier and click Deploy. The
SOAP Service Status should be 'Deployed | Active' once the generated
SOAP service is successfully deployed.
v. Test the runtime invocation again.
e. For REST services, use the following steps to redeploy your REST service:
i. Click the "REST Web Service" tab. Record the Service Alias name and
deployed method names that will be used later.
ii. Click Undeploy to change the REST Service Status to 'Not Deployed'.
iii. Once 'Not Deployed' is shown as the service status, you need to deploy
it again by entering the same Service Alias name that you recorded
earlier and selecting the same method names before clicking Deploy.
iv. Once the REST service is successfully deployed with 'Deployed'
status, you can test the runtime invocation again.
2. Verify design-time operations for REST and SOAP services.
For REST services validation, see Section 2: Validating Oracle E-Business Suite

Integrated SOA Gateway Setup for REST Services.
For SOAP services validation, see Section 5: Validating Oracle E-Business Suite
Integrated SOA Gateway Setup for SOAP Services.
CHANGE RECORD
Date Description
December  Added Document 2675815.1 reference in the second Note box.
03, 2020
 Updated the entire Section 2 and removed Section 2.1: Validating
REST Services Setup from the Integration Repository User Interface
 Updated step 1 in Section 5 and removed Section 5.1: Validating
SOAP Services Setup from the Integration Repository User Interface
 Updated the first parameter description in both "Oracle SOA Suite in
Multiple Nodes" and "Oracle SOA Suite in a Single Node"
September
subsections of Step 1b (vi) in Section 4.1
29, 2020
 Updated the setup script and "soaAdminUrl" parameter description in
step 9c of Section 4.2
 Removed file logging information in Section 4.1 (steps 3, 4, and the
note in step 5), Section 4.2 (step 10), and Section 8 (step 7)
 Resequenced topic headings in Part C
 Overhauled and resequenced the entire document in Section 1 (REST)

and Section 4 (SOAP)
 Replaced Patch 30205611:R12.OWF.C, ISG Consolidated Patch
(20_3_1) with Patch 31764501:R12.OWF.C, ISG Consolidated Patch
(20_3_5), in the first Note of Section 1 and Section 4, and Step 1 in
Section 11.1
 Updated Step 4 in Section 2.1 to include Business Service Objects as
REST services
September  Replaced Patch 31103870 with Patch 31783707 (for Oracle SOA
25, 2020 Suite 12.2.1.4) and replaced Patch 30204255 with Patch 31764510
(for Oracle SOA Suite 12.2.1.3 or earlier) in Step 7, Section 4.2
 Removed the following sections:
o Section 7: Configuring Integration Repository Parser for
Custom Interfaces
o Section 9: File Logging for SOAP Services
 Added Oracle E-Business Suite 12.2.10 readme reference in Section 8
and Section 10
September  Updated the isg.properties file directory in Section 9

09, 2020
 Updated parameter descriptions in "Oracle SOA Suite in Multiple
Nodes" and "Oracle SOA Suite in a Single Node" subsections of Step
September 1b in Section 1.1
02, 2020  Updated Step 6, Step 8, and Step 9 (first Note and substep c) in
Section 1.2
 Updated Step 8 in Section 1.2
August 21,
 Added a Note at the end of Step 1 in Section 2
2020
 Corrected the -DauthenticatorName parameter value in step 3e,

July 09,
Section 3.2
2020
 Updated the 12.2 Certification Matrix table by adding Oracle SOA

Suite 12.2.1.4
 Overhauled Section 1.1, Section 1.2, and Section 2
(20_1_1), with Patch 30205611:R12.OWF.C, ISG Consolidated Patch
(20_3_1) in the first Note of Section 1 and Section 2, and Step 1 in
Section 13.1
 Replaced Patch 29832529 with Patch 31103870 (for Oracle SOA
July 08,
Suite 12.2.1.4) and Patch 30204255 (for Oracle SOA Suite 12.2.1.3 or
2020
earlier) in Step 7, Section 1.2
 Removed Section 3: Enabling ASADMIN User with the Integration
Administrator Role
 Added Section 7.1: Installing Perl Modules on Linux
 Updated Step 2 and Note in Section 13.1
 Corrected Oracle E-Bus in ess Suite Release 12.2.5 reference
information in step 1, Section 10 and Section 12

(20_1_1) in the first Note of Section 1 and Section 2
January 06,  Updated Step 7 in Section 1.1
2020  Updated Step 7, Step 12, and Step 14 in Section 1.2
 Added new Section 14: Performing Post-Oracle E-Business Suite
Database Upgrade Tasks for ISG Configured Instances

and Section 13
 Updated "ISG Release 12.2 Certification Matrix" by removing Oracle
August 16,
SOA Suite 11g (11.1.1.6.0) and 11g (11.1.1.7.0) from the matrix table
2019
and removed Step 15 about Oracle SOA Suite (11.1.1.6.0) from
Section 1.2

(19_3_1) in the first Note of Section 1 and Section 2
July 5, 2019
 Replaced Patch 28785464 with Patch 29832529 in step 11, Section
1.2
May 27,  Updated first Note in Section 2 about Patch 29555671:R12.OWF.C

2019
 Updated first Note in Section 2 by adding Patch

April 6,
29555671:R12.OWF.C
2019

(19_1_5), in the first Note of Section 1 and Section 2
March 7,  Updated Section 12 by including the postclone feature for REST
2019 services
1.2

October 5,
and Section 13
2018
 Added Oracle SOA Suite 12.2.1.3.0 in the ISG Release 12.2

Certification Matrix table
 Added a new Note right before Part A about the naming convention
mentioned in ISG consolidated patch description
August 1,  Replaced Patch 27913724:R12.OWF.C, ISG Consolidated Patch
2018 (18_2_2), with Patch 27949145:R12.OWF.C, ISG Consolidated Patch
1.2

May 1, 2018
 Replaced Patch 27498317:R12.OWF.C with Patch

27730717:R12.OWF.C, ISG Consolidated Patch (18_2_1), in the first
Note of Section 1 and Section 2
April 21,
 Added a new Section 5 for enabling TLS on Oracle SOA Suite
2018
1.2
 Updated Section 1.2, steps 3, 12, 13, 14, and 18

February 23,  Added a new section 4.2 for upgrading Oracle SOA Suite 11g to
2018 Oracle SOA Suite 12c
February 13,  Replaced Patch 24329622:R12.OWF.C with Patch

2018 27498317:R12.OWF.C, ISG Consolidated Patch (18_1_3), in the first
Note of Section 1 and Section 2
1.2

24329622:R12.OWF.C, ISG Consolidated Patch for Release 12.2
September (17_3_5), in the first Note of Section 1 and Section 2
21, 2017  Replaced Patch 26260293 with Patch 25295369 in step 11, Section
1.2
 Added the ISG Release 12.2 Certification Matrix in the beginning of

this document
 Updated the first note in Section 2 to include information about
September
Concurrent Programs as REST services
08, 2017
1.2 for Oracle E-Business Suite Release 12.2.7
April 18,  Updated step 2, Section 11

2017
March 6,  Updated the second Note in step 4, Section 2
2017
February 8, 24787334:R12.OWF.C, ISG Consolidated Patch for Release 12.2
2017 (17_1_3), in the first Note of Section 1 and Section 2

December 25188060:R12.OWF.C, ISG Consolidated Patch for Release 12.2
16, 2016 (16_4_5), in the first Note of Section 1 and Section 2
 Updated Section 4 by adding Oracle SOA Suite 12c installation

reference information
September
15, 2016
1.2 for Oracle E-Business Suite Release 12.2.6
 Updated the second Note and Section 4 by including Oracle SOA

August 18,
Suite 12c (12.1.3) with Oracle E-Business Suite Release 12.2
2016
August 8,  Added a Note in Section 3

2016
 Updated the second Note and Section 4 by including Oracle SOA
July 14,
Suite 12c (12.2.1) with Oracle E-Business Suite Release 12.2
2016
June 10,  Replaced Patch 22328483:R12.OWF.C with Patch

2016
23510855:R12.OWF.C in the first Note of Section 1 and Section 2
April 14,  Updated the second Note and Section 4 by including Oracle E-
2016 Business Suite Release 12.2.3 with Oracle SOA Suite 12c (12.1.3)
December  Replaced Patch 20512031:R12.TXK.C, Patch 17765665:R12.OWF.C,

17, 2015 and Patch 20881938:R12.OWF.C with Patch 22328483:R12.OWF.C
in the first Note of Section 1 and Section 2
 Replaced Patch 21304361, Patch 20882039, and Patch 17765676 with
Patch 22075986 in step 11, Section 1.2
 Added the Oracle WebLogic Server 12c version 12.2.1 to the first
Note in the Oracle E-Business Suite SOAP Services heading
 Updated Section 6.2 by removing Oracle E-Business Suite Release
12.2.3, Release 12.2.4, and Release 12.2.5 sub-headings when
validating REST service setup using a script
October 16,  Added Patch 21304361 in Section 1.2, step 11 for Oracle E-Business
2015 Suite Release 12.2.5
August 18,  Replaced Patch 20635091.R12.OWF.C with Patch

2015 20881938:R12.OWF.C in Section 1 and Section 2
 Replaced Patch 20504227 with Patch 20882039 in Section 1.2, step
11
July 6, 2015  Updated "Preparation for Oracle SOA Suite in a Multi-node

Environment" heading in Section 1
June 19,  Updated note content in Section 1.2, step 12

2015
May 12,  Added multi-node diagrams in Part A for SOAP services and Part B
2015 for REST services
April 10,  Removed Section 2: Configuring Oracle E-Business Suite Integrated

2015 SOA Gateway for SOAP Services on New Installation of Release
12.2.2
 Added multi-node setup information in Part A and Part B
 Moved upgrading and cloning scenarios to Section D
March 13,  Added Patch 20635091:R12.OWF.C in Section 1 and Section 5 for

2015 Oracle E-Business Suite Release 12.2.4
 Updated Section 1.2 by replacing 12.2.4 ISG Patch 1885244 with
Patch 20504227
November  Added Patch 17765665:R12.OWF.C in Section 1 and Section 5 for
20, 2014 Oracle E-Business Suite Release 12.2.3
 Updated Section 1.2 by replacing 12.2.3 ISG Patch 17507959 with
Patch 17765676
 Updated Section 11 about the ISG_CLEAR_JPUB_CACHE property
November 7,  Updated step 13, Section 1.2: Configuration Steps on Oracle SOA
2014 Suite to Integrate with Oracle E-Business Suite
August 8,  Added Section C to include common steps for both SOAP and REST
2014 services for Release 12.2.4
 Updated the Overview section and section 1 for Release 12.2.4
February 4,  Added step 2 in Section 8, Configuring Oracle E-Business Suite

2014 Integrated SOA Gateway for REST Services
December  Updated the Overview section, and added configuration steps for
13, 2013 SOAP (Part A) and REST (Part B) services for Release 12.2.3
October 3,  Updated the first Note in the Overview section

2013
September  Initial publication
19, 2013
Copyright © 2013, 2020, Oracle and/or its affiliates.

Installing Oracle E Integrated SOA Gateway

Uploaded by

Copyright:

Available Formats

Installing Oracle E Integrated SOA Gateway

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Installing Oracle E Integrated SOA Gateway

Uploaded by

Copyright:

Available Formats

Installing Oracle E-Business Suite Integrated SOA Gateway, Release 12.

Note: To provide high availability of Oracle E-Business Suite services, Oracle

 Document 2675815.1, Configuring Oracle E-Business Suite Integrated SOA

There is a change record at the end of this document.

Configuration Tasks In This Document

 Section 3: Performing Prerequisites Tasks for

Part C: Configuring Oracle E-  Section 7: Configuring Oracle E-Business Suite

 Document 2693640.1: Oracle E-Business Suite Integrated SOA Gateway Release

Section 1: Configuring Oracle E-Business Suite Integrated SOA Gateway

 My Oracle Support Knowledge Document 1617461.1, Applying the Latest AD and

Apply the consolidated Patch 31764501:R12.OWF.C, ISG Consolidated Patch for Release

Enter 'R' for the run file system.

b. Run the following script:

The script prompts you to enter the following information:

 Enter the password for APPS user:

'APPS' is the default Oracle E-Business Suite database user name.

 Enter Oracle E-Business Suite's WebLogic Server Admin User Name:

'weblogic' is the default Oracle WebLogic Server Admin user name.

 Enter the password for weblogic user:

Provide the associated password for above Oracle WebLogic Server

Note: The above script creates and deploys the data source

Section 2: Validating Oracle E-Business Suite Integrated SOA Gateway

 Perform the design-time activities through the backend script

1. Source the applications run file system environment file:

Enter 'R' for the run file system.

2. Run the following command and verify the reports generated

http(s)://<EBS host name>:<port>/webservices/rest/provider/isActive/

When prompted, provide Oracle E-Business Suite System Administration user

Part B: Configuring Oracle E-Business Suite SOAP Services

ISG Release 12.2 Certification Matrix

ISG Release 12.2 Product Dependencies and Certificati

Preparing Oracle E-Business Suite in a Multi-node Environment

Oracle E-Business Suite environments can be scaled up to handle large numbers of

This section includes the following topics:

 Section 3: Performing Prerequisites Tasks for SOAP Services:

Section 3: Performing Prerequisites Tasks for SOAP Services

Preparing Oracle SOA Suite in a Multi-node Environment

 Ensure to install Oracle WebLogic Server as part of the "Install Fusion

For Oracle WebLogic Server installation, refer to Oracle Fusion Middleware

 Install Oracle WebLogic Server as part of the "Install an Application Server"

For an existing Oracle SOA Suite installation:

Section 3.2: Enabling TLS on Oracle SOA Suite

c. Submit the CSR to CA.

keytool -import -alias intermediate -trustcacerts -file interCA.pem -keystore

keytool -import -alias mykey -trustcacerts -file serverCert.crt -keystore

In the Administration Console, expand Environment and then

Select the Configuration tab, then the General subtab and then select

b. Select the Keystores subtab under the Configuration tab.

By default Oracle WebLogic Server will look for this

 Custom Identity Keystore Type : jks

By default Oracle WebLogic Server will look for this

Enter the following information:

1. Private Key Alias: Enter <your_certificate_alias>, such as mykey.

Select the hostname verification as 'None' if the CN of the certificate is

 Additionally, to enforce TLSv1.2 only on Oracle SOA Suite, add the

Restart Oracle SOA Suite servers.

 Verify your TLS configuration.

 If you are configuring the Oracle SOA Suite administration server,

Section 4: Configuring Oracle E-Business Suite Integrated SOA Gateway

 My Oracle Support Knowledge Document 1617461.1, Applying the Latest AD and