Jump to: navigation, search

Difference between revisions of "HowTo:Set up UBIK"


(Session Management Type)
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
The initial setup of {{UBIK}} and its components requires some extensive but straight forward steps. This guide gives an overview about the dependencies of the different components, whereas more detailed installation instructions can be found in separate linked articles, respectively.
 
The initial setup of {{UBIK}} and its components requires some extensive but straight forward steps. This guide gives an overview about the dependencies of the different components, whereas more detailed installation instructions can be found in separate linked articles, respectively.
  
Each section covers the components required for the use case named in the section title.
+
The next sections cover the components required for the use cases as mentioned in the [[Getting_Started#Introduction|introduction]]. General information about the configuration files of each component can be found in [[Configuration_Files]].
  
== Setup for data model administration ==
+
== Setup for Data Model Administration ==
 +
Creating and maintaining {{UBIK}} data models requires an according {{UBIK Database}} and the modelling tool {{UBIK Studio}} only.
  
{| class="wikitable sortable"
+
* {{UBIK Database}}
|-
+
:''See [[HowTo:Install_UBIK_Database|Set up {{UBIK}} Database]] for help on configuration issues.''
! Component !! Required !! Install instructions
+
* {{UBIK Studio}}
|-
+
:''See [[HowTo:Install_UBIK_Studio|How to install {{UBIK}} Studio]] for help on installation issues.''
| {{UBIK Database}} || class="centeredCell" | Always || [[HowTo:Install_UBIK_Database]]
+
|-
+
| {{UBIK Studio}} || class="centeredCell" | Always || [[HowTo:Install_UBIK_Studio]]
+
|}
+
  
=== Session Management Type ===
+
===Session Management Type===
Using the [[USAM#Single_Local_Application]] mode is sufficient for administrate the data model and to work with {{UBIK}} Studio only. See [[HowTo:Configure_Single_Local_Application_Authentication|this guide for instructions how to set up this authentication mode.
+
Using [[USAM#Single_Local_Application|Single Local Application]] mode is sufficient to administrate the data model and to work with {{UBIK}} Studio only.
 +
:''See [[HowTo:Configure_Single_Local_Application_Authentication|Configure Single Local Application Authentication]] for help on configuration issues.''
  
== Setup for working mobile ==
+
Of course, it is also possible to use another authentication mode like [[USAM#LAS_.28Local_Application_Service.29|Local Application Service]].
{| class="wikitable"
+
|-
+
! Component !! Mandatory !! Optional for !! Install instructions
+
|-
+
| {{UBIK Database}} || class="centeredCell" | Always || [[HowTo:Install_UBIK_Database]]
+
|-
+
| {{UBIK Studio}} || class="centeredCell" | Always || [[HowTo:Install_UBIK_Studio]]
+
|-
+
| {{UBIK Client}} || class="centeredCell" | Always || [[HowTo:Install_UBIK_Database]]
+
|-
+
| {{Web Service}} || Always || Example || [[http://wiki.augmensys.com/index.php/HowTo:Configure_Microsoft_IIS_for_UBIK]]
+
|}
+
  
=== Session Management Type ===
+
[[Category:Installing|Set up UBIK]]
For being able to use mobile clients it is mandatory to use [[USAM#LAS_.28Local_Application_Service.29|Local Application Service]] as authentication mode. See [[HowTo:Configure_LAS_Authentication|this guide for instructions how to set up this authentication mode.
+
[[Category:Server|Set up UBIK]]
  
== Setup for interfacing 3rd party systems ==
+
== Setup for Working Mobile ==
 +
Working mobile presumes a valid data model within a {{UBIK Database}} created with {{UBIK Studio}}. Additionally the data needs to be published via a {{UBIK Web Service}} to an {{UBIK Client}}.
  
=== UBIK Database ===
+
* {{UBIK Database}}
Set up the database either by importing an export file of an existing database or by executing the
+
:''See [[HowTo:Install_UBIK_Database|Set up {{UBIK}} Database]] for help on configuration issues.''
** [Create empty SQL DB + execute SQL script]
+
* {{UBIK Studio}}
* UBIK Studio
+
:''See [[HowTo:Install_UBIK_Studio|How to install {{UBIK}} Studio]] for help on installation issues.''
* .NET Framework 4.0
+
* {{UBIK Client}}
UBIK Application (Android, Windows)
+
* {{UBIK Web Service}}
 +
:''See [[HowTo:Install_UBIK_Web_Service]] and [[HowTo:Configure_Microsoft_IIS_for_UBIK]] for help on configuration issues.''
  
• Use cases
+
=== Session Management Type ===
o UBIK Studio only: SL
+
For being able to use mobile clients it is mandatory to use [[USAM#LAS_.28Local_Application_Service.29|Local Application Service]] as authentication mode.
o Working with client (mobile, web): LAS + USAM
+
:''See [[HowTo:Configure_LAS_Authentication|Configure LAS Authentication]] for help on configuration issues.''
  
• Web service
+
[[Category:Installing|Set up UBIK]]
o Content
+
[[Category:Server|Set up UBIK]]
 Configuration: endpoints, bindings vom Push
+
o USAM
+
o Optional: Push
+
***Configuration: endpoints, bindings
+
  
 +
== Setup for Interfacing 3rd Party Systems ==
 +
Interfacing a 3rd party system presumes a valid data model within a {{UBIK Database}} created with {{UBIK Studio}}. The interfaces itself can be designed and tested manually using {{UBIK Studio}}. If automatisms are required you need to use {{UBIK Enterprise Service}}.
  
All content and configuration data of {{UBIK}} is managed in a [http://www.microsoft.com/en-us/sqlserver/default.aspx Microsoft SQL] database (2008 R2 or newer). Once the SQL server engines is installed successfully, an administrator can set up a new {{UBIK}} database simple using the available release database.
+
* {{UBIK Database}}
 +
:''See [[HowTo:Install_UBIK_Database|Set up {{UBIK}} Database]] for help on configuration issues.''
 +
* {{UBIK Studio}}
 +
:''See [[HowTo:Install_UBIK_Studio|How to install {{UBIK}} Studio]] for help on installation issues.''
 +
* {{UBIK Enterprise Service}}
 +
:''See [[HowTo:Install_UBIK_Enterprise_Service|How to install {{UBIK}} Enterprise Service]] for help on installation issues.''
  
[[File:UI_SettingUpUBIKDatabase_01.png|thumb|alt=Microsoft SQL Server Management Studio|Microsoft SQL Server Management Studio]]
+
=== Session Management Type ===
== Setting up {{UBIK}} database ==
+
Using [[USAM#Single_Local_Application|Single Local Application]] mode is sufficient to administrate the data model and to interface 3rd pary systems.
# Start the ''Microsoft SQL Server Management Studio'' and connect to the database server
+
:''See [[HowTo:Configure_Single_Local_Application_Authentication|Configure Single Local Application Authentication]] for help on configuration issues.''
# Navigate to ''Databases'' and add a new database
+
# Choose ''Tasks → Restore → Database'' from the context menu
+
## Choose the newly created database in the setting ''In database''
+
## Choose the copied backup file in ''From media''
+
## Check ''Restore'' of the according backup set
+
# Switch to the options-slider and check ''Overwriting actual data'' (if necessary)
+
# Finish the process by clicking {{key press|OK}}
+
  
{{Attention|Use maintenance plans for periodic backup of your own and the system databases!}}
+
Of course, it is also possible to use another authentication mode like [[USAM#LAS_.28Local_Application_Service.29|Local Application Service]].
  
== Requirements ==
+
== See also ==
=== Database user ===
+
* [[Getting_Started]]
The database user configured in {{UBIK}} Studio used to connect to the database needs
+
* to have the role ''sys.admin'' assigned
+
* to be marked as ''Database owner'' (dbo) of the according {{UBIK}} database
+
  
=== Windows firewall ===
+
[[Category:Installing|Set up UBIK]]
For a non-local SQL server make sure that the SQL server port (default: 1433) is unlocked by the Windows firewall Inbound and Exbound rules.
+
[[Category:Server|Set up UBIK]]

Latest revision as of 08:50, 23 July 2015

The initial setup of UBIK® and its components requires some extensive but straight forward steps. This guide gives an overview about the dependencies of the different components, whereas more detailed installation instructions can be found in separate linked articles, respectively.

The next sections cover the components required for the use cases as mentioned in the introduction. General information about the configuration files of each component can be found in Configuration Files.

Setup for Data Model Administration

Creating and maintaining UBIK® data models requires an according UBIK® Database and the modelling tool UBIK® Studio only.

See Set up UBIK® Database for help on configuration issues.
See How to install UBIK® Studio for help on installation issues.

Session Management Type

Using Single Local Application mode is sufficient to administrate the data model and to work with UBIK® Studio only.

See Configure Single Local Application Authentication for help on configuration issues.

Of course, it is also possible to use another authentication mode like Local Application Service.

Setup for Working Mobile

Working mobile presumes a valid data model within a UBIK® Database created with UBIK® Studio. Additionally the data needs to be published via a UBIK® Web Service to an UBIK® Client.

See Set up UBIK® Database for help on configuration issues.
See How to install UBIK® Studio for help on installation issues.
See Install UBIK Web Service and Configure Microsoft IIS for UBIK for help on configuration issues.

Session Management Type

For being able to use mobile clients it is mandatory to use Local Application Service as authentication mode.

See Configure LAS Authentication for help on configuration issues.

Setup for Interfacing 3rd Party Systems

Interfacing a 3rd party system presumes a valid data model within a UBIK® Database created with UBIK® Studio. The interfaces itself can be designed and tested manually using UBIK® Studio. If automatisms are required you need to use UBIK® Enterprise Service.

See Set up UBIK® Database for help on configuration issues.
See How to install UBIK® Studio for help on installation issues.
See How to install UBIK® Enterprise Service for help on installation issues.

Session Management Type

Using Single Local Application mode is sufficient to administrate the data model and to interface 3rd pary systems.

See Configure Single Local Application Authentication for help on configuration issues.

Of course, it is also possible to use another authentication mode like Local Application Service.

See also