Installing Oracle E-Business Suite Integrated SOA Gateway in R12.2

Error 1:

When generating REST API from Integrated SOA Gateway

Oracle E-Business Suite Integrated SOA Gateway is not configured for SOAP Services. Please refer My Oracle Support Note 1311068.1 to configure for SOAP Services.

Solution:

The reason for this error is SOA Gateway is not configured. We need to configure the OSA Gateway for publishing REST API. For this follow below steps

Installing Oracle E-Business Suite Integrated SOA Gateway, Release 12.2 (Doc ID 1311068.1)

Configuring Oracle E-Business Suite Integrated SOA Gateway for REST Services

Perform the following tasks to configure Oracle E-Business Suite Integrated SOA Gateway for REST services.

1. Enable ASADMIN user with the Integration Administrator role (or the Integration Repository Administrator role in Release 12.2.3).

Refer to Section 3: Enabling ASADMIN User with the Integration Administrator Role for details.

Section 3: Enabling ASADMIN User with the Integration Administrator Role

Use the following steps to enable ASADMIN user with the Integration Administrator role (or the Integration Repository Administrator role in Oracle E-Business Suite Release 12.2.3 and earlier releases):

1. Log in to Oracle E-Business Suite as a SYSADMIN user and enter the associated password.
2. Expand the User Management responsibility from the main menu of the Oracle E-Business Suite Home Page.
3. Click the Users link to open the User Maintenance page.
4. Enter 'ASADMIN' in the User Name field and click Go to retrieve the 'ASADMIN' user.
5. Click the Update icon next to the 'ASADMIN' user to open the Update User window.
6. Remove the Active To date field and click Apply.
7. Click Reset Password next to the 'ASADMIN' user to open the Reset Password window. Make sure that the ASADMIN's password is at least eight characters long.

Note: Before resetting the password, ensure that the MANUAL_PWD_RESET profile option is enabled.

8. Enter new password twice and click Submit.

Important: After you have completed the setup tasks for Oracle E-Business Suite Integrated SOA Gateway, do not change the 'ASADMIN' user password. Otherwise, you would have to perform the setup tasks again.

9. In the Update User window, click Assign Roles.
1. In the search window, select Code from the Search By drop-down list and enter "UMX|FND_IREP_ADMIN" in the value text box.
2. Click Select.
3. Enter a justification in the Justification field and click Apply. You will see a confirmation message indicating you have successfully assigned the role.

Return to your perspective section to continue your configuration.

2. Create a folder called <ISG_TEMP> in Oracle E-Business Suite. This folder should have write permission.

Note: If your Oracle E-Business Suite instance is configured with multiple nodes, the <ISG_TEMP> folder should be created in the shared file system. All Oracle E-Business Suite nodes should have access to this folder.

3. In the $INST_TOP/soa/ folder, update ISG_TEMP_DIRECTORY_LOCATION property in the isgagent.properties file as follow:

<SID>.ISG_TEMP_DIRECTORY_LOCATION=<ISG_TEMP>

Note: If your Oracle E-Business Suite instance is configured with multiple nodes, perform this step in the $INST_TOP/soa/isgagent.properties file in each Oracle E-Business Suite node.

4. Run the txkISGConfigurator.xml utility with “ebsSetup” argument. The script will stop and restart the servers.

Note: If your Oracle E-Business Suite instance is configured with multiple nodes, perform this step in the Oracle E-Business Suite primary node.

For example,

ant -f $JAVA_TOP/oracle/apps/fnd/txk/util/txkISGConfigurator.xml ebsSetup -DforceStop=yes

The following prompts appear:

• Enter the password for user APPS:

Provide the associated password for the user name APPS.

• Enter the ASADMIN user name : [ASADMIN]

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

• Enter the password for user ASADMIN :

Provide the associated password for the user name ASADMIN.

• The script will forcefully stop the Oracle WebLogic Server now. Do you want to proceed (yes/no)? (yes, no)

Enter yes to stop the server. The script will stop the server and then restart the server.

Note: The above script creates and deploys the data source "OAEADatasource" on Oracle E-Business Suite WebLogic Admin server and 'oafm_cluster1' server. It also creates the Authentication Provider "IsgAuthenticator" to be used by the REST services and stops the Weblogic Admin Server after accepting a confirmation from the user. Note that apart from ISG, the data source "OAEADatasource" is used by other Oracle E-Business Suite edge applications. You will have to size up the data source connection pool accordingly. If the data source "OAEADatasource" is already created, use the -DforceDataSourceExists=true option to replace the existing data source. To proceed the setup without re-creating or overwriting the data source, use the option -DignoreDataSourceExists=true. Use the option -DforceAuthenticationProviderExists=true to re-create the Authentication Provider.

5. Execute 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 10 described in Section 1.1: Setup Tasks on Oracle E-Business Suite Release 12.2.3 or Higher for details.

Important: If SOAP services are also used, complete the entire setup tasks for both SOAP and REST services before executing the adop phase=fs_clone command. For information on configuring Oracle E-Business Suite SOAP services, refer to Section A: Configuring Oracle E-Business Suite SOAP Services.

After configuring Oracle E-Business Suite REST services, validate the setup by following steps described in Section 6: Validating Oracle E-Business Suite Integrated SOA Gateway Setup for REST Services.

 Error2:

ASadmin is not configured:

Solution: this happens when you publish the REST API sometimes, even after ASAMIN is configured. For this just rerun the step 2.

Error3:

When generating iLDT file gor a package we get below error message

-bash-4.1$  $IAS_ORACLE_HOME/perl/bin/perl $FND_TOP/bin/irep_parser.pl -g -v -username=sysadmin PER:patch/115/sql:XX_SP_PAYROLL_PKGS.pls:12.0=XX_SP_PAYROLL_PKGS.pls

Can't locate Class/MethodMaker.pm in @INC (@INC contains: /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/perl /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/xml/orc115 /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/perl/FND/irep/repo /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/bin/ /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0 /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/site_perl/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/site_perl/5.10.0 /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/au/12.0.0/perl /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/ohs/mod_perl/lib/site_perl/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0 /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/site_perl/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/site_perl/5.10.0 /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0 /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/site_perl/5.10.0/x86_64-linux-thread-multi /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/site_perl/5.10.0 /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/site_perl .) at /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/perl/FND/irep/repo/Rep/Parser.pm line 24.

BEGIN failed--compilation aborted at /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/perl/FND/irep/repo/Rep/Parser.pm line 24.

Compilation failed in require at /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/bin/irep_parser.pl line 37.

BEGIN failed--compilation aborted at /home/applerp/R12_2_6_apps/ERPVIS/fs1/EBSapps/appl/fnd/12.0.0/bin/irep_parser.pl line 37.

find . -name "MethodMaker.pm"

Solution(Doc ID 2200014.1):

Installing Perl Modules on all UNIX platforms

Perform the following steps to install Perl modules on all UNIX platforms mentioned above:

1. Establish the Oracle E-Business Suite application environment.

From the Oracle E-Business Suite APPS_BASE, establish the run file system APPL_TOP environment by running the EBSapps.env script.

2. In both the run and patch file systems, locate the Perl configuration files that need to be modified and back up these files.

For example, on Oracle Solaris, the Config.pm is located in the following directory:

cd /home/applerp/R12_2_6_apps/ERPVIS/fs1/FMW_Home/webtier/perl/lib/5.10.0/x86_64-linux-thread-multi

$FMW_HOME/webtier/perl/lib/5.10.0/sun4-solaris-thread-multi-64

3. In both the run and patch file systems, modify the Perl configuration file Config.pm to point to the Perl directory in $FMW_HOME/webtier.

For example, on Oracle Solaris, these are the statements that need to be modified with the absolute path of $FMW_HOME/webtier/perl:

Note: <FMW_HOME> is the value of $FMW_HOME.

• archlibexp =>relocate_inc('<FMW_HOME>/webtier/perl/lib/5.10.0/sun4-solaris-thread-multi-64')
• privlibexp =>relocate_inc('<FMW_HOME>/webtier/perl/lib/5.10.0')
• sitearchexp =>relocate_inc('<FMW_HOME>/webtier/perl/lib/site_perl/5.10.0/sun4-solaris-thread-multi-64')
• sitelibexp =>relocate_inc('<FMW_HOME>/webtier/perl/lib/site_perl/5.10.0')
3. If your system is on Oracle Solaris, modify the Config.pm and Config_heavy.pl files to point to the C compiler installed as a requirement of the Integration Repository Parser. For example:

Config.pm

cc =>'/opt/SunProd/studio12u3/solarisstudio12.3/bin/cc',

libpth =>'/opt/SunProd/studio12u3/solarisstudio12.3/lib /opt/SUNWspro/WS6U1/lib/v9 /usr/lib/sparcv9 /usr/ccs/lib/sparcv9 /usr/local/lib/usr/lib /usr/ccs/lib,

Config_heavy.pl

cc='/opt/SunProd/studio12u3/solarisstudio12.3/bin/cc'

ld='/opt/SunProd/studio12u3/solarisstudio12.3/bin/cc'

5. Create a directory 'perl' in $APPL_TOP_NE where the new Perl modules will be installed. For example,

mkdir $APPL_TOP_NE/perl

chmod 755 $APPL_TOP_NE/perl

6. In the run file system, set the following environment variables in APPL_TOP environment:

1. Prepend PATH with the path to the C compiler installed as a requirement of the Integration Repository Parser.
2. Prepend PERL5LIB with $FND_TOP/perl and $APPL_TOP_NE/perl in that order.

For example, export PERL5LIB=$FND_TOP/perl:$APPL_TOP_NE/perl:$PERL5LIB.

3. Add $FMW_HOME/webtier/lib to LIBPATH if it is not present.

For example, export LIBPATH=$LIBPATH:$FMW_HOME/webtier/lib.

4. Set $FMW_HOME/webtier as ORACLE_HOME.

For example, export ORACLE_HOME=$FMW_HOME/webtier.

5. Prepend LD_LIBRARY_PATH with $ORACLE_HOME/lib32 and $ORACLE_HOME/lib.

For example, export LD_LIBRARY_PATH=$ORACLE_HOME/lib32:$ORACLE_HOME/lib:$LD_LIBRARY_PATH.

6. Set JAVA_HOME to the JDK top directory.

Obtain the path returned by 'which java' and set JAVA_HOME to the current JDK top directory.

For example, on Oracle Solaris:

which java

            /prod/EBS122/fs1/FMW_Home/jdk/jre/bin/java

export JAVA_HOME=/prod/EBS122/fs1/FMW_Home/jdk

7. Download and unzip patch 13602850 (p13602850_R12_GENERIC.zip) into a temporary area.

Patch 13602850 contains the following Perl modules:

• Compress-Raw-Zlib-2.009
• Compress-Zlib-2.009
• Class-MethodMaker-1.12

Install these modules in the order shown above using the following commands:

Note: If Perl command is not found, invoke Perl in $FMW_HOME/webtier/perl/bin/perl.

Using the Integration Repository Parser

Once the Integration Repository Parser has been installed and set up properly, you can execute the parser to generate iLDT files and then upload them to the Integration Repository if no error occurs.

Note: For an object (or class) which is present in the Integration Repository, the Integration Repository Loader program reloads the new definition of that object ONLY if the new version is greater than the current version present in the Integration Repository. If the new file version is the same or lower than the current one in the repository, then the new file will not be uploaded.

Therefore, before executing the parser, you need to increment the Header version of the target source file so that the modifications to the object defined in the source file can take effect in the Integration Repository.

The following sections explain the use of Integration Repository Parser and FNDLOAD utilities in greater detail.

Generating ILDT Files

Prerequisites - Setting Up Environment Variables

Before executing the Integration Repository Parser to generate iLDT files, set the following environment variables which may affect parser operation:

1. From the Oracle E-Business Suite APPS_BASE, establish the run file system APPL_TOP environment by running the EBSapps.env script.
2. The following environment variables affect parser operation:
• LIBPATH: Add the $FMW_HOME/webtier/lib to LIBPATH variable if it is not present. For example,

export LIBPATH=$LIBPATH:$FMW_HOME/webtier/lib

• CLASSPATH: It is used when parsing Java files. This is required to be properly set up (as if for a compile) when performing -generate with such files.

If parser is not able to find a particular class, check for its availability in CLASSPATH.

On a Linux machine, CLASSPATH can be set like setenv CLASSPATH classpath1:classpath2.

For others, refer to your platform documentation on how to set classpath variable.

• JAVA_HOME: It is used to find the Java runtime.

If JAVA_HOME is not set, obtain the path returned by 'which java' from the APPL_TOP environment, and set JAVA_TOP to the JDK top directory. For example,

• On AIX:

export JAVA_HOME=$COMMON_TOP/util/jdk32

• On Oracle Solaris:

export JAVA_HOME=$COMMON_TOP/util/jdk

• export PERL5LIB=$APPL_TOP_NE/perl/lib/5.10.0:$APPL_TOP_NE/perl/lib/site_perl/5.10.0:$FND_TOP/perl:$PERL5LIB
• For HP-UX Itanium Only

Prepend LD_LIBRARY_PATH with $FMW_HOME/webtier/lib as follows:

export LD_LIBRARY_PATH=$FMW_HOME/webtier/lib:$LD_LIBRARY_PATH

Executing the Integration Repository Parser

To generate an iLDT (*.ildt) file, execute the Integration Repository Parser using the following syntax:

$IAS_ORACLE_HOME/perl/bin/perl $FND_TOP/bin/irep_parser.pl -g -v -username=<a fnd username> <product>:<relative path from product top>:<fileName>:<version>=<Complete File Path, if not in currect directory>

Examples of generating iLDT files for custom PL/SQL APIs and custom composites of BPEL type:

• $IAS_ORACLE_HOME/perl/bin/perl $FND_TOP/bin/irep_parser.pl -g -v -username=sysadmin fnd:patch/115/sql:SOATest1S.pls:12.0=SOATest1S.pls
• $IAS_ORACLE_HOME/perl/bin/perl $FND_TOP/bin/irep_parser.pl -g -v -username=sysadmin fnd:<path>:ONT_POI_R121XB7A.bpel:12.0=<Path>/ONT_POI_R121XB7A.bpel

Note: If an error message "Java runtime not found" appears while executing the Integration Repository Parser, then set the JRE location to variable OA_JRE_TOP. JRE location could be located at $JAVA_HOME/jre, If JAVA_HOME is not set, source $FMW_HOME/wlserver_10.3/server/bin/setWLSEnv.sh file.

While executing the parser, you need to pay attention to any error messages on the console. These errors would be due to incorrect annotation or some syntax errors in the annotated file. Ensure that the annotations are correct and the file has proper syntax.

If no error occurs in the annotated interface file, an iLDT (*.ildt) file would be generated. This generated iLDT file needs to be uploaded to the Integration Repository.

See: Uploading ILDT Files to Integration Repository.