Difference between revisions of "HowTo:Install UBIK Web Service"

Revision as of 09:15, 5 June 2014

This page describes how to set up a UBIK^® web service on a Microsoft Internet Information Server (IIS) installed on Microsoft Server 2012. The web service is used to publish data from the UBIK^® database to a mobile device (eg mobile phone, tablet).

Installation of Microsoft IIS

Install server role

Start the server manager to install the Internet Information Services (IIS) on Windows Server 2012 by

Clicking the Windows Start button, point to Administrative Tools and choose Server Manager
Clicking on Roles Summary
Clicking on Add Roles
Use the Add Roles wizard to add the web server role

Required roles and features

The Add Roles wizard installs only the default set of role services, which do not contain all the necessary features required for UBIK^® web services. Therefore, additional IIS role services and features, such as Application Development or Health and Diagnostics, needs to be selected in the Select Role Services page of the wizard.

UBIK^® web service requires at least the following roles

Microsoft .NET Framework 4
Microsoft .NET Framework 3.5
Webserver Application Development

and features

HTTP Actication (WCF Services)

1 - Server Manager
2 - Add Roles Wizard
3 - Add Roles Wizard
4 - Add Roles Wizard
5 - Add Roles Wizard
6 - Add Roles Wizard
7 - Server Manager

Using a virtual server

A physical server with Microsoft Server 2012 can be used as the host system as well as a virtual server. Use Hyper-V to install and operate serveral virtual servers and proceed with the web server installation similar as for a physical server.

Configuration of the Web Server

The web server can be configured using the Internet Information Services (IIS) Manager console, which gets installed automatically. The console provides a graphical user interface to manage and configure the web server accordingly to the UBIK^® web service.

1 - IIS Manager

Add Application Pool

An application pool is a group of one or more URLs that are served by a worker process or a set of worker processes. Application pools set boundaries for the applications they contain, which means that any applications that are running outside a given application pool cannot affect the applications in the application pool.

1 - Application Pool
2 - Application Pool
3 - Application Pool

Certificate

The web service communicates with the UBIK^® client via an secured connection, which requires a SSL certificate on the server and client side. Use a public key certificate from a certificate authority or a self-signed certificate, both will work for UBIK^®. A new self-signed certificate can be created in the Internet Information Server (IIS) Manager, exported using the export function and sent to the development team. As already mentioned, the client has to know this certificate as well, hence it need to be integrated it into the mobile application.

UBIK^® requires a valid certificate for SSL encryption!

1 - IIS Configuration
2 - Installed certificates
3 - Create self-signed certificate
4 - Import certificate
5 - Installed certificates

Bindings

Web sites and services have something called Server Bindings which represent the underlying address, port, and potentially a host header that the website is accessed using. The UBIK^® client accesses the web service via a secured port (https), where it is necessary to configure the appropriate certificate.

For Android Clients

1 - Binding
2 - Binding
3 - Binding
4 - Binding

For Windows 8.1 Clients

1 - Binding
2 - Binding
3 - Binding
4 - Binding

Create new Web Application

In the IIS Manager expand the Default Web Site node and navigate through the folder structure to the folder containing the UBIK^® web service components.

1 - New Service
2 - New Service
3 - New Service
4 - New Service
5 - New Service
6 - New Service
7 - New Service
8 - New Service
9 - New Service

Optional: Local IIS User

Create and use a local user on the web server if no appropriate domain-user is available.

1 - Local IIS-user
2 - Local IIS-user
3 - Local IIS-user
4 - Local IIS-user
5 - Local IIS-user
6 - Local IIS-user
7 - Local IIS-user
8 - Local IIS-user
9 - Local IIS-user

Additional prerequisites

Ensure that the service ports are not blocked by a firewall.
Ensure that port forwarding is established if needed (e.g. for Microsoft Azure Virtual Computers or servers behind a gateway)

@@ Line 21: / Line 21: @@
 <gallery widths="400" heights="400" >
-File:UI_01_Server_Manager.png|[[1 - Server Manager]]
+File:UI_01_Server_Manager.png|1 - Server Manager
-File:UI_02_Add_Roles_Wizard.png|[[2 - Add Roles Wizard]]
+File:UI_02_Add_Roles_Wizard.png|2 - Add Roles Wizard
-File:UI_03_Add_Roles_Wizard.png|[[3 - Add Roles Wizard]]
+File:UI_03_Add_Roles_Wizard.png|3 - Add Roles Wizard
-File:UI_04_Add_Roles_Wizard.png|[[4 - Add Roles Wizard]]
+File:UI_04_Add_Roles_Wizard.png|4 - Add Roles Wizard
-File:UI_05_Add_Roles_Wizard.png|[[5 - Add Roles Wizard]]
+File:UI_05_Add_Roles_Wizard.png|5 - Add Roles Wizard
-File:UI_06_Add_Roles_Wizard.png|[[6 - Add Roles Wizard]]
+File:UI_06_Add_Roles_Wizard.png|6 - Add Roles Wizard
-File:UI_02_Server_Manager.png|[[7 - Server Manager]]
+File:UI_02_Server_Manager.png|7 - Server Manager
 </gallery>
@@ Line 35: / Line 35: @@
 == Configuration of the Web Server ==
 The web server can be configured using the ''Internet Information Services (IIS) Manager'' console, which gets installed automatically. The console provides a graphical user interface to manage and configure the web server accordingly to the {{UBIK}} web service.
-:''See [[UBIK_Web_Service_Configuration|{{UBIK}} Web Service Configuration]] for further details on configuration.''
 <gallery widths="400" heights="400" >
-File:UI_10_IIS_Manager.png|[[1 - IIS Manager]]
+File:UI_10_IIS_Manager.png|1 - IIS Manager
 </gallery>
@@ Line 46: / Line 44: @@
 <gallery widths="400" heights="400" >
-File:UI Application Pool.01.png|[[1 - Application Pool]]
+File:UI Application Pool.01.png|1 - Application Pool
-File:UI Application Pool.02.png|[[2 - Application Pool]]
+File:UI Application Pool.02.png|2 - Application Pool
-File:UI Application Pool.03.png|[[3 - Application Pool]]
+File:UI Application Pool.03.png|3 - Application Pool
 </gallery>
@@ Line 57: / Line 55: @@
 <gallery widths="400" heights="400" >
-File:UI Certificate.01.png|[[1 - IIS Configuration]]
+File:UI Certificate.01.png|1 - IIS Configuration
-File:UI Certificate.02.png|[[2 - Installed certificates]]
+File:UI Certificate.02.png|2 - Installed certificates
-File:UI Certificate.03.png|[[3 - Create self-signed certificate]]
+File:UI Certificate.03.png|3 - Create self-signed certificate
-File:UI Certificate.05.png|[[4 - Import certificate]]
+File:UI Certificate.05.png|4 - Import certificate
-File:UI Certificate.04.png|[[5 - Installed certificates]]
+File:UI Certificate.04.png|5 - Installed certificates
 </gallery>
@@ Line 69: / Line 67: @@
 ====For Android Clients====
 <gallery widths="400" heights="400" >
-File:UI Binding.01.png|[[1 - Binding]]
+File:UI Binding.01.png|1 - Binding
-File:UI Binding.02.png|[[2 - Binding]]
+File:UI Binding.02.png|2 - Binding
-File:UI Binding.03.png|[[3 - Binding]]
+File:UI Binding.03.png|3 - Binding
-File:UI Binding.04.png|[[4 - Binding]]
+File:UI Binding.04.png|4 - Binding
 </gallery>
 ====For Windows 8.1 Clients====
 <gallery widths="400" heights="400" >
-File:UI Binding.01.png|[[1 - Binding]]
+File:UI Binding.01.png|1 - Binding
-File:UI_Binding_Win8.02.png|[[2 - Binding]]
+File:UI_Binding_Win8.02.png|2 - Binding
-File:UI_Binding_Win8.01.png|[[3 - Binding]]
+File:UI_Binding_Win8.01.png|3 - Binding
-File:UI_Binding_Win8.02.png|[[4 - Binding]]
+File:UI_Binding_Win8.02.png|4 - Binding
 </gallery>
 === Create new Web Application ===
 In the ''IIS Manager'' expand the ''Default Web Site'' node and navigate through the folder structure to the folder containing the {{UBIK}} web service components.
-:''See [[Install_UBIK_Web_Service|Install {{UBIK}} Web Service]] how to install the components.''
 <gallery widths="400" heights="400" >
-File:UI New Service.01.png|[[1 - New Service]]
+File:UI New Service.01.png|1 - New Service
-File:UI_New Service.02.png‎|[[2 - New Service]]
+File:UI_New Service.02.png‎|2 - New Service
-File:UI_New Service.03.png‎|[[3 - New Service]]
+File:UI_New Service.03.png‎|3 - New Service
-File:UI_New Service.04.png‎|[[4 - New Service]]
+File:UI_New Service.04.png‎|4 - New Service
-File:UI_New Service.05.png‎|[[5 - New Service]]
+File:UI_New Service.05.png‎|5 - New Service
-File:UI_New Service.06.png‎|[[6 - New Service]]
+File:UI_New Service.06.png‎|6 - New Service
-File:UI_New Service.07.png|[[7 - New Service]]
+File:UI_New Service.07.png|7 - New Service
-File:UI_New Service.08.png|[[8 - New Service]]
+File:UI_New Service.08.png|8 - New Service
-File:UI_New Service.09.png|[[9 - New Service]]
+File:UI_New Service.09.png|9 - New Service
 </gallery>
@@ Line 104: / Line 100: @@
 <gallery widths="400" heights="400" >
-File:UI_Local_IIS_user.01.png|[[1 - Local IIS-user]]
+File:UI_Local_IIS_user.01.png|1 - Local IIS-user
-File:UI_Local_IIS_user.02.png‎|[[2 - Local IIS-user]]
+File:UI_Local_IIS_user.02.png‎|2 - Local IIS-user
-File:UI_Local_IIS_user.03.png‎|[[3 - Local IIS-user]]
+File:UI_Local_IIS_user.03.png‎|3 - Local IIS-user
-File:UI_Local_IIS_user.04.png‎|[[4 - Local IIS-user]]
+File:UI_Local_IIS_user.04.png‎|4 - Local IIS-user
-File:UI_Local_IIS_user.05.png‎|[[5 - Local IIS-user]]
+File:UI_Local_IIS_user.05.png‎|5 - Local IIS-user
-File:UI_Local_IIS_user.06.png‎|[[6 - Local IIS-user]]
+File:UI_Local_IIS_user.06.png‎|6 - Local IIS-user
-File:UI_Local_IIS_user.07.png|[[7 - Local IIS-user]]
+File:UI_Local_IIS_user.07.png|7 - Local IIS-user
-File:UI_Local_IIS_user.08.png‎|[[8 - Local IIS-user]]
+File:UI_Local_IIS_user.08.png‎|8 - Local IIS-user
-File:UI_Local_IIS_user.09.png‎|[[9 - Local IIS-user]]
+File:UI_Local_IIS_user.09.png‎|9 - Local IIS-user
 </gallery>
@@ Line 125: / Line 121: @@
 * [[Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
 * [[UBIK_Web_Service_Configuration|{{UBIK}} Web Service Configuration]]
+* [[Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
 [[Category:UBIK Web Service]]
 [[Category:Installing]]