Setting up the Web Service Interface

Scenario: You want to create a connectivity to a Website, the mobile app, Flex client or a 3rd party program.

 

Reference: For background information, see the reference section.

 

Workflow diagram:

 

 

Prerequisites:

  • IIS is installed in accordance with the required operating system settings.
  • The extension module Web Service is installed.

 

Steps:

1 – Adding a Web Service to an Existing Project
  1. In the SMC tree, select Projects.
  1. Select an existing project.
  1. Click Stop .
  • A confirmation message displays.
  1. Click OK.
  1. Click Add to project .
    a. In the Select Project Extensions dialog box, click the arrow next to Connectivity and select the Web Services check box.
    b. Click OK.
    c. Click Save .
  • The Web Services Communication expander displays.
  • The Web Service is installed.

 

2 – Defining Protocol Type and Port Number for Web Service
  1. Click Edit .
  1. Click Next .
  • The Web Services Communication expander displays.
  1. Select Communication and do one of the following:
  • Unsecured
    a. Under Web services port, enter the port number (Default: 8080).
  • Secured
    a. Under Web services port, enter the port number (Default: 8443).
    b. Under Host certificate, click Browse.
    c. Select the appropriate certificate and click OK.
  1. Click Save Project .
  • The protocol settings are saved.
  1. Click Start Project .
Information

NOTE:
HTTP is insecure and vulnerable to man-in-the-middle and eavesdropping attacks which can let attackers gain access to sensitive information. Many organizations require certificates from third-party authorities instead of self-signed certificates to remain compliant with current regulations.

 

3 – Creating a Website
  • IIS manager is installed and you have configured the necessary settings.
  • (Recommended) You have deleted the default IIS website.
  • Application Request Routing (ARR) is installed on your system. If the IIS settings are not set up correctly, the Application Request Routing may not be visible. Change the IIS settings and run the Desigo CC installer again.
  1. In the SMC tree, select Websites.
  1. Click the Management tab.
  1. Click Create Web site .
  1. In the Details expander, do the following:
    a. In the Name field, enter a unique name for the web application.
    b. In the Path field, browse to select a destination for the website. The default path is [installation drive:]\[installation folder]\[WebSites]\[Web site name].
    c. In the User field, browse to select a user for the website.
    d. In the Select User dialog box, select the user for the web application and enter the password.
    NOTE: The web application must be a member of the IIS_IUSRS group. If you select a user that is not a member of the IIS_IUSRS group, SMC prompts you to add it.
    e. Enter the password.
    NOTE: Confirm the website/Web application user and password. If the password has changed, you must modify the website/Web application, and provide the most recent user password.
    f. Change the port numbers if the default cannot be used.
    g. Click Create to assign a certificate.
  1. Click Save .
  • A confirmation message displays.
  1. Click OK.
  • The data is validated on successful creation.
  • The Details expander displays the new settings.
Configuration Websites

 

4 – Creating a Web Service Communication on Server
  1. In the SMC tree, under Websites, select the website.
  1. Click the Management tab.
  1. Click Create Web Services Application .
  1. In the Project Information expander, do the following:
    a. From the Project Name drop-down list, select a project that you want to link to the web application.
    b. (Optional) From the Communication drop-down list, select the communication type.
  1. In the Web Application Details expander, do the following:
    a. In the Name field, enter a unique name for the web application.
    b. In the Path field, browse to select a destination for the website. The default path is [installation drive:]\[installation folder]\[WebSites]\[Web site name].
    c. In the User field, browse to select a user for the website.
    d. In the Select User dialog box, select the user for the Web Service application and enter the password.
    NOTE: The Web Service application must be a member of the IIS_IUSRS group. If you select a user that is not a member of the IIS_IUSRS group, SMC prompts you to add it.
    e. Enter the password.
  1. Click Save .
  • A confirmation message displays.
  1. Click OK.
  • The data is validated on successful creation.
  • The Web Service Interface Settings expander displays the new settings.
Configuration Website

 

5 – Checking Application Request Routing
  • The Internet Information Services (IIS) Manager is open.
  1. In the Connections pane, select the server.
  1. In the section IIS, double-click Application Request Routing Cache.
  • The Application Request Routing Cache dialog box displays.
  1. In the Actions pane, in the Proxy section, click Server Proxy Settings.
  • The Application Request Routing dialog box displays.
  1. In the Buffer Setting section, set the Response buffer threshold (KB) value to 0.
  1. In the Actions pane, click Apply.
IIS Application Request Routing Configuration

 

 

Showing Web Service Communication Settings
  • At least one started project is available under Projects.
  1. In the SMC tree, select Projects > [project].
  1. Click the Web Services Settings tab.
  • The Web Services Communication expander displays and shows the used protocol type and port number.