Refer to Choosing WCF or Web API for additional information on WCF and Web API.
This presentation project provides a WCF RESTful service interface for a ClearPath Data Source application. This project uses ASP.Net Compatibility mode.
The Web.config file comes configured with a webHttpBinding(name = RestBinding), and an endpointBehavior(name = RestBehavior) suitable for use by the RESTful Web service.
Notes:
If you are creating a new RESTful web service, it is recommended that you use the Web API RESTful Service Application rather than this project type.
Refer to Creating a RESTful Web Service Application for more information.
If you select .NET Framework 4 or later when creating the presentation project, then the default Web.config file is configured with the helpEnabled flag set to true. This allows the web service user to access a help page for the web service.
Procedure 1 - Creating a WCF RESTful Service Application
In Solution Explorer, right-click the solution node, click Add, click New Project...
In the Create a new project dialog box, do the following:
Notes:
Select C# or All Languages from the Language list.
Select Windows or All Platforms from the Platform list.
The ePortal templates are not displayed if other values are selected.
Select ePortal Previous Versions from the Project Type list.
The ePortal Previous Versions templates are displayed.
Do any one of the following to select the template:
From the templates list, select WCF RESTful Service Application, and then click Next.
Enter WCF RESTful Service Application in the search option, select the template from the search result, and then click Next.
Optionally, change the Project name, Location, and Framework, and click Create.
Notes:
If you do not select a desired Framework, a default Framework version is selected.
For information on selecting the .NET version, refer to Multi-Targeting Issues.
On the Presentation Generation Target dialog, enter values for the generation. Refer to Presentation Generation Properties for a WCF RESTful Service Application.
Click OK. The presentation project appears in Solution Explorer.
Procedure 2 - Building the Project
In Solution Explorer, right-click the WCF RESTful Service Application project node, and then click Build. Refer to Building Your ePortal Solution for more information.
When the project is built, ePortal generates the files to implement a Web Services Application based on the data source.
Refer to Consuming the Web Service Methods by a Web Service Client for information about using the methods in a Web service client.
Generated Files
Building the project generates the following files:
In the App_Data directory: data source specific data files
In the project root directory: Service.svc, ApplicationInfo.xml file, epconfig files, epuo file and Web.config. The Web.config file specifies the endpoint, binding, and behavior of the Web Service.
In the App_Code directory: IService.cs, Service.cs. IService.cs contains the definition of the service contract. Service.cs contains the code that implements the service contract.
Procedure 3 - Preparing to use the Presentation Project
To prepare to use a project, you must modify the Web.config file.
Modifying the Web.config File
The Web.config file comes configured with a webHttpBinding(name = RestBinding), and an endpointBehavior(name = RestBehavior) suitable for use by the RESTful Web service.
If you selected .NET Framework 4 or later when creating the presentation project, then the default Web.config file is configured with the helpEnabled flag set to true. This allows the web service user to access a help page for the web service.
For information, refer to Modifying the Web.config File.
Procedure 4 - Testing
Refer to Testing a Presentation Project
Procedure 5 - Modifying the Service.svc File
When you build the solution, ePortal Developer sets the Service.svc file as the following example shows:
<%@ ServiceHost Language="C#" Debug="true" Service="WcfRESTfulService1.Service" Factory="ServiceFactory" CodeBehind="~/App_Code/Service.cs, WebSupport.dll" %>
Before you stage the Web site to ePortal, set the Debug option to false.
Next Step