Administering Native Integration Interfaces and Services

Overview

Various Oracle E-Business Suite application interface definitions shipped with Oracle Integration repository are referred as native integration interfaces. This chapter describes the steps to transform these interface definitions into SOAP web services or REST web services.

An Oracle E-Business Suite user who has the Integration Repository Administrator role can perform administrative tasks in managing service lifecycle activities and as well as managing security grants.

To better understand how to administer and manage both SOAP and REST services, the following topics are included in this chapter:

Administering SOAP Web Services

Interfaces Supported for SOAP Service Enablement

Oracle E-Business Suite Integrated SOA Gateway supports the following interface types for SOAP-based service enablement:

Note that Java APIs for Forms web services are desupported in Oracle E-Business Suite Release 12.2. If you are planning to use this type of interfaces as web services, you are advised to use alternate serviceable interfaces, such as PL/SQL and Business Service Objects interfaces, which can be deployed as web services. Refer to My Oracle Support Knowledge Document 966982.1 for the suggested alternatives to the existing Java APIs for Forms services.

Managing SOAP Service Lifecycle Activities

Only integration repository administrators (defined by the Integration Repository Administrator role) can perform the following administrative tasks in managing each state of SOAP services throughout the entire service life cycle:

Service Generation and Deployment Process Flow

the picture is described in the document text

Note that the administrators can also manage SOAP service lifecycle activities and create security grants using manual steps, see:

Managing Other Administrative Tasks for SOAP Services

Some administrative tasks are performed outside the Integration Repository user interface. These tasks are performed in the Administration tab, next to the Integration Repository tab. The Administration tab is specifically for the administrators to perform additional administrative tasks outside the Integration Repository user interface. This tab contains the following administrative and management features:

Note: All Integration Repository Administration functions are grouped under Integration Repository Administrator permission set (FND_REP_ADMIN_PERM_SET) and performed by the users with the Integration Repository Administrator role.

For more information about the Integration Repository Administrator permission set, see Role-Based Access Control (RBAC) Security.

Generating SOAP Web Services

Oracle E-Business Suite Integrated SOA Gateway allows users who have the Integration Repository Administrator role to transform interface definitions to SOAP services.

To accomplish this goal, these interface definitions will be transformed to a machine-processable format that complies with web standards using Web Services Description Language (WSDL). The WSDL code contains operations or messages that can be bound to a concrete network protocol and message format to define web services.

Generating SOAP Services

After SOAP Service Generation

For XML Gateway interfaces with the support for SOAP services only, once the SOAP service of a selected XML Gateway interface has been successfully generated, the Web Service region appears.

Note: For XML Gateway Map interface type, you might find more than one Web Service Region available. See: Generating Web Service Region(s) for XML Gateway Map Interfaces.

For interfaces with the support for both SOAP and REST services, service generation information appears in the SOAP Web Service tab. For example, "Generated" is shown as the SOAP Service Status field in the SOAP Web Service tab.

Regenerating the SOAP Service If the Definition is Changed

If the interface definition is changed, the administrators need to regenerate the service from the Interface Details page by clicking Regenerate WSDL in the appropriate Web Service region or Regenerate in the SOAP Web Service tab. Upon regeneration, the service definition will also change to reflect the modification in the interface. The administrators will have to modify its web service clients based on the new service definition.

If interface definition is not changed, then regenerating the service would not change the service definition. The administrators can continue to use the existing web service clients, if any, with the new service definition.

Generating Web Service Region(s) for XML Gateway Map Interfaces

In supporting the Web Service Provider-based and SOA Provider-based service enablement for XML Gateway Map, if a SOAP service is successfully generated, depending on the profile value set in the FND: XML Gateway Map Service Provider profile option, you can find one of the following Web Service regions displayed in the XML Gateway interface details page:

To generate a web service:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Repository Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.

  2. In the Integration Repository tab, select 'Interface Type' from the View By drop-down list.

  3. Expand an interface type node to locate your desired interface definition.

  4. Click the interface definition name link to open the interface details page.

  5. To generate a SOAP service for a selected interface:

    • If the selected interface is an XML Gateway map that can be exposed as a SOAP service only, click Generate WSDL to generate the service. Once the SOAP service is successfully generated, an appropriate Web Service region becomes available. The Web Service Status field marked as 'Generated' also appears which indicates that this selected interface has WSDL description available.

    • If the selected interface can be exposed as both REST and SOAP services, click Generate in the SOAP Web Service tab to generate the service.

  6. Click the View WSDL link to view the WSDL description.

  7. Click Regenerate WSDL or Regenerate in the SOAP Web Service tab or Web Service region to regenerate the WSDL description if necessary.

Deploying and Undeploying SOAP Web Services

If a SOAP service has been generated successfully, the administrator has the privilege to deploy the generated service in the appropriate Web Service region or the SOAP Web Service tab if the interface can be exposed as both SOAP and REST services.

Interface Details Page with SOAP Web Service Tab

the picture is described in the document text

Note: Unlike native services that they are deployed through the Web Service region of an interface type detail page, composite services are typically not deployed within Oracle E-Business Suite like those of other service enabled interface types. You need a separate BPEL PM (SOA Suite or third party BPEL PM server) to deploy the BPEL composite services. For example, a composite service - BPEL type can be deployed through Oracle JDeveloper to a BPEL server in Oracle SOA Suite BPEL PM (Process Manager) or a third party BPEL PM in a J2EE environment. This deployed composite service - BPEL project can update Oracle Applications if necessary.

Deploying Web Services with Authentication Types

To secure web service content, Oracle E-Business Suite Integrated SOA Gateway supports multiple authentication types for inbound service requests. Prior to deploying or redeploying a SOAP service generated, an integration repository administrator must first select at least one of the following authentication types:

After you identify the preferred authentication type(s) for a web service, clicking the Deploy button deploys the web service with selected authentication type(s) from Oracle Integration Repository to Oracle Application Server. When SOA Provider receives inbound SOAP requests, the web service framework will authenticate the user who sends the SOAP request message based on the specified authentication type(s).

If no authentication type is identified for the service, then an validation error occurs requesting you to select an appropriate authentication type.

Once the web service has been successfully deployed, the Web Service Status field is changed to from "Generated" to "Deployed", along with selected authentication type check box(es). This indicates that the selected service has been successfully deployed to the application server.

For more information on supported authentication types for web service security, see Managing Web Service Security.

Reviewing Deployed WSDL

Once the web service has been successfully deployed, click the View WSDL link to view the deployed web service WSDL description. The following example shows the deployed WSDL code:

<?xml version="1.0"encoding="UTF-8" ?>
<definitions name="FNDWF_MOVE_MSGS_EXCEP2NORMAL" 
targetNamespace="http://xmlns.oracle.com/apps/owf/soaprovider/concurrentprogram/fndwf_move_msgs_excep2normal/"
xmlns:tns="http://xmlns.oracle.com/apps/owf/soaprovider/concurrentprogram/fndwf_move_msgs_excep2normal/" 
xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
xmlns:tns1="http://xmlns.oracle.com/apps/owf/soaprovider/concurrentprogram/fndwf_move_msgs_excep2normal/">
<types>
<schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" 
 targetNamespace="http://xmlns.oracle.com/apps/owf/soaprovider/concurrentprogram/fndwf_move_msgs_excep2normal/">
  <include schemaLocation="http://<hostname>:<port>/webservices/SOAProvider/concurrentprogram/fndwf_move_msgs_excep2normal/APPS_ISG_CP_REQUEST_CP_SUBMIT.xsd" /> 
</schema>
<schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" 
 targetNamespace="http://xmlns.oracle.com/apps/owf/soaprovider/concurrentprogram/fndwf_move_msgs_excep2normal/"> 
  <element name="SOAHeader">
    <complexType>
     <sequence>
      <element name=="Responsibility" minOccurs="0" type="string"/>
      <element name="RespApplication" minOccurs="0" type="string"/>
      <element name="SecurityGroup" minOccurs="0" type="string" /> 
      <element name="NLSLanguage" minOccurs="0" type="string" />
      <element name="Org_Id" minOccurs="0" type="string" /> 
     </sequence>
   </complexType>
  </element>
 </schema>
</types>
   . . .

Additionally, the following buttons are available in the Web Service region or the SOAP Web Service tab if the interface can be exposed as both SOAP and REST services:

Note: The Deploy and Redeploy buttons appear only for users who have the Integration Repository Administrator role.

To deploy, undeploy, redeploy a web service:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Repository Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.

  2. In the Integration Repository tab, select 'Interface Type' from the View By drop-down list.

  3. Expand an interface type node to locate your desired interface definition.

  4. Click the interface definition name link to open the interface details page.

  5. From the SOAP Web Service tab (or Web Service region for XML Gateway interface type), select at least one of the following authentication type check boxes:

    • Username Token

    • SAML Token (Sender Vouches)

    Click Deploy to deploy the service from Oracle Integration Repository to Oracle Application Server.

    Note: If this selected interface definition has never been generated as a web service, generate the service first and then deploy it. For information on how to generate a SOAP service, see Generating SOAP Web Services.

  6. Click the deployed View WSDL link to view the deployed WSDL description.

  7. Redeploy the service if needed by clicking Redeploy.

    Note: If changes are made to the Authentication Type field for a deployed web service, you must redeploy the service.

  8. Click Undeploy to undeploy the service if necessary.

Subscribing to Business Events

Subscribing to Business Events

For business events, users who have the Integration Repository Administrator role can find Subscribe available in the interface details page which allows the administrators to subscribe to selected business events and create subscriptions for the selected events.

Business Event Details Page

the picture is described in the document text

Clicking the Subscribe button lets you subscribe to the selected business event. Internally, an event subscription is automatically created for that event with WF_BPEL_QAGENT as Out Agent. Once the event subscription has been successfully created, a confirmation message appears on the Business Event interface detail page.

To consume the business event message, you should register to dequeue the event from Advanced Queue WF_BPEL_Q. If a business event is enabled and if there is at least one subscriber registered to listen to WF_BPEL_Q, then the event message will be enqueued in WF_EVENT_T structure to Advanced Queue WF_BPEL_Q.

Unsubscribing to Business Events

The Unsubscribe button becomes available in the business event details page if the selected event has been subscribed. Clicking the Unsubscribe button removes the event subscription from WF_BPEL_Q queue. A confirmation message also appears after the subscription has been successfully removed.

For more information on how to dequeue messages, see the Oracle Streams Advanced Queuing User's Guide and Reference.

To subscribe to a business event:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Repository Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.

  2. In the Integration Repository tab, select 'Interface Type' from the View By drop-down list.

  3. Expand the Business Event interface type node to locate your desired event.

  4. Click the business event interface that you want to subscribe to it to open the Interface details page for the event.

  5. Click Subscribe to subscribe to the selected event. Internally, an event subscription is created with Out Agent as WF_BPEL_QAGENT. A confirmation message appears after the event subscription is successfully created.

To remove the subscribed event, click Unsubscribe to remove or delete the event subscription if needed.

Managing Security Grants for SOAP Web Services Only

By leveraging Oracle User Management function security and data security, Oracle E-Business Suite Integrated SOA Gateway provides a security mechanism which only allows users who have authorized privileges to access or execute certain API methods exposed through Oracle Integration Repository. This protects application data from unauthorized access without security checks.

In this release, XML Gateway (inbound) is the only interface type that can be exposed as SOAP services only. To manage user security for XML Gateway interfaces, you need to log in to Oracle XML Gateway user interface. See Managing XML Gateway User Security in the Trading Partner User Setup Form.

Note: For interfaces that can be exposed as REST services, security grants are managed in the Grants tab of the selected interface details page. For example, PL/SQL APIs, Concurrent Programs, and Business Service Objects can be exposed as both SOAP and REST services; Java Bean Services, Application Module Services, Open Interface Tables, and Open Interface Views can be exposed as REST services only.

Note that when a method access permission is authorized to a grantee, if the selected method can be exposed as both SOAP and REST service operations, then this grants the permission to the associated SOAP and REST services simultaneously. For information on managing security grants in the Grants tab, see Managing Security Grants for SOAP and REST Web Services.

Managing XML Gateway User Security in the Trading Partner User Setup Form

For XML Gateway interfaces, user security is managed in the Oracle XML Gateway user interface through the Trading Partner User Setup form where the administrator needs to associate users with a trading partner. Only these authorized users can perform XML Gateway inbound transactions with the trading partner. Specifically, the administrator needs to:

For more information about trading partner user security, refer to Trading Partner Setup, XML Gateway Setup chapter, Oracle XML Gateway User's Guide.

Viewing Generate and Deploy Time Logs

To effectively troubleshoot any issues or exceptions encountered at design time during service generation and deployment, error messages and service activity information can be logged and viewed through the Interface Details page if logging is enabled for specific services or all services at the Site level only. Administrators can find View Log displayed in the Interface Details page.

Note: Logging is supported for SOAP services only.

Note that if logging is enabled for 'All Services' at the Site level, then View Log will be shown in the Interface Details page for all interfaces that can be service enabled. If the logging is enabled at the Site level for specific operations, then there will be no log generated and you will not find View Log in the Interface Details page. Generate and Deploy time log is only available if logging is enabled for specific services or all services at the Site level.

Note: You will not find View Log available in the Interface Details page for a given service if the logging is enabled at the user level. Only site level logging configuration with specific services or all services will have the Generate and Deploy time logs captured.

For information on how to configure logging at the site level for enabling specific services, see Enabling Logging at the Service Level.

SOAP Web Service Tab with 'View Log' Highlighted

the picture is described in the document text

Click View Log to open the Log Details page. All logs recorded for the selected service are listed in the table. Each log contains log sequence, log timestamp, module, log level, and actual message recorded at the design time.

Note: Generate and Deploy time logs might be present for a service that has the logging enabled at the site level even if no error occurs while generating (regenerating) and deploying (redeploying or undeploying) the service. For example, if log setup is done at the log level of Statement, then statement level log messages can be written and listed in the log table.

Log Details Page

the picture is described in the document text

Deleting and Exporting Logs Listed in the Log Details Page

After viewing log messages retrieved for a service in the Log Details page, you can delete them if needed by clicking Delete All. A warning message appears alerting you that this will permanently delete all the logs retrieved in the page. Click Yes to confirm the action. An empty log table appears in the page after logs are successfully deleted.

Before deleting the logs, you can save a backup copy by clicking Export. This allows you to export the records listed in the Log Details page to Microsoft Excel and save them to a designated directory and use it later.

For more logging information, see Logging for Web Services. For information on how to add a new log configuration, see Adding a New Log Configuration.

At runtime during the invocation of Oracle E-Business Suite services by web service clients, if a service has the logging enabled, log messages can be viewed in SOA Monitor against that instance. For information on viewing log messages through SOA Monitor, see Viewing Service Processing Logs.

To view Generate and Deploy time log messages:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Repository Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.

  2. In the Integration Repository tab, select 'Interface Type' from the View By drop-down list.

  3. Expand an interface type node to locate your desired interface definition.

  4. Click the interface definition name link to open the interface details page.

  5. If logs are available for this selected service that has logging enabled properly, you will find View Log available in the interface details page.

  6. Click View Log to open the Log Details page where you can view the log details.

  7. Click Delete All to delete all the logs listed in the table if needed. Click Yes to confirm the action. Click No to return back to the Log Details page.

    Click Export to export log list table to Microsoft Excel and save the records.

Administering REST Web Services

In addition to supporting SOAP-based service generation and deployment, Oracle E-Business Suite Integrated SOA Gateway allows supported interface types to become REST-based services. REST services can be used for user-driven applications such as mobile, tablet, or handheld devices. In this release, PL/SQL APIs, Concurrent Programs, and Business Service Objects can be exposed as both SOAP and REST services; Java Bean Services and Application Module Services, Open Interface Tables, and Open Interface Views can be exposed as REST services only.

Note: Security services are also REST services; however, unlike other service-enabled interfaces, they are predefined and predeployed REST services from Oracle Application Object Library. This type of services provides security related features for mobile applications. See: Supporting Security Services - Predeployed REST Services.

REST Service Life Cycle

The administrator can perform the following tasks in the REST Web Service tab to manage the REST service life cycle:

Note that the administrator can also manage these REST service activities through manual steps. See: Managing REST Service Lifecycle Activities Using Manual Steps.

The administrator can manage security grants in the Grants tab of the interface details page or through a backend script. It assigns grants to specific users to access or invoke the deployed REST services. For information on managing security grants using a script, see Managing Security Grants Using An Ant Script.

Supporting Security Services - Predeployed REST Services

In addition to exposing a supported interface as a REST service, Oracle E-Business Suite Integrated SOA Gateway supports Oracle Application Object Library's Authentication and Authorization services as REST security services. Security services are used for mobile applications to validate or invalidate user credentials, initialize user sessions with applications context, and authorize users.

Unlike other service-enabled interfaces requiring administrative actions on service development, security services are a set of predeployed REST services which can be invoked by all the Oracle E-Business Suite users.

Security services support token based authentication for invoking other REST services. With token based authentication, it is possible to authenticate a user once based on username and password, and then authenticate the user in the consecutive REST requests using a security token (such as Oracle E-Business Suite user session ID). For more information about the REST service security, see REST Service Security.

To better understand each administrative task, the following topics are included in this section:

Deploying REST Web Services

Oracle E-Business Suite Integrated SOA Gateway allows the administrator to deploy interface definitions as REST services. These interfaces are PL/SQL APIs, Concurrent Programs, Business Service Objects, Java Bean Services, Application Module Services, Open Interface Tables, and Open Interface Views. Among these interfaces, only PL/SQL APIs, Concurrent Programs, and Business Service Objects can be exposed as both SOAP and REST services.

Interface Details Page with REST Web Service Tab

the picture is described in the document text

Deploying REST Services in the REST Web Service Tab

Before deploying a REST service, the administrator must perform the following tasks:

REST Service Security

All REST services are secured by HTTP Basic Authentication or Token Based Authentication at HTTP or HTTPS transport level. Either one of the authentication methods will be used in authenticating users who invoke the REST services.

Click Deploy to deploy the selected service operations to an Oracle E-Business Suite application server for consumption.

After Service Deployment

Once the REST service has been successfully deployed, the REST Web Service tab has the following changes:

Reviewing Deployed WADL

To view the deployed REST service WADL, click the View WADL link.

The following example shows the deployed WADL for the selected CREATE_INVOICE service operation contained in the PL/SQL API Invoice Creation (AR_INVOICE_API_PUB):

Note: Note that 'Invoice' highlighted here is the service alias entered earlier prior to the service deployment. After the service is deployed, the specified alias name (Invoice) becomes part of the service endpoint in the .xsd schema file.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?> 
<application xmlns:tns="http://xmlns.oracle.com/apps/ar/soaprovider/plsql/rest/ar_invoice_api_pub/" xmlns="http://wadl.dev.java.net/2009/02"
xmlns:tns1="http://xmlns.oracle.com/apps/ar/rest/ar/create_invoice/" name="AR_INVOICE_API_PUB" 
targetNamespace="http://xmlns.oracle.com/apps/ar/soaprovider/plsql/rest/ar_invoice_api_pub/">
        <grammars>
                <include xmlns="http://www.w3.org/2001/XMLSchema" href="https://host01.example.com
:1234/webservices/rest/Invoice/?XSD=CREATE_INVOICE_SYNCH_TYPEDEF.xsd" /> 
        </grammars>
        <resources base="http://host01.example.com:1234/webservices/rest/Invoice/">
                <resource path="/create_invoice/">
                        <method id="CREATE_INVOICE" name="POST">
                                <request>
                                        <representation mediaType="application/xml" type="tns1:InputParameters" /> 
                                        <representation mediaType="application/json" type="tns1:InputParameters" /> 
                                </request>
                                <response>
                                        <representation mediaType="application/xml" type="tns1:OutputParameters" /> 
                                        <representation mediaType="application/json" type="tns1:OutputParameters" /> 
                                </response>
                        </method>
                </resource>
        </resources>
</application>

If the deployed REST service is an interface type of Java Bean Services or Application Module Services, then both GET and POST can be shown as the supported methods. For example, the following WADL description shows two Java methods contained in the Employee Information service. The getAllReports operation is implemented with the GET method, and the getPersonInfo operation is implemented with both the POST and GET HTTP methods.

<xml version="1.0" encoding="UTF-8"> 
<application name="EmployeeInfo" targetNamespace="http://xmlns.oracle.com/apps/per/soaprovider/pojo/employeeinfo/"
 xmlns:tns="http://xmlns.oracle.com/apps/per/soaprovider/pojo/employeeinfo/" 
 xmlns="http://wadl.dev.java.net/2009/02" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
 xmlns:tns1="http://xmlns.oracle.com/apps/fnd/rest/empinfo/getallreports/" 
 xmlns:tns2="http://xmlns.oracle.com/apps/fnd/rest/empinfo/getdirectreports/" 
 xmlns:tns3="http://xmlns.oracle.com/apps/fnd/rest/empinfo/getpersoninfo/">

<grammars>
        ...
</grammars>
<resources base="http://<hostname>:<port>/webservices/rest/empinfo/">
  <resource path="/getAllReports/">
        <method id="getAllReports" name="GET">
                <request>
                          <param name="ctx_responsibility" type="xsd:string" style="query" required="false" />
           <param name="ctx_respapplication" type="xsd:string" style="query" required="false" />
                                <param name="ctx_securitygroup" type="xsd:string" style="query" required="false" />
                                <param name="ctx_nlslanguage" type="xsd:string" style="query" required="false" />
                                <param name="ctx_orgid" type="xsd:int" style="query" required="false" />
                        </request>
                        <response>
                                        <representation mediaType="application/xml" type="tns1:getAllReports_Output" /> 
                                        <representation mediaType="application/json" type="tns1:getAllReports_Output" /> 
                                </response>
                        </method>
        </resource> 
 ...
 <resource path="="/getPersonInfo/ {personId}/">
  <param name="personId" style="template" required="true" type="xsd:int" /> 
        <method id="getPersonInfo" name="GET">
                <request>
                          <param name="ctx_responsibility" type="xsd:string" style="query" required="false" />
           <param name="ctx_respapplication" type="xsd:string" style="query" required="false" />
                                <param name="ctx_securitygroup" type="xsd:string" style="query" required="false" />
                                <param name="ctx_nlslanguage" type="xsd:string" style="query" required="false" />
                                <param name="ctx_orgid" type="xsd:int" style="query" required="false" />
                        </request>
                        <response>
                                        <representation mediaType="application/xml" type="tns3:getPersonInfo_Output" /> 
                                        <representation mediaType="application/json" type="tns3:getPersonInfo_Output" /> 
                                </response>
                        </method>
                </resource> 
 <resource path="/getPersonInfo/">
                <method id="getPersonInfo" name="POST">
                                <request>
                                   <representation mediaType="application/xml" type="tns3:getPersonInfo_Input" /> 
                                        <representation mediaType="application/xml" type="tns3:getPersonInfo_Output" />   
                                </request>
                        <response>
                                   <representation mediaType="application/xml" type="tns3:getPersonInfo_Input" /> 
                                        <representation mediaType="application/xml" type="tns3:getPersonInfo_Output" />
           </response>
                        </method>
                </resource>
  </resource path>
</application>

If the deployed REST service is an open interface table with Inbound direction, then the service operation table displays all four HTTP methods. In the following WADL example for the AR Autoinvoice open interface table (associated concurrent program internal name RAXMTR), the RA_INTERFACE_LINES_ALL operation is implemented with all four HTTP methods, and the associated concurrent program SUBMIT_CP_RAXMTR is implemented with the POST method.

     <?xml version = '1.0' encoding = 'UTF-8'?>
<application name="RAXMTR" targetNamespace="http://xmlns.oracle.com/apps/ar/rest/autoinvoice" xmlns="http://wadl.dev.java.net/2009/02" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns1="http://xmlns.oracle.com/apps/ar/rest/autoinvoice/RA_INTERFACE_LINES_ALL">
        <grammars>
                <include href="http://<hostname>:<port>/webservices/rest/autoinvoice/?XSD=RA_INTERFACE_LINES_ALL_post.xsd" xmlns="http://www.w3.org/2001/XMLSchema"/>
                <include href="http://<hostname>:<port>/webservices/rest/autoinvoice/?XSD=RA_INTERFACE_LINES_ALL_get.xsd" xmlns="http://www.w3.org/2001/XMLSchema"/>
                <include href="http://<hostname>:<port>/webservices/rest/autoinvoice/?XSD=RA_INTERFACE_LINES_ALL_put.xsd" xmlns="http://www.w3.org/2001/XMLSchema"/>
                <include href="http://<hostname>:<port>/webservices/rest/autoinvoice/?XSD=RA_INTERFACE_LINES_ALL_delete.xsd" xmlns="http://www.w3.org/2001/XMLSchema"/>
                <include href="http://<hostname>:<port>/webservices/rest/autoinvoice/?XSD=SUBMIT_CP_RAXMTR_post.xsd" xmlns="http://www.w3.org/2001/XMLSchema"/>
        </grammars>
  <resources base="http://<hostname>:<port>/webservices/rest/autoinvoice/">
  <resource path="RA_INTERFACE_LINES_ALL/"> 
        <method id="RA_INTERFACE_LINES_ALL_get" name="GET">
                <request>
                                <param name="ctx_responsibility" type="xsd:string" style="query" required="false"/>
                <param name="ctx_respapplication" type="xsd:string" style="query" required="false" />
                                <param name="ctx_securitygroup" type="xsd:string" style="query" required="false" />
                                <param name="ctx_nlslanguage" type="xsd:string" style="query" required="false" />
                                <param name="ctx_orgid" type="xsd:int" style="query" required="false" />
                                <param name="select" type="xsd:string" style="query" required="false"/>
                                <param name="filter" type="xsd:string" style="query" required="false"/>
                                <param name="sort" type="xsd:string" style="query" required="false"/>
                                <param name="offset" type="xsd:string" style="query" required="false"/>
                                <param name="limit" type="xsd:string" style="query" required="false"/>
                        </request>
                        <response>
                                <representation mediaType="application/xml" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                                <representation mediaType="application/json" type="tns1:RA_INTERFACE_LINES_ALL_Output" />
                                <representation mediaType="text/csv" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                        </response>
        </method>
        <method id="RA_INTERFACE_LINES_ALL_post" name="POST">
                   <request>
                                <representation mediaType="application/xml" type="tns1:RA_INTERFACE_LINES_ALL_Input"/> 
                                <representation mediaType="application/json" type="tns1:RA_INTERFACE_LINES_ALL_Input" />
                                <representation mediaType="text/csv" type="tns1:RA_INTERFACE_LINES_ALL_Input"/>
                        </request>
                        <response>
                                <representation mediaType="application/xml" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                                <representation mediaType="application/json" type="tns1:RA_INTERFACE_LINES_ALL_Output" />
                                <representation mediaType="text/csv" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                        </response>
        </method>
        <method id="RA_INTERFACE_LINES_ALL_put" name="PUT">
                   <request>
                                <representation mediaType="application/xml" type="tns1:RA_INTERFACE_LINES_ALL_Input"/> 
                                <representation mediaType="application/json" type="tns1:RA_INTERFACE_LINES_ALL_Input" />
                                <representation mediaType="text/csv" type="tns1:RA_INTERFACE_LINES_ALL_Input"/>
                        </request>
                        <response>
                                <representation mediaType="application/xml" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                                <representation mediaType="application/json" type="tns1:RA_INTERFACE_LINES_ALL_Output" />
                                <representation mediaType="text/csv" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                        </response>
        </method>
        <method id="RA_INTERFACE_LINES_ALL_delete" name="DELETE">
                   <request>
                                <param name="ctx_responsibility" type="xsd:string" style="query" required="false"/>
                <param name="ctx_respapplication" type="xsd:string" style="query" required="false" />
                                <param name="ctx_securitygroup" type="xsd:string" style="query" required="false" />
                                <param name="ctx_nlslanguage" type="xsd:string" style="query" required="false" />
                                <param name="ctx_orgid" type="xsd:int" style="query" required="false" />
                                <param name="filter" type="xsd:string" style="query" required="false"/>
                        </request>
                        <response>
                                <representation mediaType="application/xml" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                                <representation mediaType="application/json" type="tns1:RA_INTERFACE_LINES_ALL_Output" />
                                <representation mediaType="text/csv" type="tns1:RA_INTERFACE_LINES_ALL_Output"/> 
                        </response>
        </method>
 </resource> 
<resource path="SUBMIT_CP_RAXMTR/">
        <method id="SUBMIT_CP_RAXMTR_post" name="POST">
             <request>
                                <representation mediaType="application/xml" type="tns1:SUBMIT_CP_RAXMTR_Input"/> 
                                <representation mediaType="application/json" type="tns1:SUBMIT_CP_RAXMTR_Input" />
                                <representation mediaType="text/csv" type="tns1:SUBMIT_CP_RAXMTR_Input"/>
                        </request>
                        <response>
                                <representation mediaType="application/xml" type="tns1:SUBMIT_CP_RAXMTR_Output"/> 
                                <representation mediaType="application/json" type="tns1:SUBMIT_CP_RAXMTR_Output" />
                                <representation mediaType="text/csv" type="tns1:SUBMIT_CP_RAXMTR_Output"/> 
                        </response>
        </resource>
 </resources>
</application>

For more information about WADL description, see Reviewing WADL Element Details, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

To deploy a REST web service:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Repository Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.

  2. In the Integration Repository tab, select 'Interface Type' from the View By drop-down list.

  3. Expand an interface type node to locate your desired interface definition.

  4. Click the interface definition name link to open the interface details page.

  5. In the REST Web Service tab, specify service alias information.

    If the selected interface is an interface type of Business Service Objects, Java Bean Services, Application Module Services, Open Interface Tables, or Open Interface Views, select the desired HTTP method check boxes for the desired methods to be exposed as REST service operations.

  6. Click Deploy to deploy the service to an Oracle E-Business Suite environment.

  7. Click the deployed View WADL link to view the deployed WADL description.

Undeploying REST Web Services

Once a REST service has been successfully deployed, the Undeploy button appears in the REST Web Service tab. This allows the administrator to undeploy the service and at the same time to bring the service back to its initial state - "Not Deployed".

Interface Details Page with a Deployed REST Service

the picture is described in the document text

Note that when a service is undeployed, any existing or running service requests will be completed and no new request is honored. The associated service artifact will be removed from the system.

After a successful undeployment, "Not Deployed" is shown in the REST Service Status field. The value of the service alias entered earlier now disappears which allows the administrator to enter it again before next deployment.

To undeploy a REST service:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Repository Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.

  2. In the Integration Repository tab, select "Interface Type" from the View By drop-down list.

  3. Expand an interface type node to locate your desired interface definition.

  4. Click the interface definition name link to open the interface details page.

  5. In the REST Web Service tab, click Undeploy to undeploy the service.

Managing Grants for Interfaces with Support for SOAP and REST Web Services

Users who have the Integration Repository Administrator role can create grants to a specific user, users, or a group of users. Grants given to a user for specific services or operations are applicable for both SOAP and REST services.

Note: In this release, only PL/SQL APIs, Concurrent Programs, and Business Service Objects can be exposed as both SOAP and REST services. Java Bean Services, Application Module Services, Open Interface Tables, and Open Interface Views can be exposed as REST services only.

Managing Grants in the Grants Tab for PL/SQL APIs, Concurrent Programs, Business Service Objects, Java Bean Services, Application Module Services, Open Interface Tables, and Open Interface Views

With the exception of XML Gateway interfaces that the user security is managed in the XML Gateway user interface, security grants for all other interface types that can be exposed as web services are managed in the Grants tab of the interface details page. These interfaces are PL/SQL APIs, Concurrent Programs, Business Service Objects, Java Bean Services, Application Module Services, Open Interface Tables, and Open Interface Views.

For information on managing the user security for XML Gateway interfaces, see: Managing Security Grants for SOAP Web Services Only.

Interface Details Page with Grants Tab Highlighted

the picture is described in the document text

Creating Security Grants

The administrator can select one or more procedures and functions or methods contained in the selected interface, and then click Create Grant. The Create Grants page is displayed where the administrator can grant the selected method access permissions to a user, user group, or all users.

Once a method access permission is authorized to a grantee, it grants the permission to access the associated SOAP and REST service operations simultaneously. For example, when a user (OPERATIONS) is authorized to have access permission on a method called 'Change User Name', regardless if the method has been exposed as a SOAP or REST service operation or not, the user OPERATIONS has the permission to access the 'Change User Name' operation of BOTH service types through the same grant.

Create Grants Page with Overloaded Functions

the picture is described in the document text

Revoking Security Grants

The administrator can revoke security grants in the following ways:

Note: For users who are granted as members of a group, you cannot revoke their grants individually, but revoke the grant for the entire group instead. The Revoke icon is disabled for group members.

Viewing Grant Details

Each grant contains information about grantee type, grantee name, and whether the grant is authorized through a direct grant (such as a specific user 'OPERATIONS') or other grant method (such as through a user group 'Marketing Group').

To view grant details, click the Grant icon for the method that you want to view. A pop-up window called Grants appears with the grant details.

Note: For each member, the Granted Via column displays the name of the group. For grantees who were selected directly in the Create Grants page, the value in the Granted Via column is Direct.

In addition to the Grants tab, you can view the grant details of a desired method from the SOAP Web Service tab and the REST Web Service tab.

To create grants:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Repository Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.

  2. In the Integration Repository tab, select 'Interface Type' from the View By drop-down list.

  3. Expand an interface type node and click an interface definition that can be exposed as a REST service or as both SOAP and REST services.

    The interface details page appears.

  4. In the Grants tab, select one or more procedure and function or method names for which you want to create grants.

  5. Click Create Grant. The Create Grants page appears.

  6. Select a grantee type:

    • Specific User

    • Group of Users

    • All Users

  7. If you select Specific User or Group of Users, specify the user or group for which to create the grants in the Grantee Name field.

  8. Click Create Grant.

    The interface details page reappears.

To view or revoke grants:

You can view and revoke existing grants directly in the methods list on the interface details page.

  1. Navigate to the selected interface that can be exposed as a REST service.

  2. To view grant details:

    In the Grants tab, the REST Web Service tab, or the SOAP Web Service tab if it appears, click the Grant icon for a given operation. A pop-up window appears allowing you to view the grant details for the selected operation.

  3. To revoke grants in the Grants tab:

    • To revoke common grants for all selected methods

      Select more than one method from the table and click Revoke Grant. The Revoke Grants page appears. Select one or more common grants from the table and click Revoke Grant.

    • To revoke grants for a single method

      Select a desired method from the table and then click Revoke Grant.

      Select one or more existing grants from the table and click Revoke Grant to revoke the grants.

Managing Service Life Cycle and Security Grants Through Backend Processing

In addition to managing service lifecycle activities and creating security grants through the Integration Repository user interface, administrators can perform these tasks through backend processing:

Managing SOAP Service Lifecycle Activities Using Manual Steps

Oracle E-Business Suite Integrated SOA Gateway allows you to perform SOAP service design-time activities through the use of command line. This includes:

For information on setting up Oracle E-Business Suite Integrated SOA Gateway in a multinode environment, see Configuring Oracle E-Business Suite Integrated SOA Gateway Release 12.1.2 and Release 12.1.3 in a Multinode Environment, My Oracle Support Knowledge Document 1081100.1.

For more troubleshooting information, see the Oracle E-Business Suite Integrated SOA Gateway Troubleshooting Guide, Release 12, My Oracle Support Knowledge Document 726414.1.

Generating SOAP Services Using soagenerate.sh

When you try to generate a SOAP service from the Integration Repository user interface, if the system takes too long for the service generation to complete, the following HTTP 403 exception may appear on the interface:

oracle.apps.fnd.soa.util.SOAException:SystemError:Error while sending message to server. 

Server returned HTTP response code: 403 for URL: http://<hostname>:<port>/webservices/SOAProvider/EbizAuth?Generate=1656&soa_ticket=xxxxxxxxxxxxxxxxx_xxxx..' when attempting to perform 'GENERATE'.

To resolve the issue, a standalone soagenerate.sh script is created allowing you to generate WSDL services for PL/SQL, concurrent program, and XML Gateway Map interfaces through backend processing.

Prerequisites to Run soagenerate.sh:

  1. Environment variable (like $IAS_ORACLE_HOME) needs to be set by running .env file in APPL_TOP of your environment.

  2. If you have the appmgr privileges and have the read permission on $INST_TOP/ora/10.1.3/j2ee/oafm/config/oc4j.properties, then you can run soagenerate.sh without any setup described in step 3.

  3. If you do not have the read permission on $INST_TOP/ora/10.1.3/j2ee/oafm/config/oc4j.properties, then you need to set the following properties present in JAVA_TOP/oracle/apps/fnd/soa/provider/wsdl/data/soa.properties:

    1. Set the following two database connection related properties in the soa.properties file:

      1. SOA_CREATE_DB_CONN_CONTEXT = true

      2. JTFDBCFILE =<Physical Location of dbc file, to which User has read access>

    2. Set the other required properties:

      1. SOA_SERVER_TEMP_DIRECTORY_LOCATION=<location of $INST_TOP/soa>

      2. SOA_SERVER_URL=<protocol://host:port of Apps Self Service URL>

      3. SOA_ENABLE_STANDALONE_LOGGING = true

  4. You should have the write permission on SOA_SERVER_TEMP_DIRECTORY_LOCATION mentioned in step 3.

  5. You should have the write permission on the directory from where you are running this script.

Usage of soagenerate.sh:

$FND_TOP/bin/soagenerate [help] irepname=<irepname> logfile=<logfile> printprops=<true|false>

Valid arguments for soagenerate are described as follows:

Redeploying SOAP services in a Cloned Environment Using Postclone.sh

You can run the following Postclone.sh script to have deployed SOAP services created in a cloned Oracle E-Business Suite environment:

$FND_TOP/bin/postclone.sh
Enter service type (SOAP/REST/BOTH) :

Enter "SOAP" as the Service Type value to clone SOAP services. To clone both SOAP and REST services, enter "BOTH" as the value.

This Postclone.sh script writes results to the $INST_TOP/soa/SOAPPostCloneResults.txt file. It includes postclone status and WSDL URL for each deployed interface. If the script fails to redeploy an interface, it is also mentioned in this file.

Managing REST Service Lifecycle Activities Using Manual Steps

In addition to performing REST design-time activities through the Integration Repository user interface (UI), you can use command line to perform the following activities:

For information on setting up ISG in a multinode environment, see Configuring Oracle E-Business Suite Integrated SOA Gateway Release 12.1.2 and Release 12.1.3 in a Multinode Environment, My Oracle Support Knowledge Document 1081100.1.

Deploying or Undeploying REST Services Using RestDeployer.sh

Once you deploy a REST service through manual steps by running the script RestDeployer.sh, a WADL link for the deployed REST service would be available in the Interface Details page through the Integration Repository user interface.

Perform the following steps to deploy or undeploy a REST service:

  1. Find irep_name of the service to be deployed.

    For example, irep_name is the 'Internal Name' of a desired PL/SQL API shown in the Interface Details page in the Integration Repository user interface.

  2. Change directory to $FND_TOP/bin.

  3. Run RestDeployer.sh irepname=<irep_name>. For example,

    • Deploy a PL/SQL API 'FND_GLOBAL' as a REST service with POST HTTP verb using the following command:

      RestDeployer.sh irepname=FND_GLOBAL.

    • Deploy the following open interface tables contained in the 'OEOIMP' open interface with Inbound direction using one command:

      RestDeployer.sh irepname=OEOIMP[{OE_HEADERS_IFACE_ALL:GET+POST+DELETE+PUT}{OE_LINES_IFACE_ALL:GET+POST}]

      This deploys OE_HEADERS_IFACE_ALL table as a REST service with four supported HTTP verbs (GET, POST, DELETE, and PUT), and OE_LINES_IFACE_ALL table as a REST service with both the GET and POST HTTP verbs.

      Note that the supported verb for PL/SQL APIs is POST only; the supported verbs for Java Bean Services and Application Module Services are all the annotated verbs and POST. For open interface tables with Outbound direction and open interface views, the supported verb is GET only.

    When prompted, provide the following inputs:

    Enter the target as deploy or undeploy: deploy (or undeploy)

    Enter the alias of the interface to be deployed: <alias name>

  4. Review log file ServiceGenerator.log for details.

    Follow the text after the "ServiceGenerator invoked at : <Date Time>" message in the log file. The irepName, ClassId, WADL URL and status information would be displayed. For example, the log file contains the following information for a deployed PL/SQL REST service:

    irepName is : <irep_name>
ClassId = <classId>
Class Type = PLSQL
Generating service with classId = <classId>
WADL URL = https://<host>:<port>/webservices/rest/<alias name>?WADL
Service Generated and Deployed.

    The message "Service Generated and Deployed" indicates that the REST service is successfully deployed.

Redeploying REST Services in a Cloned Environment Using Postclone.sh

You can execute the following Postclone.sh script to have deployed REST services created in a cloned Oracle E-Business Suite environment:

$FND_TOP/bin/postclone.sh
Enter service type (SOAP/REST/BOTH) :

Enter "REST" as the Service Type value to clone REST services. To clone both SOAP and REST services, enter "BOTH" as the value.

The Postclone.sh 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.

Managing Security Grants Using an Ant Script

In addition to managing security grants through the Integration Repository user interfaces, an administrator can use the isggrant.xml script to perform this task.

ant -f $JAVA_TOP/oracle/apps/fnd/isg/isggrant.xml -DirepNames=<interface_name[function1:function2:..]> -Dactions=<CREATE | REVOKE> -DgranteeType=< USER | GROUP | GLOBAL> -DgranteeKey= <Grantee Key>

See Using the Script with Arguments for the Grant.

Argument Description

The following arguments are specifically used in isggrant.xml for managing security grants:

Using the Script with Arguments for the Grant

The following examples explain how to use the script with arguments to create and revoke security grants:

Generating a Service Description List Using an Ant Script

To understand SOAP and REST service generation and deployment status, an administrator can run an Ant script DownloadServicesList.xml using the following command:

ant -f $JAVA_TOP/oracle/apps/fnd/isg/ant/DownloadServicesList.xml

This script generates a service descriptor file called ISGServiceDescriptor_<timestamp>.xml in $INST_TOP/soa. This file reports the list of APIs which are generated or deployed as SOAP services, or are deployed as REST services.

For example, the following sample service descriptor file lists the service description information:

<INTEGRATION_REPOSITORY name="EBS_SID" xsd_version="2.0">
  <INTERFACE>
    <NAME>/oracle/apps/ar/hz/service/party/DqmSearchService</NAME>
    <TYPE>SERVICEBEAN</TYPE>
    <REST_ACTIONS>
      <UNDEPLOY/>
      <DEPLOY>
        <ALIAS>dqm</ALIAS>
        <FUNCTIONS_LIST verb="POST">
          <FUNCTION>findParties</FUNCTION>
        </FUNCTIONS_LIST>
      </DEPLOY>
    </REST_ACTIONS>
  </INTERFACE>
  <INTERFACE>
    <NAME>HZ_CUST_ACCOUNT_V2PUB</NAME>
    <TYPE>PLSQL</TYPE>
    <SOAP_ACTIONS>
      <UNDEPLOY/>
      <GENERATE>
        <ALL_FUNCTIONS/>
      </GENERATE>
      <DEPLOY>
        <POLICY>USERNAME_TOKEN</POLICY>
      </DEPLOY>
    </SOAP_ACTIONS>
  </INTERFACE>
</INTEGRATION_REPOSITORY>