Oracle E-Business Suite Integrated SOA Gateway User's Guide Release 12.1 Part Number E12064-06 | ![]() Contents | ![]() Previous | ![]() Next |
This chapter covers the following topics:
The details page of each integration interface type contains the following two types of information:
Interface detail information
This interface detail information includes a header region with general information, a description region, a source region, and an interface methods or procedure and functions region.
Integration repository administrators can perform additional administrative tasks including generating a Web service for a selected interface type if the type has a Web service enabled, subscribing to a business event, and creating security grants for appropriate users.
For more information on interface details, see Common Information on Interface Details.
Interface Web service information
Once an integration interface definition is transformed into a Web service representing in WSDL format, then the Web Service - SOA Provider region by default appears in the details page if it is not an interface type of XML Gateway Map or Business Service Object. The Web Service Status field is also marked as 'Generated' to indicate that the status of this Web service.
If a generated Web service has been successfully deployed by the administrator, then 'Deployed' appears in the Web Service Status field along with the selected authentication type(s) in read-only mode. Users with administrator privileges can redeploy or undeploy the service again if needed.
For more information on Web services, see Common Information on Web Services.
Interface Details Page
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.
Important: Information specific to Web services is discussed under Understanding Service Enablement.
Information specific to composite services is discussed under Working with Composite Services.
Each interface information page includes a header region with general information about the interface. 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 | The interface type.
Note: This field does not appear for Java service interfaces. |
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:
|
Scope | The scope can be one of the following:
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:
Integration repository administrators or only users granted with the integration repository administrator role can find the following buttons available in the interface details page:
Generate WSDL: This generates a Web service WSDL file for a selected interface. If the file is generated successfully, you will find the Web Service region becomes available. Regenerate WSDL also appears in the details page allowing you to regenerate the service again if needed. For more service generation information, see Generating Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Deploy (Redeploy or Undeploy)
If the service has already been generated successfully, the administrators can find Deploy available in the Web Service region for the selected integration interface.
If a service has been deployed, the administrators can find Redeploy (or Undeploy) available instead. This allows the administrators to redeploy or undeploy the deployed Web service if needed.
Prior to deploying or redeploying the service to the application server, the administrators must first select at least one authentication type for the generated service. This allows SOA Provider services the deployment based on the selected type(s). For more service deployment information, see Deploying and Undeploying Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Create Grant: This allows the administrators to create security grants by authorizing the access permission of a selected interface method or a procedure or function to an appropriate user, a user group or all users.
Oracle Integration Repository also provides a feature to revoke the grants for a particular user for a selected method or service.
For more information on managing function security through security grants, see Managing Grants.
View Log
This allows the administrators to view the logs generated during service generation and deployment. If logging is enabled for specific services or all services at the Site level only, administrators can find View Log in the Interface Details page. Click View Log to open the Log Details page where you can view log details compiled in the log table. You can also delete and export log messages retrieved in the Log Details page if needed. For more information, see Viewing Generate and Deploy Time Logs, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
To view the logs written in SOA Monitor during the invocation of Oracle E-Business Suite services by Web service clients, see Viewing Service Processing Logs, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Note: 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:
SOA Monitor subtab: This allows the administrators to monitor and audit all SOAP messages in and out through SOA Provider and view the message details.
For information about how to use SOA Monitor, see Monitoring and Managing SOAP Messages Using SOA Monitor, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Log subtab: This allows the administrators to enable and configure log setups.
For information about log configuration, see Logging for Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Web service information is displayed in the appropriate Web Service region 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 granted with 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
For XML Gateway Map interface type
Because it can be supported by both Web Service Provider in Release 12.0 and by SOA Provider in this release, for backward compatibility, a profile option FND: XML Gateway Map Service Provider is used to let you select an appropriate service provider in enabling services for XML Gateway Map interface type. Based on your selected profile value, the interface details page can display the 'Web Service - Web Service Provider region' or 'Web Service - SOA Provider region', or displayed both regions at the same time if a service is generated successfully.
For Business Service Object interface type
Web Service Provider supports the service enablement for Business Service Object interface type in Release 12.0 and will continue to support it in this release; therefore, the Web Service - Web Service Provider region will be displayed if a service is generated successfully.
Note: The Business Service Object interface type is not supported by SOA Provider.
From the appropriate Web service region, you can perform the following tasks:
Review the status of a selected Web service. The Web Service Status field can be one of the following values:
Generated: Indicates that a selected interface has a Web service available, but the service has not yet been deployed.
Deployed: Indicates that a selected interface not only has a Web service available, but also the service has been deployed.
Review WSDL code once a Web service has been generated or deployed successfully.
Review selected authentication type(s) with read-only text once a Web service has been deployed successfully.
To secure Web service content and authenticate Web service operation, SOA Provider supports multiple authentication types for inbound service requests. Before deploying a generated service, an integration repository administrator must select at least one 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 for a Web service provider to use in authenticating the SOAP request.
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.
The administrator can undeploy or redeploy the Web service if needed.
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 granted with 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.
XML Gateway Map and Business Service Object (formerly known as Service Bean) interface types are supported by Web Service Provider for service enablement in Release 12.0. In this release, Web Service Provider will continue to support the Business Service Object interface type, while XML Gateway Map along with PL/SQL, Concurrent Program, and Composite Service BPEL are supported by SOA Provider. Business Event interface type is supported by SOA Provider through the subscription model.
For XML Gateway Map interface type service enabled by Web Service Provider in Release 12.0, you will find a standard and deployed XML Gateway WSDL URL displayed with the 'Web Service Status - Deployed' status in the Web Service - Web Service Provider region.
For more information on service enablement support for XML Gateway Map interface type, see XML Gateway Map Web Service Region.
Viewing Web Service WSDL Information
To view WSDL file:
Log on to Oracle Integration Repository and locate your desired interface definition through a search or from the navigation tree.
Click the interface name to open the interface details.
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.
Oracle E-Business Suite Integrated SOA Gateway allows integration repository administrators to perform the following tasks:
Generating or Regenerating Web Services
Oracle Integration Repository allows integration repository administrators to transform integration interface definitions into a format that complies with Web standards using WSDL to define Web services. Once the WSDL file is generated successfully, a Web Service region becomes visible in the interface details page.
Note: Because XML Gateway Map can be supported by both Web Service Provider and SOA Provider for service enablement, there might have more than one Web Service region available for XML Gateway Map interface type depending on the profile value set in the 'FND: XML Gateway Map Service Provider' profile option. See: XML Gateway Map Web Service Region.
Please note that only integration repository administrators can perform this task. See: Generating Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Deploying, Undeploying, and Redeploying Web Services
If a Web service has been generated successfully, then an integration repository administrator can find Deploy in the Web Service region of an interface details page.
SOA provider supports multiple authentication types for inbound service requests; therefore, prior to deploying or redeploying a Web service, an integration repository administrator must first select at least one of the following authentication types:
Username Token
This authentication type provides username and password information in the security header for a Web service provider to use in authenticating the SOAP request. It is the concept of Oracle E-Business Suite username/password (or the username/password created through the Users window in defining an application user).
SAML Token (Sender Vouches)
This authentication type is used for Web services relying on sending a username only through SAML Assertion.
If the Web service is successfully deployed, the Web Service Status field will be updated to 'Deployed'. The View WSDL link appears along with the selected authentication type(s) for the deployed Web service. Click the View WSDL link to view the deployed WSDL code. In addition, the following buttons appear:
Undeploy: This allows the administrator to undeploy the Web service if needed.
Redeploy: This allows the administrator to redeploy the Web service if needed. If changes are made to the authentication type, the Web service must be redeployed.
See: Deploying and Undeploying Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Subscribing to Business Events
Integration repository administrators can subscribe to selected business events in the event details page and create subscriptions for the selected events.
Once events are subscribed, the administrators can unsubscribe them if needed.
For more information, see Subscribing to Business Events, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Viewing Generate and Deploy Time Logs
Integration repository administrators can view and download the logs recorded during service generation and deployment for specific services or all services that have the logging enabled at the Site level only.
For more information, see Viewing Generate and Deploy Time Logs, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Configuring Log Setups
Integration repository administrators can have the privileges to access the log configuration page to enable and configure log setups at the site level and user level for all services or specific services or operations. With appropriate log setups and configuration, you can easily monitor system activities, track and view log messages, and troubleshoot any issues encountered at each stage of service development life cycle.
For more information on SOA logging framework and how to enable and configure logs, see Logging for Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Monitoring SOAP Messages Using SOA Monitor
In addition to transforming interface definitions into Web services and deploying them, integration repository administrators can have the privilege to access SOA Monitor to monitor and audit all SOAP messages in and out from the SOA Provider (if the SOA auditing feature is enabled).
This SOAP message monitoring tool allows any operation error if incurred during the message exchanges to be identified and audited. The administrators can search and view SOAP request and response message details, and take necessary actions if needed to expedite the interaction between services and consumers.
For more information on how to use SOA Monitor, see Monitoring and Managing SOAP Messages Using SOA Monitor, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For more administrative tasks, see Oracle E-Business Suite Integrated SOA Gateway Implementation Guide for details.
Only integration repository administrators (or users granted with 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.
Note: Interface types that have the security grant feature available are PL/SQL, Concurrent Program, Business Event, Business Service Object, and Java interfaces.
Oracle Integration Repository also allows the administrators to revoke the grants for a particular user on a selected event or service.
To create a grant
In the interface details page, select appropriate method name check boxes in the Methods region or appropriate procedure and function names in the Procedures and Functions region. Click Create Grant to open the Create Grants page.
Create Grants
Note: Each of the overloaded function contained in an interface can be uniquely granted to a specific user, user group, or all users through the create grant feature. If you select more than one overloaded function, an Overloaded column appears in the selected methods table indicating more than one overloaded function is selected for the grant.
From here, you can select a grantee type and grantee name if applicable and click Apply.
To revoke a grant
In the interface details page, select the Show link for the method or procedure and function that you want to view or revoke the grant. The Grant Details section of the selected method or procedure and function name appears detailing the grantee and grantee type information. Click the Revoke icon for the grant that you want to revoke to revoke the grant.
Note: To create and revoke grants, you must log on to Oracle Integration Repository through the username granted with the integration repository administrator role.
For more information on security grants, see Managing Security Grants, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
The following diagram illustrates the basic structure of the XML Gateway Map information page and its connections to related pages:
The XML Gateway Map information page contains the following information:
If the XML gateway map is exposed as a Web service, appropriate Web Service region(s) will be available.
Methods Region
The Methods region links to one or more XML Gateway Method information pages.
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.
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:
WSP (Web Service Provider)
This displays the Web Service - Web Service Provider region if Web services are available.
Web Service - Web Service Provider region
XML Gateway Map with Web Service - Web Service Provider Region
In Release 12.0, XML Gateway Map interface type were deployed by default through Web Service Provider; therefore, you can find a standard XML Gateway WSDL URL displayed in this region with the 'Web Service Status - Deployed' status.
http://host.com:port/webservices/AppsWSProvider/oracle/apps/fnd/XMLGateway?wsdl
SOAP (SOA Provider)
This is the default profile value which displays the Web Service - SOA Provider region if Web services are available.
Web Service - SOA Provider region
Note: The default profile value is set to 'SOAP'. However, if you do not start from this release and your system is upgrading from Release 12.0, you must change the profile value from the default 'SOAP' to 'Both' because Web Service Provider could have already been used in enabling services. To continue having service enabled using SOA Provider and for backward compatibility, both service providers should be enabled in transforming XML Gateway Map interface definitions into Web services. Otherwise, a fault message appears if it is still set to the default profile value 'SOAP' (SOA Provider).
If you start with Rapid Install of Oracle E-Business Suite for this release, the default service provider is SOA Provider ('SOAP' profile value). In this situation, Web Service Provider will be disabled and any invocations of generic XML Gateway Web services will return a fault message.
XML Gateway Map with Web Service - SOA Provider Region
The View WSDL link is available along with appropriate Web Service Status information in the Web Service - SOA Provider region indicating whether the service is generated or deployed. For information on viewing WSDL description, see Reviewing Web Service WSDL Source.
To secure Web service content and authenticate Web service operation, SOA Provider supports multiple authentication types for inbound service requests. In addition to the Web Service Status field and View WSDL link, you can find the Authentication Type field with the following read-only check boxes:
Username Token: This authentication type provides username and password information in the security header for a Web service provider to use in authenticating the SOAP request.
SAML Token (Sender Vouches): This authentication type is used for Web services relying on sending a username only through SAML Assertion.
Before an integration repository administrator deploys a generated service, the administrator must select at least one authentication type for the selected service. See: Deploying and Undeploying Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Both
This displays both the Web Service - Web Service Provider region and Web Service - SOA Provider region in the interface details page if Web services are available.
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:
Deploy: Deploys the Web service.
Undeploy: Undeploys a Web service if the service has been deployed.
Redeploy: Redeploys the Web service if needed.
See: Performing Additional Web Service Activities.
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 general section of this page displays common information for the XML Gateway method, plus the following additional field:
Direction
Inbound indicates that the interface receives incoming transactions or messages into the Oracle E-Business Suite.
Outbound indicates that the interface sends outgoing transactions or messages to another system.
This page also contains a table listing the XML Gateway method parameters, including each parameter's data type and whether the parameter is required.
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:
The PL/SQL information details page contains the following information:
Web Service - SOA Provider Region
If the PL/SQL is exposed as a Web service, the Web Service - SOA Provider region will be available. This region provides a link to a page containing the Web service WSDL source code.
The View WSDL link is available along with appropriate Web Service Status information in the Web Service - SOA Provider region indicating whether the service is generated or deployed.
Additionally, you can find the Authentication Type field with the following read-only check boxes:
Username Token: This authentication type provides username and password information in the security header for a Web service provider to use in authenticating the SOAP request.
SAML Token (Sender Vouches): This authentication type is used for Web services relying on sending a username only through SAML Assertion.
These authentication types are used to secure Web service content and authenticate Web service operation. Before a service is deployed by an integration repository administrator, the administrator must select at least one authentication type for the service. For information on how to deploy a service, see: Deploying and Undeploying Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Note: For more information about Web services, see the following topics:
Procedure and Function Region
The PL/SQL Procedures and Functions region links to one or more PL/SQL Procedures and Functions pages.
The general section of the PL/SQL information page displays common information for the selected PL/SQL package.
PL/SQL information page
This page also contains a table listing the package procedures and functions, including active status and internal name. Click a procedure or function name to access its information page.
The PL/SQL procedure/function information page appears when you click a procedure or function name on the PL/SQL information page.
PL/SQL procedure/function information page
The general section of this page displays common information for the selected PL/SQL procedure or function, plus the Interface field. Click the link to view the interface that uses this package.
This page also displays the signature of this procedure or function, and it contains a table listing the procedure or function parameters and their attributes, including parameter name, data type, message direction (inbound or outbound), precision size, default value, and description.
Integration repository administrators (or users with the integration repository administrator role) can find the Create Grant button available which allows the administrators to grant the access of selected PL/SQL procedure and functions to a specific user, user group, or all users. See: Managing Grants.
The following diagram illustrates the basic structure of the Java information page and its connection to the related Java method information page.
The general section of the Java information page displays common information for the selected Java class.
Java information page
This page also contains a table listing the class methods, including active status and internal name. Click a method name to access its information page.
The Java method information page appears when you click a method name on the Java information page.
Java method information page
The general section of the Java method information page displays common information for the selected method, plus the following additional fields:
Interface
This Interface field displays the interface that uses this Java method. Click the link to view the interface details.
See Also
This See Also field displays a related Java method. Click a related Java method name link to view the Java method details.
This page also displays the signature of this method, and information about the return type, and it contains a table listing the method parameters.
Integration repository administrators (or users with the integration repository administrator role) can find the Create Grant button available which allows the administrators to grant the access of selected methods to a specific user, user group, or all users. See: Managing Grants.
Java APIs for Forms are categorized as a subtype of Java interface type. These specialized Java classes are XML document-based integration points wrapped in Java classes for executing business logic in Oracle Forms. Similar to other service enabled integration interface types, Java APIs for Forms interfaces can be service enabled through SOA Provider.
The following diagram illustrates the basic structure of the Java APIs for Forms information page:
Searching and Viewing Java APIs for Forms
To locate Java APIs for Forms interfaces, you must perform a search through the combination of Category (subtype) and Category Value (Java APIs for Forms) fields.
Click Search to access the main Search page, and then click Show More Search Options to display more search fields. Enter the following key search values along with any product family or scope if needed as the search criteria:
Category: Interface Subtype
Category Value: Java APIs for Forms
For information about category and category value fields, see Category and Category Value.
The general section of this page displays common information for the selected Java APIs for Forms. Additionally, the Interface Subtype field is displayed with 'Java APIs for Forms' value.
Java APIs for Forms Interface Details
The interface details page contains the following information:
Web Service - SOA Provider Region
If the Java APIs for Forms interface is exposed as a Web service, the Web Service - SOA Provider region will be available. You can find Web Service Status information for the selected Web service. Clicking the View WSDL link allows you to view the Web service WSDL source code.
Additionally, you can find the Authentication Type field with the following read-only check boxes:
Username Token: This authentication type provides username and password information in the security header for a Web service provider to use in authenticating the SOAP request.
SAML Token (Sender Vouches): This authentication type is used for Web services relying on sending a username only through SAML Assertion.
These authentication types are used to secure Web service content and authenticate Web service operation. Before a service is deployed by an integration repository administrator, the administrator must select at least one appropriate authentication type for the service. For information on how to deploy a service, see: Deploying and Undeploying Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Note: For more information about Web services, see the following topics:
Methods Region
The Methods region displays the associated method information, including active status, internal name, and description, in a table for the selected interface.
Integration repository administrators can create security grants by authorizing the access permission for a selected method name to an appropriate user, a user group, or all users.
For more information, see Managing Grants.
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:
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:
Web Service - Web Service Region
If the Business Service Object interface is exposed as a Web service, the Web Service - Web Service Provider region will be available.
The View WSDL link is provided with appropriate Web Service Status information in the Web Service - Web Service Provider region. The Authentication Type field along with two authentication type check boxes displayed in read-only mode.
For more information about Web service region for business service object, see Business Service Object Web Service Region.
Note: For more information about Web services, see the following topics:
Methods Region
This interface details page includes a table listing the business service object interface methods. Click a method name to access the information page for that method.
Note: In the list of methods, you can select one or more methods and specify which users can execute them.
For more information about the Method region for business service object, see Business Service Object Interface Method Information.
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 View WSDL link is provided with appropriate Web Service Status information in the Web Service - Web Service Provider region. Click the View WSDL link 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://myurl.us.oracle.com:1234/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:
The original output data
Warning messages if any (in <Message> element)
OAExceptions raised during the method invocation if any (in <ErrorMessage> element)
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.
Authentication Type
Additionally, you can find the Authentication Type field with the following read-only check boxes:
Username Token: This authentication type provides username and password information in the security header for a Web service provider to use in authenticating the SOAP request.
SAML Token (Sender Vouches): This authentication type is used for Web services relying on sending a username only through SAML Assertion.
These authentication types are used to secure Web service content and authenticate Web service operation. Before a service is deployed by an integration repository administrator, the administrator must select at least one authentication type for the service. For information on how to deploy a service, see: Deploying and Undeploying Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
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
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:
Signature
The region describes the interface method, parameter type, value, and return information.
Return
If the return type is a service data object, you can click the link in the Type field to access the service data object information page.
Parameters
If a parameter is a service data object, you can click the link in the Type column to access the service data object information page.
Integration repository administrators (or users with the integration repository administrator role) can find the Create Grant button available which allows the administrators to grant the access of selected methods to a specific user, user group, or all users. See: Managing Grants.
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 on to Oracle Integration Repository and use the following steps to navigate to Integration Repository Service:
Select Integration Repository responsibility from the Navigator menu, and click the Integration Repository link that appears.
Click Search.
Enter the following information in the Search page:
Product Family: Application Technology
Interface Type: Business Service Object
Click Go to execute the search.
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.
Click a method name link in the Methods region to get to business service object method details.
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.
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).
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 object information page and its connections to related pages.
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 following regions also appear on the service object information page:
Fields
Click a link in the Name column to view the field's complete attributes.
If the field type is a filter, you can click the link in the Type column to access the filter data object information page for that filter.
Alternate Key Sets
These are the key sets that can be used to identify an instance of this data object in the absence of the primary keys. These key sets are evaluated in the sequence specified.
Filters
The Filters region lists filters that can be used to filter data sources based on this service data object.
For example, data sources based on BaseDataSourceNameDomain service data object can be filtered by BaseDataSourceNameFilter filter data object.
Click the name of a filter (such as BaseDataSourceNameFilter) to access the selected filter data object information page.
Services
The Services region lists the services that directly use this service data object.
Click the name of a service to access the information page for a business service object interface that uses this service object.
Service Data Objects
This Service Data Objects region lists the data objects that directly reference this service data object.
Click the name of a service data object to access its information page.
Methods
Click a link in the Name column to access the service object method information page.
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.
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:
Expression Filter: Allows a client program to construct a simple or complex expression, including nested expressions.
Fixed Filter: Allows a simple list of attributes. This is used when the view object must do custom processing of filter attributes and the client program should not be allowed to build nested and complex filter expressions.
For more information on filters, see 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 following regions also appear on the service object information page:
Fields
Click a link in the Name column to view the field's complete attributes.
Associated Service Data Object
This region describes the associated service data object name that can be filtered by this selected filter data object.
Click the name of a service data object to access the service data object information page.
Methods
Click a link in the Name column to access the object method information page.
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
In addition to a description, the following regions also appear on the service data object method information page:
Signature
This region describes the interface method, parameter type, value, and return type information.
Parameters
This region contains descriptions of the parameters that are listed in the Signature region.
See Also
This region displays related service object methods. Click a related object method link to access the selected service object method details.
The following diagram illustrates the basic structure of the concurrent program information page.
The concurrent program details page contains the following information:
Web Service - SOA Provider Region
If the concurrent program is exposed as a Web service, the Web Service - SOA Provider region will be available.
The View WSDL link is available along with appropriate Web Service Status information in this region indicating whether the service is generated or deployed.
Additionally, you can find the Authentication Type field with the following read-only check boxes:
Username Token: This authentication type provides username and password information in the security header for a Web service provider to use in authenticating the SOAP request.
SAML Token (Sender Vouches): This authentication type is used for Web services relying on sending a username only through SAML Assertion.
These authentication types are used to secure Web service content and authenticate Web service operation. Before a service is deployed by an integration repository administrator, the administrator must select at least one authentication type. For information on how to deploy a service, see: Deploying and Undeploying Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For more information about Web Services, see
Methods Region
The Methods region displays its associated method information.
Integration repository administrators can create security grants by authorizing the access permission for a selected method name to an appropriate user, a user group, or all users. See Managing Grants.
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.
Concurrent program information page
The general section of the concurrent program information page displays common 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.
Note: The Type and Displayed columns are parameters used by Standard Report Submission (SRS).
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.
Open Interface table list
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.
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 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 general section of the interface view information page displays common information for the selected interface view.
Open Interface View List
Interface View Information Page
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.
The general section of the EDI message information page displays common information for the selected EDI message.
EDI message information page
The EDI Message information page also displays the message direction in the Direction field:
Inbound indicates that the interface is for receiving an incoming transaction or message into Oracle E-Business Suite.
Outbound indicates that the interface is for sending an outgoing transaction or message to another system.
The general section of the Business Event displays common information for business event.
An integration repository administrator can perform the administrative tasks:
Subscribe to an event
An administrator can find the Subscribe button available in the event details page if the selected event is not subscribed. Clicking the Subscribe button lets you subscribe to the selected business event. Internally, an event subscription is automatically created for that event with WF_BPEL_QAGENT as Out Agent. Once the event subscription has been successfully created, a confirmation message appears on the Business Event interface detail page.
To consume the business event message, you should register to dequeue the event from Advanced Queue WF_BPEL_Q. If a business event is enabled and if there is at least one subscriber registered to listen to WF_BPEL_Q, then the event message will be enqueued in WF_EVENT_T structure to Advanced Queue WF_BPEL_Q.
For more information on how to dequeue messages, see Oracle Streams Advanced Queuing User's Guide and Reference.
Unsubscribe the event
The Unsubscribe button becomes available in the details page if the selected event has been subscribed. Clicking the Unsubscribe button lets you remove or unsubscribe the event.
For more information about subscribing to business events, see Subscribing to Business Events, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Copyright © 2005, 2010, Oracle and/or its affiliates. All rights reserved.