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 Web Service extension is installed.
  • The project is created in SMC and started and is an active project.

 

Steps:

1 – Add 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 Services extension is installed.

 

2 – Configure the Web Service Settings
  1. Click Edit .
  1. Click Next .
  • The Project Settings tab displays. One default WSI instance with default configuration is added.
  1. In the Web Services Communication expander, provide the details as follows:
  • Enter a unique instance name to change the default name of the WSI instance.
  • From the drop-down list under Communication, select the communication type as either Secured or Local.
  • Modify the default ports under Web Services Port, for the Secured (8443) or Local (8080) Communication type to change the default values.
    NOTE: For every WSI instance, enter a unique port number.
  • Click Browse and select the host certificate, and click OK.
  • For adding more WSI instances, click Add.
    NOTE:     Recommended maximum WSI instances to be added is 10.
  1. Click on the Web Services Instance row to configure and open the Directories Details expander.
  • Add Directories folder in Directories Access tab for example, add FlexReports directories.
  1. Click Save .
  • The WSI settings are saved.
  1. To view the web service settings, click Web Services Settings tab.
  1. Click Start Project .

 

3 – Create 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.
    The user must also have Allow log on locally as Service right set. For more information, refer Cannot Create or Save Website in Troubleshooting Websites and Web Applications.
    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.

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.

 

4 – Create a Web Service Communication on Server
  1. In the SMC tree, under Websites, select the website.
  1. Select the Management tab.
  1. Click and select Create Web Services Application.
  1. In the Project Information: Web Services Communication expander, from the Project name drop-down list, select a project to which you want to link the web services application.
  1. In the Web Application Details expander, do the following:
    a. In the Name field, enter a unique name for the web services application.
    b. In the Path field, browse to select a destination for the web services application. The default path is [installation drive:]\[installation folder]\[WebSites]\[Web site name].
    c. In the User field, browse to select a user for the web services application using the Select User dialog box.
    NOTE: The web services application user 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.
    The user must also have Allow log on locally as Service right set. For more information, refer Cannot Create or Save Website in Troubleshooting Websites and Web Applications.
    d. Enter the Password.
  1. Click Save .
  • A confirmation message displays.
  1. Click OK.
  • The data is validated on successful creation of web services application. The Help URL and Web Services Application URL will be displayed

 

5 – Verify Buffer Settings for Application Request Routing (ARR)

You want to verify the buffer settings for Application Request Routing (ARR), if WSI is not working.

  • The Internet Information Services (IIS) Manager is open.
  1. In the Buffer Setting section, set the Response buffer threshold (KB) value to 0.
  1. In the Actions pane, click Apply.