Introduction
This document outlines the procedure for managing REST service configurations in Oracle E-Business Suite (EBS) using the Ant utility. It details the steps for downloading (exporting) and uploading (importing) REST service descriptors within the Integrated SOA Gateway (ISG), typically used to migrate services across environments such as DEV, TEST, and PROD.
Scope
The Ant utility in Oracle EBS R12.2 is like the FNDLOAD utility, but for integrations. While FNDLOAD moves setup data and configurations between environments, Ant manages and deploys REST and SOAP service descriptors for ISG integrations – helping automate and streamline web service deployments…
Procedure
Download (Export) REST Service Configuration
Export all REST (and optionally SOAP) service configurations from the current environment into an XML file.
$ ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml DownloadConfiguration
This command exports the ISG configuration and generates a service descriptor XML file, typically saved in :-
Output Example: /u01/apps/fs_ne/inst/TEST_ebs1/soa/ISGConfiguration.xml
This file contains details of all published REST services and can be used for deployment to another instance.
Upload (Import) REST Service Descriptor
Import the downloaded REST service descriptor XML file into another EBS environment.
Copy the file to a secure staging location for transport to target instance (use scp/sftp):
scp /u01/apps/…/ISGConfiguration.xml ops@target-host:/u01/TEST/
Upload (Import) descriptor into target instance
Run the Ant target with verbose logging:
ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/isgDesigner.xml -Dfile=/u01/apps/fs_ne/inst/TEST_ebs1/soa/ISGConfiguration.xml -Dverbose=ON
Post-upload verification
- Log in to EBS and navigate:
Integrated SOA Gateway → Integration Repository
Search for several representative services (by name) that were in the descriptor.
Confirm:
Interface Type = REST
Status = Deployed/Enabled (or the expected status per your deployment policy)
Endpoints reflect target environment URLs (if edited)
Run a quick functional smoke test for 1–2 critical REST endpoints (curl or Postman) to confirm runtime behavior:
curl -i -X GET “https://<target-host>/isg/rest/<service>” -H “Accept: application/json”
Check EBS/ISG logs for runtime errors (location depends on your patch level; common places: $FND_TOP/log, WebLogic server logs, or OHS access/error logs).
Conclusion
Managing REST services through the Ant utility simplifies deployment and migration in Oracle E-Business Suite. It ensures consistency, reduces manual errors, and enables easy transfer of service configurations across environments. Using the Download Configuration and upload Service targets provides a reliable and automated approach for ISG service management.
