Jump to: navigation, search

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


(Local IIS-User)
 
(79 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page describes how to set up an Microsoft Internet Information Server (IIS) and for a {{UBIK}} web service on Microsoft Server 2012.
+
Prior to the installation of an {{UBIK Web Service}} make sure to have a [http://www.iis.net/ Microsoft Internet Information Server (IIS)] available and configured accordingly. If not read the instructions how to [[HowTo:Install_Microsoft_IIS|install]] and [[HowTo:Configure_Microsoft_IIS_for_UBIK|configure]] an IIS for {{UBIK}}.
The web service is used to publish data from the {{UBIK}} database to a mobile device (eg mobile phone, tablet).
+
  
== Installation of Microsoft IIS ==
+
== {{UBIK}} Content Web Service ''UBIKContent.svc'' ==
 +
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
 +
# Copy the components of the {{UBIK}} Web Service into the (new) directory
 +
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
 +
# [[Web_Service_Configuration|Configure]] the authentication mode of the web service using either
 +
#* [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]] or
 +
#* [[HowTo:Configure_LAS_Authentication|Local]] or [[HowTo:Configure_LAS_Authentication|Global Application Service]]
  
=== Install server role ===
+
== {{UBIK}} Authentication Web Service ''USAM.svc''==
Start the server manager to install the Internet Information Services (IIS) on Windows Server 2012.
+
If authentication should happen via a distinctive [[USAM]] web service
* Click Start, point to Administrative Tools and choose Server Manager.
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
* Click Roles Summary
+
# Copy the components of the {{UBIK}} Web Service into the (new) directory
* Click Add Roles.
+
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
* Use the "Add Roles" wizard to add the web server role
+
# [[Web_Service_Configuration|Configure]] the authentication mode of the USAM web service using [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]]
  
=== Required roles and features ===
+
== {{UBIK}} Push Web Service ''UBIKPush.svc'' ==
By using the "Add Roles" wizard the default set of role services gets installed, which do not fit the requirements for {{UBIK}} web services. Additional IIS role services and features, such as Application Development or Health and Diagnostics, needs to be installed by selectint the check boxes associated with those features in the "Select Role Services" page of the wizard.
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
 +
# Copy the components of the {{UBIK}} Web Service into the (new) directory
 +
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
 +
# [[Web_Service_Configuration|Configure]] the authentication mode of the web service using either
 +
#* [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]] or
 +
#* [[HowTo:Configure_LAS_Authentication|Local]] or [[HowTo:Configure_LAS_Authentication|Global Application Service]]
  
{{UBIK}} web service requires at least the following roles
+
== See also ==
* Microsoft .NET Framework 4
+
* [[Web_Service_Configuration|Web Service Configuration]]
* Microsoft .NET Framework 3.5
+
* [[HowTo:Install Microsoft IIS]]
* Webserver Application Development
+
* [[HowTo:Configure_Microsoft_IIS_for_UBIK]]
 +
* [[USAM]]
  
and features
+
[[Category:How-To|Install UBIK Web Service]]
* HTTP Actication (WCF Services)
+
[[Category:Web service|Install UBIK Web Service]]
 
+
<gallery widths="500" heights="500" >
+
File:UI_01_Server_Manager.png|[[01 Server Manager]]
+
File:UI_02_Add_Roles_Wizard.png|[[02 Add Roles Wizard]]
+
File:UI_03_Add_Roles_Wizard.png|[[03 Add Roles Wizard]]
+
File:UI_04_Add_Roles_Wizard.png|[[04 Add Roles Wizard]]
+
File:UI_05_Add_Roles_Wizard.png|[[05 Add Roles Wizard]]
+
File:UI_06_Add_Roles_Wizard.png|[[06 Add Roles Wizard]]
+
File:UI_02_Server_Manager.png|[[07 Server Manager]]
+
</gallery>
+
 
+
=== 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 ==
+
<gallery widths="500" heights="500" >
+
File:UI_10_IIS_Manager.png|[[10 IIS Manager]]
+
</gallery>
+
 
+
=== 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.
+
 
+
<gallery widths="500" heights="500" >
+
File:UI Application Pool.01.png|[[01 Application Pool]]
+
File:UI Application Pool.02.png|[[02 Application Pool]]
+
File:UI Application Pool.03.png|[[03 Application Pool]]
+
</gallery>
+
 
+
=== Certificate ===
+
The web service communicates with the {{UBIK}} client via an secured connection, which requires a SSL certificate on the server and client side. Not having a valid cerficate, a self-signed certificate can be used. Therefore, a new certificate can be created via the Internet Information Server 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.
+
 
+
<gallery widths="500" heights="500" >
+
File:UI Certificate.01.png|[[01 Certificate]]
+
File:UI Certificate.02.png|[[02 Certificate]]
+
File:UI Certificate.03.png|[[03 Certificate]]
+
File:UI Certificate.04.png|[[04 Certificate]]
+
</gallery>
+
 
+
=== Bindings ===
+
Create bindings to get the correct certificate to access to the IIS service from external.
+
 
+
<gallery widths="500" heights="500" >
+
File:UI Binding.01.png|[[01 Binding]]
+
File:UI Binding.02.png|[[02 Binding]]
+
File:UI Binding.03.png|[[03 Binding]]
+
File:UI Binding.04.png|[[04 Binding]]
+
File:UI Binding.05.png|[[05 Binding]]
+
File:UI Binding.06.png|[[06 Binding]]
+
File:UI Binding.07.png|[[07 Binding]]
+
</gallery>
+
 
+
=== IIS User ===
+
This member is necessary because it allows the external clients to have access to the IIS user entitle folder.
+
 
+
<gallery widths="500" heights="500" >
+
File:UI_Local_IIS_user.01.png|[[01 Local IIS-user]]
+
File:UI_Local_IIS_user.02.png‎|[[02 Local IIS-user]]
+
File:UI_Local_IIS_user.03.png‎|[[03 Local IIS-user]]
+
File:UI_Local_IIS_user.04.png‎|[[04 Local IIS-user]]
+
File:UI_Local_IIS_user.05.png‎|[[05 Local IIS-user]]
+
File:UI_Local_IIS_user.06.png‎|[[06 Local IIS-user]]
+
File:UI_Local_IIS_user.07.png|[[07 Local IIS-user]]
+
File:UI_Local_IIS_user.08.png‎|[[08 Local IIS-user]]
+
File:UI_Local_IIS_user.09.png‎|[[09 Local IIS-user]]
+
</gallery>
+
 
+
=== Create new Web Service ===
+
<gallery widths="500" heights="500" >
+
File:UI New Service.01.png|[[01 New Service]]
+
File:UI_New Service.02.png‎|[[02 New Service]]
+
File:UI_New Service.03.png‎|[[03 New Service]]
+
File:UI_New Service.04.png‎|[[04 New Service]]
+
File:UI_New Service.05.png‎|[[05 New Service]]
+
File:UI_New Service.06.png‎|[[06 New Service]]
+
File:UI_New Service.07.png|[[07 New Service]]
+
File:UI_New Service.08.png|[[08 New Service]]
+
File:UI_New Service.09.png|[[09 New Service]]
+
</gallery>
+
 
+
=== Testing the new service ===
+
[[File:UI Test New Service.01.png|600px|alt=01 Test New Service|01 Test New Service]]
+
 
+
[[Category:UBIK Studio]]
+
[[Category:UBIK Client]]
+
[[Category:Installing]]
+

Latest revision as of 09:49, 4 August 2015

Prior to the installation of an UBIK® Web Service make sure to have a Microsoft Internet Information Server (IIS) available and configured accordingly. If not read the instructions how to install and configure an IIS for UBIK®.

UBIK® Content Web Service UBIKContent.svc

  1. Create a new directory in the wwwroot directory of the IIS installation (default: c:\inetpub\wwwroot)
  2. Copy the components of the UBIK® Web Service into the (new) directory
  3. Create a new web applicaton as described here
  4. Configure the authentication mode of the web service using either

UBIK® Authentication Web Service USAM.svc

If authentication should happen via a distinctive USAM web service

  1. Create a new directory in the wwwroot directory of the IIS installation (default: c:\inetpub\wwwroot)
  2. Copy the components of the UBIK® Web Service into the (new) directory
  3. Create a new web applicaton as described here
  4. Configure the authentication mode of the USAM web service using Single Local Application

UBIK® Push Web Service UBIKPush.svc

  1. Create a new directory in the wwwroot directory of the IIS installation (default: c:\inetpub\wwwroot)
  2. Copy the components of the UBIK® Web Service into the (new) directory
  3. Create a new web applicaton as described here
  4. Configure the authentication mode of the web service using either

See also