Configuring Oracle E-Business Suite REST Services in EBS R12.2.10

 Hi All,

in this post we will learn how to configure REST services in EBS R12.2.10.

• Section 1: Configuring Oracle E-Business Suite Integrated SOA Gateway for REST Services

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 34766982:R12.OWF.C, ISG Consolidated Patch for Release 12.2 (23_1_1), 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.

1. Source the applications run file system environment file:

   source <EBS_INSTALL_BASE>/EBSapps.env

   Enter 'R' for the run file system.

2. 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:

1. (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 3 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:

   source <EBS_INSTALL_BASE>/EBSapps.env

   Enter 'R' for the run file system.
   

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 Implementation Guide.

Thanks,

Srini

Test FND_USER_PKG Rest API using any REST client like Postman

 Hi All,

In this post we will learn how to test FND_USER_PKG Rest API using any REST client like Postman In EBS R12.2

Steps to test FND_USER_PKG from REST client:

Get the WADL URL from View WADL link of the deployed REST web service. Below WADL URL format is from View WADL link resource base and resource path of the method to be tested 

http(s)://<hostname>:<port>/webservices/rest/<aliasname>/testusername/

Replace the URL with hostname, port and alias name from the deploed web service in the EBS Integration repository

Test the FND_USER_PKG rest service using RESTClient as follows:

1. Open RestClient

2. Enter the following parameters:

Method = POST

URL = http(s)://<hostname>:<port>/webservices/rest/<aliasname>/testusername

<hostname>:<port> EBS application hostname and port

<aliasname> is the alias that you entered when you generated the service

testusername is the method that you want to test from FND_USER_PKG service

** FND_USER_PKG should be already deployed as a REST web service in Integration Repository

3. Enter the following Headers:

Basic Authentication:

Username = SYSADMIN or ASADMIN or any username depending on your configuration

Password = pwd of the login user

 

Request Header:

Name = Content-Type

Value = application/json

 

Under Body tab, provide the input payload as below:

Input payload for JSON-based REST Message

---------------------------------------------------

{"TESTUSERNAME_Input":{

"RESTHeader":{

"Responsibility":"SYSTEM_ADMINISTRATOR",

"RespApplication":"SYSADMIN",

"SecurityGroup":"STANDARD",

"NLSLanguage":"AMERICAN"

},

"InputParameters":{

"X_USER_NAME":"SYSADMIN"

}

}}

 

4. Click on SEND button and your response if successful will be as below with status: 200 OK

Response for JSON-based REST Message

--------------------------------------------------

{

"OutputParameters": {

"@xmlns": "http://xmlns.oracle.com/apps/fnd/rest/testRest/testusername/",

"@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",

"TESTUSERNAME": "2"

}

}

Thanks,

Srini