Skip Headers

Oracle E-Business Suite Integrated SOA Gateway User's Guide
Release 12.1
Part Number E12064-08
Go to Table of Contents
Contents
Go to previous page
Previous
Go to next page
Next

Working with Native Services and Integration Interfaces

This chapter covers the following topics:

Common Information

The details page of each integration interface type contains the following two types of information:

Interface Details Page

the picture is described in the document text

Each interface details page also includes Search and Printable Page allowing you to perform a search or view the details page of a selected interface in a printable format if you want. See Searching for an Integration Interface for details.

Tip: Information specific to Web services is discussed under Understanding Service Enablement.

Information specific to composite services is discussed under Working with Composite Services.

Common Information on Interface Details

Each interface information page includes a header region with general information about the interface.

For information on SOAP and REST Web services, see Common Information on SOAP Web Services and Common Information on REST Web Services.

The following fields are common to almost all interface types:

Field Notes
Internal Name This is the PL/SQL package name, the document name, or the Java service interface name.

Note: For Java service interfaces, this is called Qualified Name, and includes the full Java package name and the class name.

Type Business interfaces are organized into interface types according to the integration technologies on which they're based.
Examples of interface types supported in Integration Repository are PL/SQL, XML Gateway, Concurrent Programs, Business Events, Open Interface Tables/Views, EDI, Business Service Object (Service Beans), Java, and Composite Service - BPEL.
For more information about interface type, see interface type.
Product The Oracle E-Business Suite product that supplies the interface.
Business Entity Business entities are objects that either perform business activities or have business activities performed on them. For example, sales orders, account numbers, employees, purchase orders, customers, and receipts are all business entities. An interface can be used by multiple business entities, and a business entity can be accessed using multiple interfaces.
The Business Entity field lists the business entities accessed by an interface. Click a business entity name to view a list of available interfaces to that entity.

Note: This field does not appear for Java service interfaces.

Status Valid status codes are:
  • Active

  • Deprecated - this interface should not be used, but it will be supported until obsolete.

  • Obsolete - the interface is no longer supported.

  • Planned - This interface will be activated at a future date.

Scope The scope can be one of the following:
  • Public

  • Internal To Oracle

  • Private To Application


For more information, see Scope on the Oracle Integration Repository Search page.
Interface Source The only available interface source in Oracle Integration Repository is Oracle native packaged integration interfaces.
Interface Source on the Oracle Integration Repository Search page.
MetaLink Included for any interface that has a related My Oracle Support (formerly OracleMetaLink) Knowledge Document. Click the link to log in to My Oracle Support and view the Knowledge Document. A valid user name and password is required to access My Oracle Support.
Documentation Included for any interface that has related online documentation. Click the link to view or download the documentation.
Online Help Provided for any interface that has related Oracle E-Business Suite online help. Click the link to view online help for the interface.

Each interface information page also includes a Source Information region that contains the following fields:

Field Notes
Source File The source code file for this interface, and its location in the file system.
Source Version The version of the source file. The first portion of the number corresponds to the base release version of Oracle E-Business Suite and the second portion is the version of the file. For example, 120.8 is Oracle E-Business Suite 12.0, and 8 indicates that this is the 8th version of the file.

Note: The version number changes only when it has been worked on by Oracle development. Therefore the version may increment multiple times between releases, or not at all.

Source Product The product code of the source product. The source product specifies under which product directory the file resides in the Oracle E-Business Suite file system (also referred to as the product top).

Tip: This field shows the product shortname. You can learn the corresponding full product name by choosing the System Administration responsibility from the Navigator menu, then selecting Oracle Applications Manager > License Manager > Reports > Licensed Products. On the product list that appears, you can filter the results for any product abbreviation (shortname) or license status.

Integration repository administrators can find the following buttons available in the interface details page:

Additional Information: The integration repository administrators (defined by the Integration Repository Administrator role) can find the Administration tab containing the following information displayed next to the Integration Repository tab:

Common Information on SOAP Web Services

For service-enabled interfaces, SOAP service information is displayed in the appropriate Web Service region (or the SOAP Web Service tab if the interfaces can also be exposed as REST services) of the interface details page.

For example, the Web Service - SOA Provider region by default appears in the details page if the selected interface type is not Business Service Object. This region allows you to review a Web service details in WSDL code, and allows the administrators (or users who have the Integration Repository Administrator role) to perform administrative tasks including deploying or undeploying Web services.

Note: XML Gateway Map and Business Service Object (formerly known as Service Bean) interface types are service enabled in Release 12.0 through Web Service Provider. To enable services for more interface types, SOA Provider is used in this release to support XML Gateway Map, plus additional interface types including PL/SQL, Concurrent Program, Business Event, and Composite Service - BPEL types. Therefore, you might still find Web Service - SOA Provider region available for XML Gateway Map interface type if the service is enabled by SOA Provider in this release.

Web Service Region(s) for XML Gateway Map and Business Service Object

The following fields are common in the appropriate Web Service region or the SOAP Web Service tab to almost all interface types:

Field Description
Web Service Status
(or SOAP Service Status if it's in the SOAP Web Service tab)
This field indicates different state of a SOAP service during service generation and deployment life cycle.
  • Generated: This indicates that the selected interface has a SOAP service available, but the service has not yet been deployed. Therefore, this generated service is not ready to be invoked. Once a service has been successfully generated, the following buttons appear:

    • Regenerate WSDL: This button lets you regenerate the service if the interface definition has been changed before service deployment.

    • Deploy: This button lets you deploy the generated SOAP service.

  • Deployed: This indicates that the selected interface has been deployed to Oracle Application Server. Once a service has been successfully generated, the following buttons appear:

    • Undeploy: This button lets you undeploy the SOAP service from the application server back to Oracle Integration Repository if necessary.

    • Redeploy: This button lets you update the deployed service with the current system values.

View WSDL This link is displayed after a selected interface has an associated SOAP service available. Click this link letting you review WSDL description for a generated or deployed service.
See: Reviewing Web Service WSDL Source.
Authentication Type To secure Web service content and authenticate Web service operation, before deploying a generated service, an integration repository administrator must select one desired authentication type for the selected service in the Authentication Type field.
  • Username Token: This authentication type provides username and password information in the security header to authenticate SOAP requests.

    See: UsernameToken Based Security, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

  • SAML Token (Sender Vouches): This authentication type is used for Web services relying on sending a username only through SAML Assertion.

    See: SAML Sender-Vouches Token Based Security, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.


Only users who have the Integration Repository Administrator role can select and modify the authentication type. For other users, this field is displayed in read-only mode.
Grant The Grant icon is shown only in the SOAP Web Service tab.
If the access permission of an operation has been granted to a specific user, user groups, or all users, then the Grant icon is available for the operation. Only users who have the Integration Repository Administrator role and the System Integration Developer role can find the Grant icon and view the grant details.

Performing Administrative Activities for SOAP Web Services

Users who have the Integration Repository Administrator role can perform administrative tasks. These tasks include generating, deploying, undeploying, and redeploying SOAP services by clicking the following buttons in the interface details page:

Additional Information: In addition to performing service management activities in the Integration Repository tab, integration repository administrators can perform other administrative tasks in the Administration tab that are outside the Integration Repository user interface. These tasks include:

Common Information on REST Web Services

If a selected interface can be exposed as a REST service, you can find the REST Web Service tab included in the interface details page. This interface can be a type of PL/SQL, Concurrent Program, Java Bean Services, or Application Module Services.

The following fields are common in the REST Web Service tab:

Field Description
Service Alias Each REST service should be associated with a unique alias name. Before deploying a REST service, the administrator must enter this field which will be used in service endpoint, WADL, XSDs, and namespaces.
Please note the following guidelines when specifying the service alias:
  • Use simple and meaningful name to represent the service, such as "person", "employee", and so on.

  • Do not use "rest", "soap", and "webservices" as the alias.

  • Do not start with number and special character, such as #, $, %, _, - and more.

  • Do not end with special character.

  • Characters such as ., _, and - are allowed in service alias.

REST Service Status This field indicates different state of a REST service during service life cycle.
  • Not Deployed: This indicates that the selected interface is not deployed.

    Click Deploy to deploy the REST service. The REST Web Service Status is changed from 'Not Deployed' to 'Deployed'.

  • Deployed: This indicates that the selected interface is deployed to the application server.

    Once a REST service has been successfully deployed, the administrator can undeploy the service by clicking Undeploy. This action undeploys the REST service from the server back to Oracle Integration Repository, and at the same time it clears up the existing service artifact. The REST Service Status field is changed from 'Deployed' to 'Not Deployed'.


In addition to 'Not Deployed' and 'Deployed' service states, more intermediate service statuses can be shown while the service is in the process of performing an action issued by the administrator and transforming to a different state. The following list describes intermediate service status information:
  • Deploying: This indicates that the selected interface is in the middle of the process of deploying the service. After this process is complete, 'Deployed' is displayed in the REST Service Status field.

  • Undeploying: This indicates that the selected interface is in the middle of the process of undeploying and removing the associated service artifact. After this process is complete, 'Not Deployed' is displayed in the REST Service Status field.

View WADL This link is displayed after the selected interface has an associated REST service deployed. Click this link letting you review WADL description for the deployed REST service.
This field appears only when the REST service has been successfully deployed with 'Deployed' status.
See: Reviewing Web Service WADL Source.
Verb The Verb value indicates how the REST service is implemented using an HTTP method.
If the selected interface is a PL/SQL API or Concurrent Program, then this field is displayed when the REST service has the Deployed status.
Please note that POST is the only supported HTTP method for PL/SQL APIs and Concurrent Programs.
REST Service Security To secure REST service content, all REST services are secured by either one of the following security methods:
  • HTTP Basic Authentication: This authentication type is for an HTTP client application to provide username and password when making a REST request that is typically over HTTPS.

    See: HTTP Basic Authentication, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

  • Token Based Authentication: This security authenticates a user using a security token obtained by invoking the security Login service. When a user tries to log on to a server, a token (such as Oracle E-Business Suite session ID) may be sent as cookie in HTTP header. This authentication method can be used in multiple consecutive REST invocations. See: Token Based Authentication, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

Service Operations table This table displays the list of procedures or functions contained in the selected interface that can be exposed as REST service operations.
For more information on each field in the table, see Service Operations Table.

Service Operations Table

The Service Operations table displays each method (or procedure or function) contained in the selected interface, and whether it is exposed as a service operation. Users who have the Integration Repository Administrator role can perform administrative tasks including deploying or undeploying services as well as creating or revoking security grants.

The following table describes each field in the Service Operations table:

Field Description
Display Name This is the interface name used externally.
Internal Name This is the interface name used internally.
Included Operations (PL/SQL APIs and Concurrent Programs Only) If the selected interface is a PL/SQL API or a Concurrent Program, then this Included Operations column appears as part of the Service Operations table. All the methods contained in the selected interface are selected in this column.

Note: By default, all methods in a PL/SQL API are deployed with POST HTTP method. A Concurrent Program contains only single method which is deployed with POST HTTP method as well.

GET
(Java Bean Services and Application Module Services Only)
This GET HTTP method column is displayed when the selected interface is an interface type of Java Bean Services or Application Module Services.
This GET check box is preselected if a Java or an Application Module method is annotated with the GET HTTP method. The administrator can uncheck the preselected GET check box for the method if it will not be published with the GET HTTP method.
However, if the GET method is not annotated, unlike the POST method, the GET check box becomes inactive or disabled for further selection.
POST
(Java Bean Services and Application Module Services Only)
This HTTP method column is displayed when the selected interface is an interface type of Java Bean Services or Application Module Services
Similar to the GET method, this POST check box is preselected if a Java or an Application Module method is annotated with the POST HTTP method. The administrator can uncheck the preselected check box before deploying the service if the Java or Application Module method will not be published with the POST method.
If the POST HTTP method is not annotated, the POST check box remains active or enabled by default. This allows the administrator to select the POST check box if needed for the Java or Application Module method as a REST service operation before service deployment.
Grant If the access permission of an operation has been granted to a specific user, user groups, or all users, then the Grant icon is displayed for the operation. Only users who have the Integration Administrator role and the Integration Developer role can find the Grant icon and view the grant details.

Performing Administrative Activities for REST Web Services

REST services have a simplified service development life cycle. Users who have the Integration Repository Administrator role can perform the following administrative tasks in the interface details page:

Reviewing Web Service WSDL Sources

To make integration interfaces available to customers over a network where customers can dynamically interact between applications, Oracle Integration Repository allows integration repository administrators (or users who have the Integration Repository Administrator role) to generate Web services WSDL files.

Once Web services are generated, you will find the appropriate Web Services region(s) available when viewing an interface detail for a given interface type.

Viewing Web Service WSDL Information

the picture is described in the document text

To view WSDL file:

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

    Locate your desired interface definition through a search or from the navigation tree.

  2. Click the interface name to open the interface details.

  3. Click the View WSDL link in the Web Service region to view the WSDL source code.

    The following sample shows the WSDL description for the PLSQL Interface: Repair Order:

    <?xml version="1.0" encoding="UTF-8"?>
    <definitions name="CSD_REPAIRS_PUB" 
    targetNamespace="http://xmlns.oracle.com/apps/csd/soaprovider/plsql/csd_repairs_pub/"
      xmlns="http://xmlns.oracle.com/apps/csd/soaprovider/plsql/csd_repairs_pub/"
      xmlns="http://schemas.xmlsoap.org/wsdl/" 
      xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
      xmlns:tns1="http://xmlns.oracle.com/apps/csd/soaprovider/plsql/csd_repairs_pub/create_repair_order/"
      xmlns:tns2="http://xmlns.oracle.com/apps/csd/soaprovider/plsql/csd_repairs_pub/update_ro_status/">>
    <types>
    <schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
     targetNamespace="http://xmlns.oracle.com/apps/csd/soaprovider/plsql/csd_repairs_pub/create_repair_order/">
     <include schemaLocation="http://<myhost>:<port>/webservices/SOAProvider/plsql/csd_repairs_pub/APPS_ISG_CREATE_REPAIR_ORDER_CSD_REPAIRS_PUB-24CREATE_REPAIR.xsd"/>
    </schema> 
    <schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
     targetNamespace="http://xmlns.oracle.com/apps/csd/soaprovider/plsql/csd_repairs_pub/update_ro_status/">
     <include schemaLocation="http://<myhost>:<port>/webservices/SOAProvider/plsql/csd_repairs_pub/APPS_ISG_UPDATE_RO_STATUS_CSD_REPAIRS_PUB-24UPDATE_RO_STA.xsd"/> 
     </schema> 
    <schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
     targetNamespace="http://xmlns.oracle.com/apps/csd/soaprovider/plsql/csd_repairs_pub/">
      <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>
    </type>
       . . .

    Note: Values passed in the Responsibility, Responsibility Application, Security Group, NLS Language, and Organization ID complex types listed under the "SOAHeader" are used to set applications context during service execution.

    Please note that NLS Language and Organization ID are optional values to be passed. However, if the execution of a service is dependent on any particular organization, then you must pass the ORG_ID element in the "SOAHeader" of that SOAP request.

    For more information, see Setting Other Web Service Input Message Parts, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

    Please note that the user information is defined by the wsseUsername property passed within the security headers. Detailed instructions on how to pass the security headers along with the SOAP request, see Passing Values to Security Headers, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

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

To view a deployed WSDL file:

When an integration repository administrator successfully deploys or redeploys a Web service, the Web Service Status field appears with 'Deployed' value along with selected authentication type(s). A deployed WSDL link also appears confirming that the service has been successfully deployed.

Click the View WSDL link to view the deployed WSDL file.

Reviewing Web Service WADL Sources

Once a REST Web service represented in WADL has been successfully deployed, the REST Service Status field is changed from 'Not Deployed' to 'Deployed'. The WADL link appears in the REST Web Service tab allowing you to view the WADL description.

For example, the following WADL description is for a PL/SQL API Invoice Creation (AR_INVOICE_API_PUB) that includes 'CREATE_INVOICE' and 'CREATE_SINGLE_INVOICE' REST service operations:

<?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" /> 
		<include xmlns="http://www.w3.org/2001/XMLSchema" href="https://host01.example.com:1234/webservices/rest/Invoice/?XSD=CREATE_SINGLE_INVOICE_SYNCH_TYPEDEF.xsd" /> 
   	</grammars>
	<resources base="http://host01.example.com:1234/webservices/rest/Invoice/">
		      ...
	</resources>
</application>

Note: The service alias value Invoice entered earlier before service deployment is now displayed as part of the schema for the service operations - 'CREATE_INVOICE' and 'CREATE_SINGLE_INVOICE'.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?> 
<application xmlns:tns=...
...
 	<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>
		<resource path="/create_single_invoice/">
			<method id="CREATE_SINGLE_INVOICE" name="POST">
				<request>
					<representation mediaType="application/xml" type="tns2:InputParameters" /> 
					<representation mediaType="application/json" type="tns2:InputParameters" /> 
				</request>
				<response>
					<representation mediaType="application/xml" type="tns2:OutputParameters" /> 
					<representation mediaType="application/json" type="tns2:OutputParameters" /> 
				</response>
			</method>
		</resource>
	</resources>
</application>

Note: POST is shown as the method name for two service operations 'CREATE_INVOICE' and 'CREATE_SINGLE_INVOICE'. This is the only HTTP method supported for PL/SQL REST services in this release.

Input and output messages can be exchanged in both XML and JSON formats for both service operations.

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 in the REST service operation. For example, the following WADL description shows many methods contained in the Employee Information service. The getPersonInfo operation is implemented with both 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>
  		<include href="http://<hostname>:<port>/webservices/rest/empinfo/?XSD=getallreports.xsd" xmlns="http://www.w3.org/2001/XMLSchema" /> 
			<include href="http://<hostname>:<port>/webservices/rest/empinfo/?XSD=getdirectreports.xsd" xmlns="http://www.w3.org/2001/XMLSchema" /> 
			<include href="http://<hostname>:<port>/webservices/rest/empinfo/?XSD=getpersoninfo.xsd" xmlns="http://www.w3.org/2001/XMLSchema" />
</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="/getDirectReports/">
		<method id="getDirectReports" 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="tns2:getDirectReports_Output" /> 
					<representation mediaType="application/json" type="tns2:getDirectReports_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>

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

To view a deployed WADL file:

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

    The Integration Repository home page appears.

  2. Locate your desired interface definition through a search or browse from the interface tree structure within the repository.

  3. Click the interface name to open the interface details page.

  4. In the REST Web Service tab, click the View WADL link to view the WADL source code.

Managing Grants

Only integration repository administrators (or users who have the Integration Repository Administrator role) can create security grants by authorizing the access permission of a selected interface method or procedure and function to an appropriate user, user group, or all users.

Interface types that have the security grant feature available are PL/SQL, Concurrent Program, Business Service Object, Java Bean Services, Application Module Services, and Inbound XML Gateway interfaces.

Managing Grants in the Methods Region

For interfaces that can be exposed as SOAP services only, security grants are managed in the Methods region. These interfaces include Business Service Object and XML Gateway interfaces.

Managing Grants in the Methods Region

the picture is described in the document text

Managing Grants in the Grants Tab

For interfaces that can be exposed as REST services, security grants are managed in the Grants tab. These interfaces include PL/SQL APIs, Concurrent Programs, Java Bean Services, and Application Module Services.

Managing Grants in the Grants Tab

the picture is described in the document text

Please note that the grant feature applies to the interfaces that can be exposed as both SOAP and REST services. For example, when a user (OPERATIONS) is authorized to have access permission on a PL/SQL API method name called 'Change User Name', the user will have the permission to access the associated 'Change User Name' service operations of both SOAP and REST service types through the same grant.

Creating Security Grants

To create a grant, select appropriate method name check boxes in the Methods region or in the Grants tab if the selected interface can be exposed as a REST service. Click Create Grant to open the Create Grants page.

In the Create Grants page, select a grantee type and grantee name if it's applicable. Click Apply. This creates security grants for the selected methods.

Please note that the grant action applies to both SOAP and REST PL/SQL services.

Revoking Security Grants

To revoke a grant in the Methods region, select the Show link for the method that the administrator wants to view or revoke the grant. The Grant Details section of the selected method appears with the grantee and grantee type information. Click the Revoke icon for the grant that you want to revoke.

To revoke a grant in the Grants tab, the administrator can perform the action in two ways:

For more information about how to manage grants in the Methods region, see Managing Security Grants for the SOAP Web Services Only, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

For more information about how to manage grants in the Grants tab, see Managing Security Grants for the SOAP and REST Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

XML Gateway Map Information

The following diagram illustrates the basic structure of the XML Gateway Map information page and its connections to related pages:

Basic Structure of the XML Gateway Information Page

the picture is described in the document text

The XML Gateway Map information page contains the following information:

The general section of the XML Gateway Map displays common information.

The information page or interface details page includes a table listing the XML Gateway methods. Click a method name to access the information page for that method.

XML Gateway Map Web Service Region

To support the XML Gateway Map service enabled by Web Service Provider in Release 12.0 and to differentiate the service enablement by SOA Provider in this release, Oracle E-Business Suite Integrated SOA Gateway uses the following profile option to let you select an appropriate service provider in enabling services for XML Gateway Map interface type. Based on the selected profile value, the interface details page displays an appropriate Web Service region or more than one region.

Select one of the following values to define the FND: XML Gateway Map Service Provider profile option:

For more profile option information used in Oracle E-Business Suite Integrated SOA Gateway, see Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

Integration repository administrators (defined by the Integration Repository Administrator role) can also find the following buttons available if the Web service has been generated successfully:

See: Performing Administrative Activities for SOAP Web Services.

XML Gateway Method Information

The XML Gateway method information page appears when you click a method name on an XML Gateway Map information page.

XML Gateway method information page

the picture is described in the document text

The general section of this page displays common information for the XML Gateway method, plus the following additional field:

Direction

This page also contains a table listing the XML Gateway method parameters, including each parameter's data type and whether the parameter is required.

PL/SQL Information

The following diagram illustrates the basic structure of the PL/SQL information page and its connection to the related PL/SQL procedure/function information page:

Basic Structure of the PL/SQL API Information Page

the picture is described in the document text

PL/SQL interfaces can be exposed as both SOAP services and REST services. Therefore, the PL/SQL interface details page includes general section of a selected PL/SQL interface, the Overview tab, the SOAP Web Service tab, and the REST Web Service tab.

Users who have the Integration Repository Administrator role can find an additional Grants tab displayed in the interface details page. This tab allows the administrators to create and revoke security grants. For more information on how to manage security grants, see Managing Grants.

For information on the general section, see Common Information.

PL/SQL Interface Details Page

the picture is described in the document text

Note: For more information about Web services, see Understanding Web Services.

PL/SQL Method Details Page

The PL/SQL method details page appears when you click a method name in the Overview tab, the SOAP Web Service tab, or the REST Web Service tab.

PL/SQL Method Details Page

the picture is described in the document text

This page displays the signature of the selected method, and a table listing the parameters and their attributes.

Java Information

The following diagram illustrates the basic structure of the Java information page and its connection to the related Java method information page.

Basic Structure of the Java Information Page

the picture is described in the document text

The general section of the Java information page displays common information for the selected Java class. This page also contains a table listing the class methods, including active status and internal name. Click the Java method name link to access the Java Method Details.

If you have the Integration Administrator role, the Grants tab appears. This lets you grant the access permissions of selected methods to a user, a user group, or all users. For more information on how to create security grants, see Managing Grants.

Java Method Details

The Java method details page appears when you click a method name on the Java interface details page.

Java method information page

the picture is described in the document text

The general section of the Java method information page displays common information for the selected method, plus the following additional fields:

This page also displays the signature of a selected method, information about the return type, and a table listing the method parameters.

Subtype of Java APIs

Some Java APIs are categorized as a subtype of Java interfaces. To locate those Java APIs, you must perform a search through the combination of Category and Category Value fields.

For information on how to locate these Java APIs through a search, see Searching for an Integration Interface.

If your selected interface belongs to these subtypes of Java APIs, the interface details page may contain Web service information if the selected interface is exposed as a service. For the interface details page of these APIs, see:

Java Bean Services

The following diagram illustrates the basic structure of the Java Bean Services information page and its connection to the related Java method details:

Basic Structure of the Java Bean Services Information Page

the picture is described in the document text

Searching Java Bean Services Interfaces

To easily locate Java Bean Services through the Search page, click Show More Search Options to display more search fields.

Enter the following key search values as the search criteria:

For information about category and category value fields, see Category and Category Value.

Viewing Java Bean Services

Java Bean Services can be exposed as REST services only. The interface details page contains the Overview tab and the REST Web Service tab. An integration repository administrator can find an additional Grants tab displayed in the page. This Grants tab allows the administrator to create and revoke security grants. For more information on how to manage security grants, see Managing Grants.

For information on the general section, see Common Information.

Note: For more information about Web services, see Understanding Web Services.

REST Service Information for the Selected Java Bean Service

the picture is described in the document text

Application Module Services

The following diagram illustrates the basic structure of the Application Module Services information page and its connection to the related Java method details:

Basic Structure of the Application Module Services Information Page

the picture is described in the document text

Searching Application Module Services Interfaces

To quickly locate Application Module Services through the Search page, click Show More Search Options to display more search fields. Enter the following key search values as the search criteria:

For information about category and category value fields, see Category and Category Value.

Viewing Application Module Services

Similar to Java Bean Services that can be exposed as REST services only, the interface details page contains the Overview tab and the REST Web Service tab. An integration repository administrator can find an additional Grants tab for managing security grants. For more information on how to manage security grants, see Managing Grants.

For information on the general section, see Common Information.

Note: For more information about Web services, see Understanding Web Services.

REST Service Information for the Selected Application Module Service

the picture is described in the document text

Security Services

Security services are a set of predefined and predeployed REST services from Oracle Application Object Library. These services include Authentication and Authorization services and are used for mobile applications.

For example, Login service validates the user credentials and returns an access token. Logout service invalidates the access token and any associated authentication sessions. These two services are included in the Authentication service that helps session initialization with security or applications context information. Authorization service retrieves the Access Control List which may contain assigned responsibilities, roles, and privileges for all logged-in users.

For more information about these REST security services, refer to the Oracle E-Business Suite Security Guide.

Searching and Viewing Security Services

To easily locate security services through the Search page, click Show More Search Options and then enter your search criteria in the Category (subtype) and the Category Value (Security Services) fields.

For information about category and category value fields, see Category and Category Value.

Viewing Security Service Interface Details

After a search, select a desired security service from the search results table. The interface details page for the selected security service is displayed. It contains some common interface information, REST Web Service region, and Methods region.

Viewing the Security Service Interface Details Page

the picture is described in the document text

For information on the general section, see Common Information.

REST Web Service Region

The REST Web Service region contains the selected security service information.

Please note that security services are pregranted to all Oracle E-Business Suite users which means that all the users can invoke these services.

Methods Region

In the Methods region, click a method name link to open the Java Method Details page for the selected method.

Java APIs for Forms

Java APIs for Forms are XML document-based integration points wrapped in Java classes for executing business logic in Oracle Forms.

Searching and Viewing Java APIs for Forms Interfaces

Similar to other subtype of Java APIs, you can perform a search by clicking Show More Search Options to quickly locate the Java APIs for Forms through the combination of Category (Interface Subtype) and Category Value (Java APIs for Forms) fields.

For information about category and category value fields, see Category and Category Value.

To view the interface details, select a desired Java APIs for Forms interface from the search result table. The selected interface details should appear.

Please 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.

Business Service Object

Business service object interface type, formerly known as service bean, provides the access to SOA services and facilitates integration between Oracle E-Business Suite and trading partners. They can be used directly, or they can be exposed as Web services. They often employ service data objects as parameters to pass complex data.

A service data objects (SDO) defines a generic API for accessing and manipulating structured data as part of a Service Oriented Architecture (SOA). It is designed to simplify and unify the way in which applications handle data. The SDO API is independent of the actual data source. For example, SDO can be used to access XML data or SQL data. For more information about SDO, see Reviewing Service Data Objects.

Note: A business service object is not actually an interface type; rather, it is an object used by one or more Java service interfaces or other service data objects to pass data. Oracle Integration Repository includes it on lists of interface types, so you can browse or search for Java service interfaces based on the business service objects that they use.

The following diagram illustrates the basic structure of the business service object interface information page and its connections to related pages:

Basic Structure of the Business Service Object Information Page

the picture is described in the document text

Business Service Object Interface Information

The general section displays common information for the selected business service object interface, plus interface name, the interface that extends, and XML schema information:

An XML schema is a description of a type of XML document, typically expressed in terms of constraints on the structure and content of documents of that type. It describes all input and output message definition and data type.

Click the XML schema link that is associated with your selected business service object to view the XML schema document displayed in a separate window.

The business service object interface information page contains the following information:

Business Service Object Web Service Region

Unlike XML Gateway Map interface type that can be service enabled by both Web Service Provider (in Release 12.0) and SOA Provider (after Release 12.0), business service object interface type is service enabled only through Web Service Provider, not by SOA Provider.

When a service is generated successfully for a given business service object, the Web Service - Web Service Provider region appears with Web Service Status information.

Business Service Object Interface Information Page

the picture is described in the document text

If a Web service has been successfully generated, an integration repository administrator can perform additional administrative tasks including deploying the generated service or regenerating the service if needed. If a Web service has been successfully deployed, the administrator can undeploy or redeploy the service.

For information on these administrative tasks, Performing Administrative Activities for SOAP Web Services.

Viewing WSDL description

Click the View WSDL link in the Web Service - Web Service Provider region allowing you to view the WSDL file.

The following sample shows the WSDL description for the Integration Repository Service:

<?xml version="1.0"?>
<definitions name="IntegrationRepositoryService" 
targetNamespace="http://xmlns.oracle.com/oracle/apps/fnd/rep/ws/IntegrationRepositoryService"
  xmlns="http://schemas.xmlsoap.org/wsdl/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
  xmlns:tns2="http://xmlns.oracle.com/apps/fnd/ServiceBean"
  xmlns:tns1="http://xmlns.oracle.com/apps/fnd/rep/ws"
  xmlns:tns="http://xmlns.oracle.com/oracle/apps/fnd/rep/ws/IntegrationRepositoryService">
<types>
<xsd:schema>
  <xsd:import namespace="http://xmlns.oracle.com/apps/fnd/rep/ws" schemaLocation="http://<hostname>:<port>/webservices/AppsWSProvider/oracle/apps/fnd/rep/ws/IntegrationRepositoryService.xsd"/>
</xsd:schema>
<xsd:schema elementFormDefault="qualified" targetNamespace="http://xmlns.oracle.com/apps/fnd/ServiceBean" >
  <xsd:element name="ServiceBean_Header">
    <xsd:complexType>
      <xsd:element name="RESPONSIBILITY_NAME" minOccurs="0" type="xsd:string"/>
      <xsd:element name="RESPONSIBILITY_APPL_NAME" minOccurs="0" type="xsd:string"/>
      <xsd:element name="SECURITY_GROUP_NAME" minOccurs="0" type="xsd:string"/>
      <xsd:element name="NLS_LANGUAGE" minOccurs="0" type="xsd:string"/>
      <xsd:element name="ORG_ID" minOccurs="0" type="xsd:string"/>
     </xsd:sequence>
   </xsd:complexType>
  </xsd:element>
 </xsd:schema>
   . . .

Note: Values passed in the Responsibility Name, Responsibility Application Name, Security Group, NLS Language, and Organization ID elements listed under the ServiceBean_Header are used to set applications context during service execution.

Please note that NLS Language and Organization ID are optional values to be passed. However, if the execution of a Business Service Object interface is dependent on any particular organization, then you must pass the ORG_ID element in the ServiceBean_Header of that SOAP request.

For more information, see Setting Other Web Service Input Message Parts, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

Please note that the user information is defined by the wsseUsername property passed within the security headers. Detailed instructions on how to pass the security headers along with the SOAP request, see Passing Values to Security Headers, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

You might find the following information under <Method>_Response about error messages if occur:

...
<xsd: complexType name ="IntegrationRepositoryService_GetServiceDescription_Response">
		...
		<xsd:sequence>
 				<xsd:element name="serviceDescription" type="oans3:ServiceDescription" minOccurs="0" nillable="true"/>
				<xsd:element name="Message" type="oans1:ServiceMessage" minOccurs="0" maxOccurs="unbounded"/>

				<xsd:element name="ErrorMessage" type="oans1:ServiceMessage" minOccurs="0" maxOccurs="unbounded"/>
		</xsd:sequence>
</xsd: complexType name>

Note: The Message and ErrorMessage elements listed under <Method>_Response are used for error messages if occur. The Message element will appear as warning messages in the SOAP response. It is used to display any warning messages returned by the API. The ErrorMessage element corresponds to OAExceptions that were raised during the method invocation. In general, the response for any service method can contain any of the following:

For more information about error messages, see Error Handling section, Building an OA Framework Application (the Basics) chapter, Oracle Application Framework Developer's Guide, available from My Oracle Support Knowledge Document 1087332.1, Oracle Application Framework Release Notes for Release 12.1.3.

Business Service Object Interface Method Information

The business service object interface method information page appears when you click a method name on the business service object interface information page.

For more information about the Method region for business service object, see Business Service Object Web Service Region.

Business Service Object Method Information Page

the picture is described in the document text

In addition to common information, the general section of the method information page contains a link to the interface that uses this method.

The following regions also appear on the method information page:

Integration Repository Service

Based on business service object interface, Integration Repository Service is a service component residing in Oracle Integration Repository. It queries Integration Repository data, and provides information about all the interface definitions to facilitate the integration between Oracle E-Business Suite and trading partners.

When you search for Integration Repository Service through the business service object interface type, all business service objects contained in the Integration Repository Service are displayed. You can grant the control access of each business service object method to appropriate users.

To access the Integration Repository Service interface, log in to Oracle E-Business Suite as a user who has the System Integration Analyst role and use the following steps to navigate to Integration Repository Service:

  1. Select the Integrated SOA Gateway responsibility from the Navigator menu, and click the Integration Repository link that appears.

  2. Click Search.

  3. Enter the following information in the Search page:

  4. Click Go to execute the search.

  5. Click Integration Repository Service link from the search result table.

    This opens the Business Service Object Interface information page. If the service is exposed as Web service for Integration Repository Service, the Web Service region also appears.

    See: Business Service Object Interface information page.

  6. Click a method name link in the Methods region to get to business service object method details.

    See: Business Service Object Method Information.

  7. Integration repository administrators can find Create Grant displayed in the Methods region.

    Select a method name and click Create Grant, you can grant the control access of a selected business service object interface method to appropriate users.

    See: Managing Grants.

Reviewing Service Data Object

A service data objects (SDO) defines a generic API for accessing and manipulating structured data as part of a Service Oriented Architecture (SOA). It is designed to simplify and unify the way in which applications handle data. The SDO API is independent of the actual data source. For example, SDO can be used to access XML data or SQL data.

The data objects associated with business service objects include service data objects (SDO) and filter data objects (FDO).

Service Data Object Information

This page is accessible from the getDataList and processDataList method information pages. You can also access it directly from the Oracle Integration Repository browse interface, through the list of interface types.

The following diagram illustrates the basic structure of the service data object information page and its connections to related pages.

Basic Structure of the Service Data Object Information Page

the picture is described in the document text

The general section of the service data object page displays common information, plus the data object class name, implementation name, and its associated XML schema.

Click the XML schema name link to view the schema document displayed in a separate window.

Service Data Object Information Page

the picture is described in the document text

The following regions also appear on the service object information page:

Filter Data Object Information

This page is accessible only from the getDataList method information page.

The following diagram illustrates the basic structure of the filter data object information page and its connections to related pages.

Basic Structure of the Filter Data Object Information Page

the picture is described in the document text

A filter data object is a type of service object. The general section of the filter data object page displays common information, plus the data object class name, implementation name, filter type, and its associated XML schema information.

Note: There are two types of filter:

For more information on filters, see the Oracle Application Framework Developer's Guide, available from My Oracle Support Knowledge Document 1087332.1, Oracle Application Framework Release Notes for Release 12.1.3.

Click the XML schema name link to view the schema document displayed in a separate window.

Filter Data Object Information Page

the picture is described in the document text

The following regions also appear on the service object information page:

Service Data Object Method Information

The type of information provided for filter data object methods is the same as for service data object methods. The data object method information page appears when you click a method name on the service data object information page or the filter data object information page.

Service Data Object Method Information Page

the picture is described in the document text

In addition to a description, the following regions also appear on the service data object method information page:

Concurrent Program Information

The following diagram illustrates the basic structure of the concurrent program information page and its connection to the related Open Interface information page:

Basic Structure of the Concurrent Program Information Page

the picture is described in the document text

Concurrent programs can be exposed as both SOAP services and REST services. Therefore, the interface details page includes general section of a selected concurrent program, the Overview tab, the SOAP Web Service tab, and the REST Web Service tab.

Users who have the Integration Repository Administrator role can find an additional Grants tab displayed in the interface details page. This tab allows the administrators to create and revoke security grants. For more information on how to manage security grants, see Managing Grants.

For information on the general section, see Common Information.

Concurrent Program Interface Details Page

the picture is described in the document text

Note: For more information about Web services, see Understanding Web Services.

The concurrent program details page contains the following information:

Concurrent Program Method Details Page

The concurrent program method details page appears when you click a method name in the Overview tab, the SOAP Web Service tab, or the REST Web Service tab.

Note: Since Oracle Integration Repository does not support Open Interface Tables and Views for service enablement, if a concurrent program is linked to Open Interface tables or views, this concurrent program will be viewed and displayed under the Open Interface category and cannot be service enabled.

For more information about the Open Interface integration type, see Open Interface Information.

In the Parameters region, the parameters used in the selected interface are listed in a table. It includes parameter name, parameter type, required or not, displayed or not, and description information.

Open Interface Information

Open interface integrations are always implemented using concurrent programs, so open interface information is listed in a region on a concurrent program information page. The following diagram illustrates the basic structure of the open interface information region and its connection to the related interface table information page.

Basic Structure of the Open Interface Information Page

the picture is described in the document text

Open Interface table list

the picture is described in the document text

The Open Interface information table lists the open interface tables and views that store the interface data, including active status, and whether it stores data inbound to Oracle E-Business Suite or outbound to another system. Click an interface table name to access the information page for that table.

Interface Table Information

The interface table information page appears when you click an Open Interface table name on a concurrent program information page.

Open Interface table information page

the picture is described in the document text

The general section of this page displays common information for the selected interface table.

By clicking a name link in the Open Interface Tables/Views region, you will find the selected table details displayed in a separate page. This open interface details page contains a table listing the interface table columns and their attributes, including a table column data type, data length, data precision, and data scale for each column, and whether the column is required or not.

Open Interface Table Details

the picture is described in the document text

Interface View Information

The general section of the interface view information page displays common information for the selected interface view.

Open Interface View List

the picture is described in the document text

Interface View Information Page

the picture is described in the document text

This page also contains a table listing the interface view columns and their attributes, including the data type, data length, data precision, and data scale for each view column.

EDI Message Information

The general section of the EDI message information page displays common information for the selected EDI message.

EDI message information page

the picture is described in the document text

The EDI Message information page also displays the message direction in the Direction field:

Business Event Information

The general section of the Business Event displays common information for business event.

Business Event Details Page

the picture is described in the document text

An integration repository administrator can perform the administrative tasks:

For more information about subscribing to business events, see Subscribing to Business Events, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.