Working with Native Integration Interfaces

This chapter covers the following topics:

Common Information

Each interface details page contains the following two types of information:

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

Common Information on Interface Details

When you click an interface name link from the Interface List page or the Search Interface page, the interface details page appears where you can view the selected interface information.

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

Common Information in the Interface Details Page

the picture is described in the document text

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, Open Interface Views, EDI, Business Service Object (Service Beans), Java, and Composite Service - BPEL.
For more information about interface type, see interface type.
Product An Oracle E-Business Suite application or component 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 by 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.
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 interface source can be one of the following:

  • Oracle- All Oracle seeded integration interfaces are categorized with this interface source type.

  • Custom- This indicates the interface is a custom integration interface or service.
My Oracle Support Included for an interface that has a related My Oracle Support Knowledge Document. Click the link to log on to My Oracle Support with a valid user name and password and view the Knowledge Document.
Documentation Included for an interface that has related online documentation. Click the link to view or download the documentation.
Online Help Provided for an interface that has related Oracle E-Business Suite online help. Click the link to view online help for the interface.

The following table describes each field contained in the Source Information region:

Field Notes
Source File It indicates the source code file for this interface, and its location in the file system.
Source Version It indicates the version of the source file. The first portion of the number corresponds to the base release version of Oracle E-Business Suite; 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 It represents 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 short name. 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 (short name) or license status.

Common Information on SOAP Web Services

For service-enabled interfaces, SOAP service information is displayed in the SOAP Web Service tab (or the Web Service region for XML Gateway interface only) no matter if the selected interface is currently exposed as a SOAP service or not.

Note: Web service is defined in a way that the interface forms the service and the methods or functions within the interface are defined as the operations of the service.

By default, an interface is not exposed as a SOAP service. Hence, the service status is 'Not Generated'. An integration administrator may transform the selected interface into a SOAP service. Once the service for the selected interface has been successfully generated, the service status will be changed from 'Not Generated' to 'Generated'.

Example of an Interface Details Page with SOAP Web Service Tab

the picture is described in the document text

The following fields are common in the SOAP Web Service tab or the Web Service region 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.

  • Not Generated: This indicates that the selected interface does not have a SOAP service generated.

  • 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: This button lets you regenerate the service if the interface definition has been changed or the selected interaction pattern information has been modified before service deployment.

    • Deploy: This button lets you deploy the generated SOAP service with active deployment state.

    • Reset: This button lets you clear up the existing service artifact and change the Web Service Status field from 'Generated' to 'Not Generated'.

  • Deployed: This indicates that the selected interface has been deployed to Oracle SOA Suite. A deployed service can have either one of the following states:

    • Deployed with 'Active' state: By default, the deployed service is in active state ('Deployed' with 'Active' state). This indicates that the deployed service is ready to be invoked and accept new SOAP requests. Once a service has been successfully deployed with 'Active' state, the following buttons appear:

      • Retire: This button lets you disable the active service. The SOAP Service Status field is changed to Deployed with 'Retired' state indicating that this deployed service will no longer accept new requests.

        This action also ensures that current running requests for the service are finished. Once a service has been retired ('Deployed' with 'Retired' state), the service is no longer to be invoked.

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

      • Reset: This button lets you clear up the existing service artifact and change the SOAP Service Status field from 'Deployed' with 'Active' to 'Not Generated'.

    • Deployed with 'Retired' state: Once a service has been retired ('Deployed' with 'Retired' state), the service is no longer to be invoked. It cannot accept new SOAP requests until it is activated ('Deployed' with 'Active' state). The following buttons appear for the service with 'Deployed' with 'Retired' state:

      • Activate: This button lets you change the retired service back to an active service again.

      • Undeploy: This button lets you undeploy the retired service from an Oracle SOA Suite managed server to the repository.

      • Reset: This button lets you reset the retired service to its initial state - 'Not Generated' if needed.


In addition to 'Not Generated', 'Generated', 'Deployed' with 'Active' state, and 'Deployed' with 'Retired' state, more intermediate SOAP 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 Web Service Status information:

  • Generating: This indicates that the selected interface is in the middle of the process of transforming the interface definition into a SOAP service. After this process completes successfully, 'Generated' is displayed in the Web Service Status field.

  • Regenerating: This indicates that the selected interface is in the middle of the process of regenerating the service. After this process is complete, 'Generated' is displayed in the Web Service Status field.

  • Deploying: This indicates that the selected interface is in the middle of the process of deploying the service. After this process is complete, 'Deployed' with 'Active' state is displayed in the Web Service Status field.

  • Undeploying: This indicates that the selected interface is in the middle of the process of undeploying the service. After this process is complete, 'Generated' state is displayed in the Web Service Status field.

  • Resetting: This indicates that the selected interface is in the middle of the process of removing the associated service artifact. After this process is complete, 'Not Generated' is displayed in the Web Service Status field.

  • Retiring: This indicates that the selected interface is in the middle of the process of disabling the active state. After this process is complete, 'Deployed' with 'Retired' state is displayed in the Web Service Status field indicating that the service is retired and cannot accept new SOAP requests.

  • Activating: This indicates that the selected interface is in the middle of the process of reverting the retired state back to active again. After this process is complete, 'Deployed' with 'Active' state is displayed in the Web Service Status field indicating that the deployed service is ready to accept new SOAP requests.
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.
Service Operations table This table displays the interface name along with the method names contained in the interface in a table. An integration administrator or an integration developer must select appropriate interaction patterns either at the interface level or at the method level before service generation.
After service generation, the selected interaction patterns are displayed for the interface or for specific methods contained in the interface. Click the interface name node to expand and view the interaction pattern selection for all the methods within the interface.
Note that this table is still updatable after service generation, but any changes to the table will be applied only after regenerating the service.
For more information on each field in the table, see Service Operations Table.
Interaction Pattern After service generation, this information is displayed which corresponds to the selected interaction patterns in the Service Operations table.
For example, if 'Synchronous' is selected for a specific method contained in a PL/SQL interface, and 'Asynchronous' is selected for another method within the interface, then both 'Synchronous' and 'Asynchronous' are shown in this field.

Note: XML Gateway, Concurrent Program, and Business Service Object interfaces can be service enabled only with synchronous support. Therefore, 'Synchronous' is displayed in the Interaction Pattern field for those interfaces by default if the service is available.
Authentication Type To secure web service content and authenticate web service operation, before deploying a generated service, an integration administrator must select one desired authentication type for the selected service in the Authentication Type field.

  • Username Token: This authentication type provides a user name and corresponding password 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 SOAP services relying on sending a user name 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 Administrator role can select and modify the authentication type. For other users, this field is displayed in read-only mode.

Service Operations Table

Oracle E-Business Suite Integrated SOA Gateway supports service generation synchronously, asynchronously, or both synchronously and asynchronously based on the selection made by the administrator or the integration developer in the Service Operations table.

Interaction Pattern Selection

Before service generation, the administrator or the integration developer must select appropriate interaction patterns either at the interface level or at the method level by expanding the interface name node to list all the methods within the interface.

After service generation, the Service Operations table is still updatable, but any changes will be applied only after service regeneration.

Note: In this release, asynchronous SOAP service operation is supported only in PL/SQL interface. Other SOAP service-enabled interface types including XML Gateway, Concurrent Program, and Business Service Object can be exposed as SOAP services with the synchronous support only.

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. It can be PL/SQL package name, the document name, or the Java service interface name.
Synchronous If the 'Synchronous' checkbox is selected for an interface or a specific method, the service or selected operation is generated with the support for synchronous interaction pattern.
That is when a web service client sends a SOAP request for this service, service is invoked and provides an immediate response to the web service client.
Asynchronous If the 'Asynchronous' checkbox is selected for an interface or a specific method, the service or selected operation is generated with the support for asynchronous interaction pattern. This type of service invocation may require a significant amount of time to process a request. However, the client that invoked the Oracle E-Business Suite service can continue with other processing in the meantime rather than waiting for the response.
In this release, asynchronous operation is supported in PL/SQL interface only.
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 available 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.
The Grant icon is shown only in the SOAP Web Service tab.

Performing Administrative Activities for SOAP Web Services

Users who have the Integration Administrator role can perform administrative tasks in the SOAP Web Service tab of an interface that can be exposed as a SOAP service. These tasks include generating, deploying, undeploying, resetting, retiring, and activating SOAP services by clicking the following buttons in the interface details page:

SOAP Web Service Tab for Performing Administrative Tasks

the picture is described in the document text

Additional Information: In addition to performing service management activities in the Integration Repository tab, integration 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 an interface type of PL/SQL, Concurrent Program, Open Interface Table, Open Interface View, Business Service Object, Java Bean Services, or Application Module Services.

Example of an Interface Details Page with REST Web Service Tab

the picture is described in the document text

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 a number or a special character, such as #, $, %, _, - and more.

  • Do not end with a special character.

  • Characters such as ., _, and - are allowed in a 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 an Oracle E-Business Suite managed 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 Oracle E-Business Suite managed 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.
For Concurrent Programs, if a selected interface is deployed (with 'Deployed' status) as a REST service, this field appears along with the "POST" HTTP method.

Note: POST is the only supported HTTP method for Concurrent Programs.


For PL/SQL APIs, Business Service Objects, Java Bean Services, Application Module Services, Open Interface Tables, and Open Interface Views, the supported verbs are displayed in the Service Operations Table instead.
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 a user name and corresponding password when making a REST request that is typically over HTTPS. See: HTTP Basic Authentication, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

  • Security Token Authentication: This token-based 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 the 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.


Before deploying an interface as a REST service, an integration administrator must ensure that at least one authentication type is selected for use in authenticating users who invoke the REST services.
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 Administrator role can perform administrative tasks including deploying or undeploying services with desired service operations 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 (Concurrent Programs Only) This column appears when a selected Concurrent Program is exposed as a REST service. A "check" icon is shown in this column for the method or operation that is exposed as a REST service operation.

Note: Each concurrent program contains only one method. Once it is deployed as a REST service, the method contained in the concurrent program will be automatically marked with the "check" icon by default and deployed with the POST HTTP method only.
GET
(PL/SQL, Business Service Object, Java Bean Services, Application Module Services, and Open Interface Tables and Views Only)		 This GET method column appears when a selected interface is an interface type of PL/SQL, Business Service Object, Java Bean Services, Application Module Services, Open Interface Table, or Open Interface View.
For PL/SQL APIs, the GET checkbox is enabled only if the selected API is a simple data type. It is disabled if it's a complex data type.
For Business Service Object interfaces, the GET checkbox is enabled only if input parameters are of simple data types (String, Number, etc.). It is disabled if input parameters consist of complex data object types (AccountMergeRequest, etc.).
For Java Bean Services and Application Module Services, this GET checkbox is preselected if a Java or an Application Module method is annotated with the GET HTTP method. The administrator can uncheck the preselected GET checkbox for the Java or Application Module method if it will not be published with the GET method. However, if it is not annotated with the GET method, unlike the POST method, the GET checkbox becomes inactive or disabled for further selection.
For Open Interface Tables with Inbound direction, four HTTP methods (GET, POST, PUT, and DELETE) are all displayed. For Open Interface Tables with Outbound direction and Open Interface Views, only the GET method is displayed in the table.
POST
(PL/SQL, Business Service Object, Java Bean Services, Application Module Services, and Open Interface Tables with Inbound direction Only)		 This POST method column appears when a selected interface is an interface type of PL/SQL, Business Service Object, Java Bean Services, Application Module Services, or Open Interface Table with Inbound direction.
For PL/SQL APIs and Business Service Object interfaces, select the POST checkbox if desired for a method to be deployed as a REST service operation.
For Java Bean Services and Application Module Services, if a Java or an Application Module method is annotated with the POST method, similar to the GET method, this POST checkbox is preselected. The administrator can uncheck the preselected checkbox before deploying the service if the Java or Application Module method will not be published with the POST method. If it is not annotated with the POST method, unlike the GET method, the POST checkbox remains active or enabled by default. The administrator can still select the POST checkbox if needed for a method.
For Open Interface Table with Inbound direction, select the POST checkbox if desired for an interface table to be deployed as a REST service operation.
PUT (Open Interface Tables with Inbound direction Only) This HTTP method column appears only when the selected interface is an Open Interface Table with Inbound direction.
DELETE (Open Interface Tables with Inbound direction Only) This HTTP method column appears only when the selected interface is an Open Interface Table with Inbound direction.
Grant If the access permission of an operation has been granted to a specific user, user groups, or all users, then the Grant icon appears 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 Administrator role can perform the following administrative tasks in the REST Web Service tab of an interface that can be exposed as a REST service:

Note: For information about different user roles and their associated privileges to administer and view REST services, see Accessing Oracle Integration Repository.

REST Web Service Tab for Performing Administrative Tasks

the picture is described in the document text

Additional Information: Integration administrators can perform additional administrative tasks in the Administration tab to manage log settings, monitor inbound service invocation messages recorded through Service Monitor, and monitor outbound service invocations from Oracle E-Business Suite through Service Invocation Monitor. See:

Reviewing Web Service WSDL Sources

Once a SOAP service represented in WSDL has been successfully generated, the SOAP service status is changed from 'Not Generated' to 'Generated'. The WSDL link appears in the SOAP Web Service tab (or the Web Service region for XML Gateway interface) allowing you to view the WSDL description.

Generated WSDL and Deployed WSDL Descriptions

For a generated service before it is deployed, the WSDL description is an abstract definition of the message that has been transmitted. Once the service has been successfully deployed, the WSDL description contains concrete service binding and transport details.

For example, the following elements contain different URL information in the generated and deployed WSDL descriptions:

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

To view a generated WSDL file:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Analyst role. Select the Integration Repository 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.

  4. In the SOAP Web Service tab (or the Web Service region for XML Gateway interface), click the View WSDL link to view the WSDL source code.

    The following sample shows the generated WSDL description with synchronous interaction pattern for the PL/SQL interface PA_COST_PLUS:

    <?xml version="1.0" encoding="UTF-8" standalone="no" ?> 
<definitions xmlns:tns="http://xmlns.oracle.com/apps/pa/soaprovider/plsql/pa_cost_plus/" 
 xmlns="http://schemas.xmlsoap.org/wsdl/" 
 xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
 xmlns:tns1="http://xmlns.oracle.com/apps/pa/soaprovider/plsql/pa_cost_plus/get_burden_amount/" name="PA_COST_PLUS" 
 targetNamespace="http://xmlns.oracle.com/apps/pa/soaprovider/plsql/pa_cost_plus/">
<types>
<schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" 
 targetNamespace="http://xmlns.oracle.com/apps/pa/soaprovider/plsql/pa_cost_plus/get_burden_amount/"> 
 <include schemaLocation="http://<hostname>:<port>/ISG-ISG-context-root/isgapp/plsql/pa_cost_plus/APPS_PA_COST_PLUS_GET_BURDEN_AMOUNT.xsd"/>
</schema> 
<schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
 targetNamespace="http://xhttp://xmlns.oracle.com/apps/pa/soaprovider/plsql/pa_cost_plus/">
   <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>
<message name="GET_BURDEN_AMOUNT_Input_Msg">
<part name="header" element="tns:SOAHeader" /> 
<part name="body" element="tns1:InputParameters" /> 
</message>
<message name="GET_BURDEN_AMOUNT_Output_Msg">
<part name="body" element="tns1:OutputParameters" /> 
</message>
<portType name="PA_COST_PLUS_PortType">
<operation name="GET_BURDEN_AMOUNT">
<input message="tns:GET_BURDEN_AMOUNT_Input_Msg" />
<output message="tns:GET_BURDEN_AMOUNT_Output_Msg" /> 
</operation>
</portType>
<binding name="PA_COST_PLUS_Binding" type="tns:PA_COST_PLUS_PortType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" /> 
<operation name="GET_BURDEN_AMOUNT">
<soap:operation soapAction="GET_BURDEN_AMOUNT" /> 
<input>
<soap:header message="tns:GET_BURDEN_AMOUNT_Input_Msg" part="header" use="literal" /> 
<soap:body parts="body" use="literal" /> 
</input>
<output>
<soap:body use="literal" /> 
</output>
</operation>
</binding>
<service name="PA_COST_PLUS_Service">
<port name="PA_COST_PLUS_Port" binding="tns:PA_COST_PLUS_Binding">
<soap:address location="#NOT_DEPLOYED#" /> 
</port>
</service>
</definitions>

    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 application context during service invocation.

    Note that NLS Language and Organization ID are optional values to be passed. However, if the invocation 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 Other Web Service Input Message Parts, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

    The user name and password are defined by the web service security policy (such as oracle/wss_username_token_service_policy). Detailed instructions on how to pass the security headers along with the SOAP request, see Configuring Web Service Policies, 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:

Once a service has been successfully deployed to an Oracle SOA Suite WebLogic managed server, the SOAP service status is changed from 'Not Generated' to 'Deployed' with 'Active' state along with the selected authentication type. Click the View WSDL link to view the deployed WSDL file.

The following sample shows the deployed WSDL description with synchronous interaction pattern for the same PL/SQL interface PA_COST_PLUS:

<?xml version="1.0" encoding="UTF-8" ?> 
...
<wsp:Policy xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy" 
...
</wsp:Policy>
<types>
<schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" 
 targetNamespace="http://xmlns.oracle.com/apps/pa/soaprovider/plsql/pa_cost_plus/get_burden_amount/"> 
<include schemaLocation=http://"<soa_suite_hostname>:<port>/soa-infra/services/default/<jndi_name>_PLSQL_PA_COST_PLUS/PA_COST_PLUS_Service?XSD=xsd/APPS_PA_COST_PLUS_GET_BURDEN_AMOUNT.xsd" /> 
</schema> 
<schema xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
...
</schema>
</type>
...
<service name="PA_COST_PLUS_Service">
<port name="PA_COST_PLUS_Port" binding="tns:PA_COST_PLUS_Binding">
<soap:address location="http://"<soa_suite_hostname>:<port>/soa-infra/services/default/<jndi_name>_PLSQL_PA_COST_PLUS/PA_COST_PLUS_Service" />  
</port>
</service>
</definitions>

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="http://<hostname>:<port>/webservices/rest/Invoice/?XSD=CREATE_INVOICE_SYNCH_TYPEDEF.xsd" /> 
                <include xmlns="http://www.w3.org/2001/XMLSchema" href="http://<hostname>:<port>/webservices/rest/Invoice/?XSD=CREATE_SINGLE_INVOICE_SYNCH_TYPEDEF.xsd" /> 
        </grammars>
        <resources base="http://<hostname>:<port>/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://<hostname>:<port>/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'.

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

If the deployed REST service is an interface type of PL/SQL, Business Service Object, Java Bean Services, or Application Module Services, then both the 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 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>
                <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 Integration Analyst role. Select the Integration Repository 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 administrators or users who have the Integration Administrator role can create security grants by authorizing the access permissions of interface methods (or procedures and functions) to a user, a user group, or all users. Similarly, the administrators can revoke the grants from an authorized user, user group, or all users on a selected method or service.

Managing Grants in the Grants Tab

Interface types that have the security grant feature available are PL/SQL, Concurrent Program, Business Service Object, Java Bean Services, Application Module Services, and Open Interface Table and View. You can manage grants for these interfaces using the Grants tab in the interface details page.

Note: Security grants for XML Gateway interfaces are managed in the Trading Partner User Setup Form although XML Gateway interfaces can only be exposed as SOAP services. See Managing XML Gateway User Security in the Trading Partner User Setup Form.

Interface Details Page with Grants Tab Highlighted

the picture is described in the document text

Note that the grant feature applies to the interfaces that can be exposed as both SOAP and REST services. These interfaces are PL/SQL, Concurrent Program, and Business Service Object.

For example, when a user (OPERATIONS) is authorized to have access permission on a PL/SQL API method name called 'Create Credit Request', the user will have the permission to access the associated 'Create Credit Request' service operations of both SOAP and REST service types through the same grant.

Creating Security Grants

To create a grant, select appropriate method name checkboxes in the Grants tab. Click Create Grant to open the Create Grants page.

Create Grants Page

the picture is described in the document text

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 and the associated SOAP and REST services if available.

Revoking Security Grants

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 Grants tab, see Managing Security Grants for the SOAP and REST Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

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

For XML Gateway interfaces, authorizing users to perform XML Gateway inbound transactions with a trading partner is performed in Oracle XML Gateway instead. 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.

XML Gateway Map Information

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

XML Gateway Map Basic Structure

the picture is described in the document text

The XML Gateway Map information page includes standard fields shown in the common region of the selected XML Gateway interface along with the Web Service region and Method region.

For XML Gateway interface, it can be either inbound or outbound direction. An inbound XML Gateway map indicates that the interface receives incoming transactions or messages into the Oracle E-Business Suite. An outbound map indicates that the interface sends outgoing transactions or messages to another system. For more common information shown in the interface details page, see Common Information on Interface Details.

XML Gateway Interface Details Page with Show Generic XML Gateway Service Link Highlighted

the picture is described in the document text

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 and function details:

PL/SQL Interface Basic Structure

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 Administrator role can find an additional Grants tab displayed in the interface details page. This 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.

PL/SQL Interface Details Page

the picture is described in the document text

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.

Java Interface Basic Structure

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

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 Information

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

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:

Java Bean Services Basic Structure

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 administrator can find an additional Grants tab displayed in the page. This Grants tab allows the integration 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.

For more information about web services, see Understanding Web Services.

Java Bean Service Interface Details Page

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:

Application Module Services Basic Structure

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.

For more information about web services, see Understanding Web Services.

Application Module Service Interface Details Page

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 search information in the combination of Category (subtype) and Category Value (Security Services) fields.

Search Page with Criteria for Security Services

the picture is described in the document text

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.

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 processing 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 interfaces are not serviceable interfaces and cannot be exposed as SOAP services. Refer to My Oracle Support Knowledge Document 966982.1 for the suggested alternatives to the existing Java APIs for Forms interfaces.

Business Service Object

Business service object (BSO) interface type, formerly known as service bean, provides the access to SOA services and facilitates integration between Oracle E-Business Suite and trading partners. This type of interfaces can be used directly or exposed as SOAP or REST services. BSO interface type often employs service data objects as parameters to pass complex data.

A service data objects (SDO) defines a generic API for accessing and manipulating structured data. 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, but rather an object used by one or more Java service interfaces or other service data objects to pass data. Oracle Integration Repository includes it on list of interface types, so that 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:

Business Service Object Interface Basic Structure

the picture is described in the document text

Business Service Object Interface Details Page

This interface type can be exposed as both SOAP services and REST services. Therefore, the interface details page includes general section of a selected business service object interface, the Overview tab, the SOAP Web Service tab, and the REST Web Service tab.

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

Business Service Object Interface Details Page

the picture is described in the document text

For more information about web services, see Understanding Web Services.

Business Service Object Interface Method Information

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

Business Service Object Method Details Page

the picture is described in the document text

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

The following regions also appear on the method details page:

Integration Repository Service

Based on business service object interface, Integration Repository Service is a service component in the 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.

Integration administrators or users who have the Integration Administrator role can create security grants by authorizing each business service object method contained in the service to a user, a user group, or all users. For more information, see Managing Grants.

Use the following steps to locate the Integration Repository Service:

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

  2. Click Search.

  3. Enter the following information in the Search page:

    • Product Family: Application Technology

    • Interface Type: Business Service Object

  4. Click Go to run the search.

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

    This opens the Business Service Object interface details page.

    See: Business Service Object Interface Details Page.

  6. Click a method name link to get to business service object method details.

    See: Business Service Object Method Information.

Viewing WSDL Description

In the SOAP Web Service tab, if the selected business service object has an associated SOAP service available, click the View WSDL link 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>/ISG-ISG-context-root/isgapp/apps/bso/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 application context during service invocation.

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

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

The user name and password are defined by the web service security policy (such as oracle/wss_username_token_service_policy). Detailed instructions on how to pass the security headers along with the SOAP request, see Configuring Web Service Policies, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

If error occurred, the following error message information appears under <Method>_Response:

...
<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. The Message element will appear as warning messages in the SOAP response. It is used to display any warning message 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 1315485.1.

Reviewing Service Data Object

A service data objects (SDO) defines a generic API for accessing and manipulating structured data. 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

The service data object details page is accessible directly from the Integration Repository browse interface through the list of interface types. It is also accessible from the getDataList and processDataList method details pages.

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

Service Data Object Basic Structure

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.

Note: An XML schema describes the structure of an XML document with all input and output message definitions and data types.

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

Filter Data Object Information

The filer data object details page is accessible only from the getDataList method details page.

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

Filter Data Object Basic Structure

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 Oracle Application Framework Developer's Guide, available from My Oracle Support Knowledge Document 1315485.1.

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

The following regions also appear on the filter object details 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 details page appears when you click a method name on the service data object details page or the filter data object details page.

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

Concurrent Program Information

The following diagram illustrates the basic structure of the concurrent program information page.

Concurrent Program Basic Structure

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

The concurrent program details page contains the following information:

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: Oracle Integration Repository supports REST service enablement for Open Interface Tables and Views. If a concurrent program is linked to an open interface table or view, this concurrent program can be viewed and displayed under the Open Interface category and can be available as a REST service.

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; therefore, the Interface Type in the header region of the Open Interface details page is categorized as "Concurrent Program & Open Interface".

This type of interface stores the interface data, including active status, and whether it stores data inbound to Oracle E-Business Suite or outbound to another system.

The following diagram illustrates the basic structure of the Open Interface information and its connection to the related interface table or view information page.

Open Interface Basic Structure

the picture is described in the document text

Open Interface integrations can be available as REST based web services. The interface details page includes general section of a selected open interface, the Overview tab and the REST Web Service tab.

Users who have the Integration 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.

Open Interface Information

The Open Interface details page appears when you click an Open Interface name from the interface list table in the Integration Repository.

Open Interface Details Page

the picture is described in the document text

The Open Interface details page contains the following information:

Open Interface Table Details Page

Click a name link in the Open Interface Tables table to display the selected Open Interface Table details page containing interface table columns and their attributes, such as data type, data length, data precision, data scale, and data requirement.

Open Interface Table Details Page

the picture is described in the document text

Interface View Information

When you click the Open Interface view name from the interface list table in the Integration Repository, the Open Interface View details page appears.

Open Interface View Details Page

the picture is described in the document text

Similar to the interface details page for open interface table, the open interface view details page contains the following information:

EDI Message Information

Oracle E-Business Suite Integrated SOA Gateway does not support service enablement for EDI messages; therefore, the EDI interface details page contains only general interface information.

EDI interface Details Page

the picture is described in the document text

The EDI Message interface details page displays the message direction in the Direction field:

For more information on the general section, see Common Information.

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

Only users who have the Integration Administrator role 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.