Edit

Share via

Generate a WCF client or a WCF service contract for Oracle E-Business Suite solution artifacts

  • Article

You can use the Add Adapter Service Reference Visual Studio Plug-in to generate a WCF client class or a WCF service contract (interface) targeted at selected operations on Oracle E-Business Suite artifacts. You can also use the ServiceModel Metadata Utility Tool (svcutil.exe) to generate the WCF client class or WCF service contract; however, the Add Adapter Service Reference Plug-in exposes the functionality of the ServiceModel Metadata Utility Tool through a standard Microsoft Windows interface. It also provides browse and search capabilities that are not available with the svcutil.exe tool, and it generates a configuration file based on the binding properties that you select when you connect to the Oracle E-Business Suite.

Generating a Client Class by Using the Add Adapter Service Reference Plug-in

Perform the following steps to generate a WCF client class by using the Add Adapter Service Reference Plug-in.

To generate a WCF client class

  1. In Visual Studio Solution Explorer, right-click your project, and then click Add Adapter Service Reference.

  2. After the Add Adapter Service Reference dialog box opens, follow the steps in Retrieving Metadata for Oracle E-Business Suite Operations in Visual Studio to connect to the Oracle E-Business Suite and browse and search for operations. To create a WCF client class for the operations that you select, be sure that Client (Outbound operations) is selected from the Select contract type drop-down list (this is the default).

  3. After you select all of the operations that you want to target, click OK to generate the WCF client class.

    The Add Adapter Service Reference Plug-in adds two files to your project:

  • OracleEBSBindingClient.cs. This file contains the generated WCF client class and helper code for the operations that you selected.

  • app.config. This file contains a binding configuration and client endpoint configurations. These configurations are based on the selections you made when you configured the binding and connection for the Add Adapter Service Reference Plug-in.

    Important

    While using the Add Adapter Service Reference Visual Studio Plug-in, if you do not specify a value for a binding property of type string and whose default value is null then that binding property will not be available in the app.config file. You must manually add the binding property and its value in the app.config file, if required.

Generating a WCF Service Contract by Using the Add Adapter Service Reference Plug-in

The adapter exposes inbound operations to enable Oracle E-Business Suite to send messages to an adapter client. For such operations you must generate a WCF service contract. This section provides information on how to generate a service contract for inbound operations exposed by the adapter.

Perform the following steps to generate a WCF service contract by using the Add Adapter Service Reference Plug-in.

To generate a WCF service contract for inbound operations

  1. In Visual Studio Solution Explorer, right-click your project, and then click Add Adapter Service Reference.

  2. After the Add Adapter Service Reference dialog box opens, follow the steps in Retrieving Metadata for Oracle E-Business Suite Operations in Visual Studio to connect to the Oracle E-Business Suite. There are several binding properties and a URI property that you may want to set when you connect to the Oracle E-Business Suite.

  3. After you have connected to the Oracle E-Business Suite, select Service (Inbound operations) from the Select contract type drop-down list.

  4. In the Select a category box, browse to the inbound operation for which you want to generate the service contract. For example, for Notification operation, click the root node (/), select Notification from the Available categories and operations box, and then click Add. For instructions on how to browse for inbound operations, see Browse, Search, and Retrieving Metadata for Oracle E-Business Suite Operations.

  5. To generate the WCF service contract for the operation, click OK.

    The Add Adapter Service Reference Plug-in adds three files to your project:

  • OracleEBSBindingInterface.cs. This file contains the generated WCF service contract (interface) and helper code for the inbound operation.

  • OracleEBSBindingService.cs. This file contains a class that implements the interface defined in OracleDBBindingInterface.cs. You can implement the business logic that processes the records returned by the inbound operation.

  • app.config. This file contains a binding configuration, endpoint behaviors, and service endpoint configuration that are based on the selections you made when you configured the binding and connection for the Add Adapter Service Reference Plug-in.

    Important

    While using the Add Adapter Service Reference Visual Studio Plug-in, if you do not specify a value for a binding property of type string and whose default value is null then that binding property will not be available in the app.config file. You must manually add the binding property and its value in the app.config file, if required.

Using svcutil.exe to Generate a WCF Client Class or a WCF Service Contract

You can use svcutil.exe to generate a WCF client class or a WCF service interface for your application. You must configure svcutil.exe to use it with the Oracle E-Business adapter.

Svcutil.exe generates the WCF client class or WCF service contract in an output file. The default file name is output.cs. You must manually include this file in your Visual Studio project. For more information about svcutil.exe, see https://go.microsoft.com/fwlink/?LinkId=139432.