Xentara v2.1
User Manual
Windows Service
Note
Windows users require special privileges to configure and start services.

Under Windows, the Xentara installer installs two Windows services, one for Xentara itself, and one for the Xentara licence proxy. The services can be used to start Xentara and (if required) the Xentara licence proxy when the computer starts up.

Windows services can be managed using PowerShell, or by using the “Services” MMC snap-in. You can open the “Services” snap-in by typing “Services” in the Windows Task bar search field, or you can open the snap-in from the Computer Management console.

Windows Service User Accounts

See also
Service User Accounts in the Windows technical documentation at learn.microsoft.com

By default, the Xentara service and the Xentara licence proxy service run under the built-in Windows LocalService account. This is not a real user account, and does not have a local app data directory. This means that the model file and other configuration files must be placed in the program data directory. The model file, for example, should be placed under %ProgramData%\Xentara\Config\model.json. Similarly, licence files must be placed inside the directory %ProgramData%\Xentara\Licence.

Windows allows you to configure a service to run under any user, if desired. If you configure Xentara and/or the Xentara licence proxy to run under a normal Windows user, you can place the configuration and licence files in the usual places. The user under which a Windows service runs can be configured using the “Services” MMC snap-in.

The Xentara Service

Enabling the Xentara Service

The Xentara Windows service is called “Xentara”. By default, the Xentara service is disabled, and needs to be enabled before it can be started. You can use the “Services” MMC snap-in to enable and configure the Xentara service.

Open the “Services” snap-in, and scroll down until you find Xentara service:

Image 1: the Xentara service in the “Services” MMC snap-in

Double-click on Xentara service to open the properties, and change the Startup type to “Automatic”:

Image 2: properties of the Xentara service

You can also set the startup type to “Manual” if you want to start and stop the service manually.

Viewing Service Logs

The Xentara service logs information and error events to the Windows event log. You can use the Windows event viewer to view errors and messages logged by Xentara. To open the Windows event viewer, you can type “Event Viewer” in the Windows Task bar search field.

The events logged by the Xentara service can be found in the Event Viewer under Application and Service Logs→embedded ocean GmbH→Xentara→Xentara:

Image 3: Xentara events in the Windows Event Viewer

The Xentara Licence Proxy Service

Enabling the Xentara Licence Proxy Service

The Xentara licence proxy Windows service is technically called “XentaraLicenceProxy”. To improve readability, however, the “Services” snap-in and other UI applications show the service using its display name, “Xentara Licence Proxy”.

Like the Xentara service itself, the Xentara licence proxy service proxy is disabled by default, and needs to be enabled before it can be started. You can use the “Services” MMC snap-in to enable and configure the Xentara service.

Open the “Services” snap-in, and scroll down until you find the Xentara Licence Proxy service:

Image 4: the Xentara Licence Proxy service in the “Services” MMC snap-in

Double-click on Xentara Licence Proxy service to open the properties, and change the Startup type to “Automatic”:

Image 5: properties of the Xentara Licence Proxy service

You can also set the startup type to “Manual” if you want to start and stop the service manually.

Viewing Service Logs

The Xentara licence proxy service logs information and error events to the Windows event log. You can use the Windows event viewer to view errors and messages logged by Xentara. To open the Windows event viewer, you can type “Event Viewer” in the Windows Task bar search field.

The events logged by the Xentara licence proxy service can be found in the Event Viewer under Application and Service Logs→embedded ocean GmbH→Xentara→Xentara Licence Proxy:

Image 6: Xentara licence proxy events in the Windows Event Viewer

Managing Services Using PowerShell

Note
To manage Windows services, PowerShell needs to be run as an administrator. To run PowerShell as an administrator, right-click on the PowerShell or Terminal icon in the Windows Start Menu, and select “Run as Administrator”.
PowerShell commands
Set-Service, Stop-Service, Start-Service, Restart-Service, Get-WinEvent

The Xentara Service

Enabling the Service

To enable the Xentara service, use the following command:

Set-Service -Name Xentara -StartupType Automatic

Stopping and Starting the Service

To stop the Xentara service, use the following command:

Stop-Service -Name Xentara

To start the Xentara service, use the following command:

Start-Service -Name Xentara

To restart the Xentara service (e.g. to reload a changed model file), use the following command:

Restart-Service -Name Xentara

Getting Status and Log Entries

To get the status of the Xentara service, use the following command:

Get-Service Xentara

You can show and filter log entries using the Get-WinEvent command. The name of the event log for the Xentara service is embeddedOceanGmbH-Xentara-Xentara/Admin.

To show the last 100 log entries, you can use the following command, for example:

Get-WinEvent embeddedOceanGmbH-Xentara-Xentara/Admin -MaxEvents 100

Get-WinEvent has extensive filtering options described in the documentation. To show all critical error events, for example, you can use the following command:

Get-WinEvent -FilterHashTable @{ LogName="embeddedOceanGmbH-Xentara-Xentara/Admin"; Level=1 }

Disabling the Service

To disable the Xentara service again, so that it can no longer be started, use the following command:

Set-Service -Name Xentara -StartupType Disabled

Note that that will not stop the service automatically. You need to stop the service explicitly after you disable it.

The Xentara Licence Proxy Service

Enabling the Service

To enable the Xentara licence proxy service, use the following command:

Set-Service -Name XentaraLicenceProxy -StartupType Automatic

Stopping and Starting the Service

To stop the Xentara licence proxy service, use the following command:

Stop-Service -Name XentaraLicenceProxy

To start the Xentara licence proxy service, use the following command:

Start-Service -Name XentaraLicenceProxy

To restart the Xentara licence proxy service (e.g. to reload a changed licence server configuration file), use the following command:

Restart-Service -Name XentaraLicenceProxy

Getting Status and Log Entries

To get the status of the Xentara licence proxy service, use the following command:

Get-Service XentaraLicenceProxy

You can show and filter log entries using the Get-WinEvent command. The name of the event log for the Xentara service is embeddedOceanGmbH-Xentara-XentaraLicenceProxy/Admin.

To show the last 100 log entries, you can use the following command, for example:

Get-WinEvent embeddedOceanGmbH-Xentara-XentaraLicenceProxy/Admin -MaxEvents 100

Get-WinEvent has extensive filtering options described in the documentation. To show all critical error events, for example, you can use the following command:

Get-WinEvent -FilterHashTable @{ LogName="embeddedOceanGmbH-Xentara-XentaraLicenceProxy/Admin"; Level=1 }

Disabling the Service

To disable the Xentara licence proxy service again, so that it can no longer be started, use the following command:

Set-Service -Name XentaraLicenceProxy -StartupType Disabled

Note that that will not stop the service automatically. You need to stop the service explicitly after you disable it.