Creating iWay Business Services for Oracle APIs

How to:

You can generate an iWay Business Service (also known as a web service) for Oracle E-Business Suite APIs. To generate an iWay Business Service, you must deploy the iWay Application Adapter for Oracle E-Business Suite in a business services environment using the iWay Business Services Provider (iBSP). iBSP exposes functionality as web services and serves as a gateway to heterogeneous back-end applications and databases.

A web service is a self-contained, modularized function that can be published and accessed across a network using open standards. It is the implementation of an interface by a component and is an executable entity. For the caller or sender, a web service can be considered a "black box" that may require input and delivers a result. Web services can be integrated within an enterprise as well as across enterprises on any communication technology stack, whether asynchronous or synchronous, in any format.

You can make a web service available to other services within a host server by generating WSDL (Web Services Description Language) from the web service.

Ensure that the servlet iBSP is properly configured. For more information on installing and deploying iWay components, see the iWay Installation and Configuration manual.

Note: Web services are not available in a J2EE Connector Architecture (JCA) implementation of an iWay adapter. When an adapter is deployed to use the iWay Connector for JCA, the Common Client Interface provides iWay services using the adapter. For more information, see the iWay Installation and Configuration manual and the iWay Connector for JCA User's Guide.
Top of page
x
Procedure: How to Create and Test a Web Service for a Stored Procedure

To create a web service for an Oracle E-Business Suite stored procedure:

  1. Connect to an Oracle E-Business Suite target, as described in Connecting to Oracle E-Business Suite.
  2. Locate and select a stored procedure under AR_RECEIPT_API_PUB, as described in How to Search for Packages.

  3. Right-click the stored procedure, for example, create_misc, and select Create iWay Business Service.

    The Create iWay Business Service dialog box opens, as shown in the following image.

  4. Perform the following steps:
    1. From the Existing Service Names drop-down list, select whether you want to create a new service name or use an existing service name.
    2. In the Service Name field, type a descriptive name for the iWay Business Service.
    3. In the Service Description field, type a brief description of the service (optional).
  5. Click Next.

    A second Create iWay Business Service dialog box opens and prompts you for additional information, as shown in the following image.

  6. Perform the following steps:
    1. From the License Name drop-down list, select a license definition.
    2. In the Method Name field, type a descriptive name for the method.
    3. In the Method Description field, type a brief description of the method (optional).
  7. Click OK.

    The iWay Business Services node expands in the left pane. The new iWay Business Service appears under the Services node.

    The following image shows an iWay Business Service called AR_RECEIPT_API_PUB_create_misc and, under that service, a method called create_misc.

    The right pane displays the name of the expanded iWay Business Service and provides a hyperlink to the selected method, for example, create_misc.

  8. Click the create_misc hyperlink in the right pane.

    An iWay Business Service test pane opens in your web browser, as shown in the following image.

  9. Enter a sample XML document in the input xml field that will query the service.

    For more information, see Sample Input XML.

  10. Click Invoke.

    The test response appears in the web browser.
Top of page
x
Reference: Sample Input XML

The following section provides a sample input XML document that can be used to test an iWay Business Service using iWay Explorer.

<APPS.sp.AR_RECEIPT_API_PUB.create_misc_Request>
<IWAY_ORAAPPS>Y</IWAY_ORAAPPS>
				<ORG_ID>204</ORG_ID>
<IWAY_ORAAPPS>Y</IWAY_ORAAPPS>
				<USER_ID>1</USER_ID>
				<APPLICATION_ID>222</APPLICATION_ID>
				<RESPONSIBILITY_ID>20678</RESPONSIBILITY_ID>
				<P_API_VERSION>1.0</P_API_VERSION>
				<P_INIT_MSG_LIST>T</P_INIT_MSG_LIST>
				<P_CURRENCY_CODE>USD</P_CURRENCY_CODE>
				
				<P_AMOUNT>477</P_AMOUNT>
				<P_RECEIPT_NUMBER>18257</P_RECEIPT_NUMBER>
				<P_RECEIPT_DATE>2005-12-12</P_RECEIPT_DATE>
				<P_GL_DATE>2005-12-12</P_GL_DATE>
				<P_RECEIVABLES_TRX_ID>1000</P_RECEIVABLES_TRX_ID>
				
				
				<P_RECEIPT_METHOD_ID>1002</P_RECEIPT_METHOD_ID>
				
				<P_ATTRIBUTE_RECORD recordType="">
					
					<ATTRIBUTE1>Chatura</ATTRIBUTE1>
					
				</P_ATTRIBUTE_RECORD>
				<P_GLOBAL_ATTRIBUTE_RECORD recordType="">
					
					<GLOBAL_ATTRIBUTE1>iway</GLOBAL_ATTRIBUTE1>
					
				</P_GLOBAL_ATTRIBUTE_RECORD>
				<P_COMMENTS>This is a test</P_COMMENTS>
				
			</APPS.sp.AR_RECEIPT_API_PUB.create_misc_Request>
iWay Software