Home > Platform > SolutionBuilder Guide > User Interface > Layout Templates > Use Cases > Develop and Register Web Service

Develop and Register Web Service

14 Dec 2017Last updated
0votes
10updates
50views

Overview

The Solution Builder provides a bunch of generic approaches which allow you to implement business logic even without coding. Very often the logic is tricky and cannot be implemented by standard means. The universal solution is implementing a custom Web Service and registering it in the Solution Builder Web Service Repository.

Goal

To introduce a custom web service registered in Solution Builder Web Service Repository, ready to be used in standard Solution Builder scenarios. 

Step 1: Implement Web Service Controller

Solution Builder works with REST services, which can be hosted anywhere. 

If you have no plans to create independent Web Application which takes care of hosting the custom Web Service and you want to share the Web Application Environment of a Solution Builder, you need to follow the same technological stack used for system Solution Builder Web Services implementation, or use MVC Web API. The name for the Web Service Class has to have suffix "Controller".

Step 2: Deploy new Web Service to Host

Copy the assembly(-ies) which contains the implementation of a new Web Service (Web API Controller) to the "bin" folder of a Web Application where you are going to host the Web Service. In case you plan to share the same application as Solution Builder (Service Management), copy assemblies to "svc/bin" folder. The IIS automatically detects the new available Web Service and creates endpoints for them.

Reference the new uploaded DLL in host.config file

Step 3: Synchronize Web Host 

Nevertheless the new Web Service available already in IIS, is still not visible in Solution Builder. To fix it, you need to trigger the synchronization procedure to update metadata for available Web Services. 

  1. Open Solution Builder application, Administration Home page and initiate the recording of the Customization Changes.
  2. Proceed to Administration/Integration/Web Servers management area. 
  3. Select the object which represents the Web Server to which the new Web Service has been deployed.
  4. Run the "Synchronize Server" action.

Step 4: Setup permissions

All new Web Services and Operations added to Repository on Synchronization by default are granted only to Administrators. Please use standard "Set Audience" action to configure right permissions for people who are allowed to execute the Web Operation. See Set Audience

 

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

(not set)
Customer
(not set)
icons-access-c.png