Jump to: navigation, search

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

(→‎Required roles and features)
 
(66 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
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).
+
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}}.
  
−
== Installation of Microsoft IIS ==
+
== {{UBIK}} Content Web Service ''UBIKContent.svc'' ==
−
=== Install server role ===
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
−
Start the server manager to install the Internet Information Services (IIS) on Windows Server 2012 by
+
# Copy the components of the {{UBIK}} Web Service into the (new) directory
−
# Clicking the ''Windows Start'' button, point to ''Administrative Tools'' and choose ''Server Manager''
+
# Create a new web applicaton as described [[HowTo:Configure_Microsoft_IIS_for_UBIK#Create_new_Web_Application|here]]
−
# Clicking on ''Roles Summary''
+
# [[Web_Service_Configuration|Configure]] the authentication mode of the web service using either
−
# Clicking on ''Add Roles''
+
#* [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]] or
−
# Use the ''Add Roles'' wizard to add the web server role
+
#* [[HowTo:Configure_LAS_Authentication|Local]] or [[HowTo:Configure_LAS_Authentication|Global Application Service]]
  
−
=== Required roles and features ===
+
== {{UBIK}} Authentication Web Service ''USAM.svc''==
−
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.
+
If authentication should happen via a distinctive [[USAM]] web service
 +
# 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 USAM web service using [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]]
  
−
{{UBIK}} web service requires at least the following roles
+
== {{UBIK}} Push Web Service ''UBIKPush.svc'' ==
−
* Microsoft .NET Framework 4
+
# Create a new directory in the ''wwwroot'' directory of the IIS installation (default: ''c:\inetpub\wwwroot'')
−
* Microsoft .NET Framework 3.5
+
# Copy the components of the {{UBIK}} Web Service into the (new) directory
−
* Webserver Application Development
+
# 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
−
and features
+
#* [[HowTo:Configure_Single_Local_Application_Authentication|Single Local Application]] or
−
* HTTP Actication (WCF Services)
+
#* [[HowTo:Configure_LAS_Authentication|Local]] or [[HowTo:Configure_LAS_Authentication|Global Application 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 ==
+
−
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="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. 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.
+
−
 
+
−
{{Attention|{{UBIK}} requires a valid certificate for SSL encryption!}}
+
−
 
+
−
<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 ===
+
−
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.
+
−
 
+
−
<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>
+
−
 
+
−
=== 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="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>
+
−
 
+
−
=== Optional: Local IIS User ===
+
−
Create and use a local user on the web server if no appropriate domain-user is available.
+
−
 
+
−
<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>
+
−
 
+
−
=== Testing the new service ===
+
−
[[File:UI Test New Service.01.png|600px|alt=01 Test New Service|01 Test New Service]]
+
  
 
== See also ==
 
== See also ==
−
* [[UBIK_Web_Service_Configuration|{{UBIK}} Web Service Configuration]]
+
* [[Web_Service_Configuration|Web Service Configuration]]
−
* [[Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
+
* [[HowTo:Install Microsoft IIS]]
 +
* [[HowTo:Configure_Microsoft_IIS_for_UBIK]]
 +
* [[USAM]]
  
−
[[Category:UBIK Studio]]
+
[[Category:How-To|Install UBIK Web Service]]
−
[[Category:UBIK Client]]
+
[[Category:Web service|Install UBIK Web Service]]
−
[[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

Retrieved from "https://wiki.augmensys.com/index.php?title=HowTo:Install_UBIK_Web_Service&oldid=17031"