Jump to: navigation, search

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

(→‎Local Installation)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
This is a short guide how to set up a {{UBIK}} Enterprise Service in a windows environment.
+
The executable for the windows service ''UBIK.EnterpriseService.exe'' can be found in the installation directory of [[UBIK_Studio_Basics|{{UBIK}} Studio]]. A windows service can be added using the command line tool ''sc.exe'' from Microsoft, detailed information how to use this tool is provided as command line help or can be found on MSDN. Once a windows service has been created and started properly, the {{UBIKES}} processes the corresponding command files and carries out the operations. For more information about command files and interfacing operations in general see [[:Category:Interfacing]].
  
−
== Installation & configuration of {{UBIK}} Studio ==
+
__TOC__
−
[[File:UI_UBIKStudio.png|thumb|upright|alt={{UBIK}} Studio|{{UBIK}} Studio]]
+
−
[[File:UI_UBIKStudioOptions.png|thumb|upright|alt={{UBIK}} Studio settings|{{UBIK}} Studio settings]]
+
−
{{UBIK}} Studio can be installed and used on a local client as well as via a Remote Desktop Connection (RDP). A necessary but obvious condition is of course, that all the software tools ({{UBIK}} Studio, Microsoft SQL and IIS) can synchronize data between each other.
+
  
−
== Installation of Windows Service ==
+
== Installation as a Windows Service ==
−
The executable for the windows service ''UBIK.EnterpriseService.exe'' can also be found in the installation directory of {{UBIK}} Studio. A windows service can be added using the command line tool ''sc.exe'' from Microsoft, detailed information how to use this tool is provided as command line help or can be found on MSDN. The executable ''UBIK.EnterpriseService.exe'' is found in the installation directory of {{UBIK}} Studio. Once a windows service has been created and started properly, the {{UBIKES}} processes the corresponding command files and carries out the operations. More about {{UBIK}} command files and interface operations see {{UBIKIF}}.
+
  
−
<code>
+
To install {{UBIKES}}
−
@echo off sc delete "UBIK Enterprise Service"<br />
+
# Locate the ''UBIK.EnterpriseService.exe'' in your local {{UBIK}} installation directory
−
sc \\<SERVERNAME> create "UBIK Enterprise Service" binPath= "<PATH_TO>\UBIK.EnterpriseService.exe" start= auto DisplayName= "UBIK Enterprise Service"<br />
+
# Add a windows service using the command line tool ''sc.exe'' where
−
sc \\<SERVERNAME> description "UBIK Enterprise Service" "UBIK Enterprise Service"<br />
+
:: ''<SERVERNAME>'' is the name of the local machine, eg. MYCOMPUTER
−
sc \\<SERVERNAME> start "UBIK Enterprise Service"<br />
+
:: ''<PATH_TO>'' is the installation directory of {{UBIK}}
−
</code>
+
  
−
{{Attention|Please make sure that you execute the EnterpriseService with a user that has sufficient user rights for your automation tasks! The user can be changed in the Windows Servicemanager!}}
+
<source lang="dos">
 +
sc delete "UBIK Enterprise Service"
 +
sc \\<SERVERNAME> create "UBIK Enterprise Service" binPath= "<PATH_TO>\UBIK.EnterpriseService.exe" start= auto DisplayName= "UBIK Enterprise Service"
 +
sc \\<SERVERNAME> description "UBIK Enterprise Service" "UBIK Enterprise Service"
 +
sc \\<SERVERNAME> start "UBIK Enterprise Service"
 +
</source>
  
−
==See also==
+
{{Hint|Use the command line tool sc.exe from Microsoft to add and configure an appropriate windows service!}}
−
* [[Microsoft_SQL_Server|Set up Microsoft SQL Server]]
+
−
* [[Microsoft_IIS_Server|Set up Microsoft IIS Server]]
+
−
* [[UBIK_Studio_Basics|{{UBIK}} Studio Basics]]
+
  
−
[[Category:UBIK Studio]]
+
{{Attention|The user account configured for starting the Enterprise Service has to have sufficient permissions to access all necessary locations! If required the user can easily be changed via the Windows Servicemanager!}}
−
[[Category:Configuration]]
+
 
 +
== Fault Recovery ==
 +
 
 +
In case the Enterprise Service crashes for some reason, you can configure an automatic restart.
 +
 
 +
To do so, open the "Services" app (e.g., using the Windows search). Right-click the respective service entry to open the context menu for it and click "Properties". In the properties dialog, there is a tab "Recovery" where you can configure what to do in case of an unexpected shutdown.
 +
 
 +
[[Category:Enterprise service|Install UBIK Enterprise Service]]
 +
[[Category:How-To|Install UBIK Enterprise Service]]
 +
[[Category:Installing|Install UBIK Enterprise Service]]

Latest revision as of 16:46, 21 December 2022

The executable for the windows service UBIK.EnterpriseService.exe can be found in the installation directory of UBIK® Studio. A windows service can be added using the command line tool sc.exe from Microsoft, detailed information how to use this tool is provided as command line help or can be found on MSDN. Once a windows service has been created and started properly, the UBIK® Enterprise Service processes the corresponding command files and carries out the operations. For more information about command files and interfacing operations in general see Interfacing.

Installation as a Windows Service

To install UBIK® Enterprise Service

  1. Locate the UBIK.EnterpriseService.exe in your local UBIK® installation directory
  2. Add a windows service using the command line tool sc.exe where
<SERVERNAME> is the name of the local machine, eg. MYCOMPUTER
<PATH_TO> is the installation directory of UBIK®
sc delete "UBIK Enterprise Service"
sc \\<SERVERNAME> create "UBIK Enterprise Service" binPath= "<PATH_TO>\UBIK.EnterpriseService.exe" start= auto DisplayName= "UBIK Enterprise Service"
sc \\<SERVERNAME> description "UBIK Enterprise Service" "UBIK Enterprise Service"
sc \\<SERVERNAME> start "UBIK Enterprise Service"
IC Hint square.pngUse the command line tool sc.exe from Microsoft to add and configure an appropriate windows service!
IC Attention.pngThe user account configured for starting the Enterprise Service has to have sufficient permissions to access all necessary locations! If required the user can easily be changed via the Windows Servicemanager!

Fault Recovery

In case the Enterprise Service crashes for some reason, you can configure an automatic restart.

To do so, open the "Services" app (e.g., using the Windows search). Right-click the respective service entry to open the context menu for it and click "Properties". In the properties dialog, there is a tab "Recovery" where you can configure what to do in case of an unexpected shutdown.

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