Jump to: navigation, search

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


 
(125 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page describes how to set up an IIS server and a web service for {{UBIK}} on MS Server 2008 R2.
+
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]]
  
=== Resources ===
+
== {{UBIK}} Authentication Web Service ''USAM.svc''==
A physical server with MS Server 2008 R2 is used as the host system. On this server, the Hyper-V role is installed to operate at several virtual servers . However, a virtual server can have different operating systems. But in our case we need also an MS-​​Server2008 R2 installation.
+
If authentication should happen via a distinctive [[USAM]] web service
=== Install role ===
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
[[File:UI_01_Server_Manager.png|600px|alt=01_Server Manager|01_Server Manager]]
+
# Copy the components of the {{UBIK}} Web Service into the (new) directory
[[File:UI_02_Add_Roles_Wizard.png|600px|alt=02 Add Roles Wizard|02 Add Roles Wizard]]
+
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
[[File:UI_03_Add_Roles_Wizard.png|600px|alt=03 Add Roles Wizard|03 Add Roles Wizard]]
+
# [[Web_Service_Configuration|Configure]] the authentication mode of the USAM web service using [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]]
[[File:UI_04_Add_Roles_Wizard.png|600px|alt=04 Add Roles Wizard|04 Add Roles Wizard]]
+
[[File:UI_05_Add_Roles_Wizard.png|600px|alt=05 Add Roles Wizard|05 Add Roles Wizard]]
+
[[File:UI_06_Add_Roles_Wizard.png|600px|alt=06 Add Roles Wizard|06 Add Roles Wizard]]
+
[[File:UI_07_Add_Roles_Wizard.png|600px|alt=07 Add Roles Wizard|07 Add Roles Wizard]]
+
[[File:UI_08_Add_Roles_Wizard.png|600px|alt=08 Add Roles Wizard|08 Add Roles Wizard]]
+
[[File:UI_09_Add_Roles_Wizard.png|600px|alt=09 Add Roles Wizard|09 Add Roles Wizard]]
+
[[File:UI_02_Server_Manager.png|600px|alt=02_Server Manager|02_Server Manager]]
+
  
To install the Internet Information Services (IIS) on Windows Server 2008 R2, start the server manager.
+
== {{UBIK}} Push Web Service ''UBIKPush.svc'' ==
*Click Start, point to Administrative Tools, and then click Server Manager.
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
* Click Roles Summary, click Add Roles.
+
# Copy the components of the {{UBIK}} Web Service into the (new) directory
* Use the "Add Roles" wizard to add the Web Server role.
+
# 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]]
  
When you use the Add Roles Wizard to install IIS, you get the default installation, which has a minimum set of role services. If you need additional IIS role services, such as Application Development or Health and Diagnostics, make sure to select the check boxes associated with those features in the Select Role Services page of the wizard.
+
== See also ==
 +
* [[Web_Service_Configuration|Web Service Configuration]]
 +
* [[HowTo:Install Microsoft IIS]]
 +
* [[HowTo:Configure_Microsoft_IIS_for_UBIK]]
 +
* [[USAM]]
  
== Configuration of the web server==
+
[[Category:How-To|Install UBIK Web Service]]
[[File:UI_10_IIS_Manager.png|600px|alt=10 IIS Manager|10 IIS Manager]]
+
[[Category:Web service|Install UBIK Web Service]]
 
+
For UBIK webservice we need additional features to make it properly and smoothly.
+
* Microsoft. NET Framework 4
+
* Roles / Feature. NET Framework 3.5.1 feature
+
 
+
 
+
=== Download and installation Microsoft .NET Framework 4 ===
+
 
+
[http://www.microsoft.com/en-us/download/details.aspx?id=17851 .NET Framework 4]
+
 
+
[[File:.net Framework4.01.png|600px|alt=01 .net Framework4|01 .net Framework4]]
+
[[File:.net Framework4.02.png|600px|alt=02 .net Framework4|02 .net Framework4]]
+
[[File:.net Framework4.03.png|600px|alt=03 .net Framework4|03 .net Framework4]]
+
 
+
=== Installation .net Framework 3.5.1 Feature ===
+
 
+
[[File:UI_.net Framework3.5.1.01.png|600px|alt=01 .net Framework3.5.1|01 .net Framework3.5.1]]
+
[[File:UI_.net Framework3.5.1.02.png|600px|alt=02 .net Framework3.5.1|02 .net Framework3.5.1]]
+
[[File:UI_.net Framework3.5.1.03.png|600px|alt=03 .net Framework3.5.1|03 .net Framework3.5.1]]
+
[[File:UI_.net Framework3.5.1.04.png|600px|alt=04 .net Framework3.5.1|04 .net Framework3.5.1]]
+
 
+
=== Add Application Pool ===
+
An application pool is defined which (parts of) web site which work process (es) will be delivered - ultimately this means that an application pool defines who is responsible for the processing of one (or several) URL (s).
+
 
+
[[File:UI Application Pool.01.png|600px|alt=01 Application Pool|01 Application Pool]]
+
[[File:UI Application Pool.02.png|400px|alt=02 Application Pool|02 Application Pool]]
+
[[File:UI Application Pool.03.png|600px|alt=03 Application Pool|03 Application Pool]]
+
 
+
=== Certificate ===
+
We need a certificate that guarantees us the security of the connection and recognition of authorized mobile devices. After the creation of the certificate on the server, it must be exported using the export function. Our developers need this certificate to integrate it into our mobile application.
+
 
+
[[File:UI Certificate.01.png|600px|alt=01 Certificate|01 Certificate]]
+
[[File:UI Certificate.02.png|600px|alt=02 Certificate|02 Certificate]]
+
[[File:UI Certificate.03.png|600px|alt=03 Certificate|03 Certificate]]
+
[[File:UI Certificate.04.png|600px|alt=04 Certificate|04 Certificate]]
+
 
+
=== Bindings ===
+
Now we create a binding, so we get the correct certificate to access to our IIS service from external.
+
 
+
[[File:UI Binding.01.png|400px|alt=01 Binding|01 Binding]]
+
[[File:UI Binding.02.png|400px|alt=02 Binding|02 Binding]]
+
[[File:UI Binding.03.png|400px|alt=03 Binding|03 Binding]]
+
[[File:UI Binding.04.png|400px|alt=04 Binding|04 Binding]]
+
[[File:UI Binding.05.png|400px|alt=05 Binding|05 Binding]]
+
[[File:UI Binding.06.png|400px|alt=06 Binding|06 Binding]]
+
[[File:UI Binding.07.png|400px|alt=07 Binding|07 Binding]]
+
 
+
=== Local IIS-User ===
+
This member is necessary because it allows the external clients to have access to the IIS user entitle folder.
+
 
+
[[File:UI_Local_IIS_user.01.png‎|600px|alt=01 Local IIS-user|01 Local IIS-user]]
+
[[File:UI_Local_IIS_user.02.png‎|300px|alt=02 Local IIS-user|02 Local IIS-user]]
+
[[File:UI_Local_IIS_user.03.png‎|600px|alt=03 Local IIS-user|03 Local IIS-user]]
+
[[File:UI_Local_IIS_user.04.png‎|300px|alt=04 Local IIS-user|04 Local IIS-user]]
+
[[File:UI_Local_IIS_user.05.png‎|300px|alt=05 Local IIS-user|05 Local IIS-user]]
+
[[File:UI_Local_IIS_user.06.png‎|300px|alt=06 Local IIS-user|06 Local IIS-user]]
+
[[File:UI_Local_IIS_user.07.png‎|300px|alt=07 Local IIS-user|07 Local IIS-user]]
+
[[File:UI_Local_IIS_user.08.png‎|300px|alt=08 Local IIS-user|08 Local IIS-user]]
+
[[File:UI_Local_IIS_user.09.png‎|300px|alt=09 Local IIS-user|09 Local IIS-user]]
+
 
+
=== Create new service for UBIK ===
+
 
+
==== Testing the new service ====
+
 
+
== Configuration of the {{UBIK}} web service ==
+
=== Pre-requisites ===
+
* Mobile application requires SSL authentication
+
* A valid certificate must exist on the IIS, whereas a Self-Signed-Certificate on a local webserver if enough
+
* Certificate has to be embedded in the mobile application by Augmensys GmbH
+
* Create a local user "UBIK" on the web server with its own user profile
+
* Use any password and add this user to the group "IIS_IUSRS"
+
 
+
=== Install service ===
+
* Locate the public directory of the webserver (default: "inetpub\wwwroot")
+
* Create a subdirectory and past the components of the {{UBIK}} web service
+
* Open the Server Manager and go to Internet Information Services Manager
+
* Create a new application pool UBIK.Pool with .NET Framework >= v4.x
+
* Locate the created subdirectory among the IIS sites and use the Convert to Application from the context menu
+
* Click Select… and choose your application pool
+
* Click Connect as… and choose UBIK as specific user
+
* Open Advanced Settings of the application and enable https protocol
+
 
+
==See also==
+
* [[Installation_UBIK_Studio|Set up {{UBIK}} Studio]]
+
* [[Microsoft_SQL_Server|Set up Microsoft SQL Server]]
+
 
+
[[Category:UBIK Studio]]
+
[[Category:Configuration]]
+

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