TurboPlayer Service installation using a UI Wizard (MSI installer)

Installation Scenario

This page guides you through the installation of the TurboPlayer Service on a local computer using the UI Wizard provided by a Windows MSI Setup program.

The installation with a UI is particularly useful for a first-time installation on a local computer. It offers extensive support for parameter validation and connection checks. For example, combo boxes are populated with valid values only, and clear error messages are provided when incorrect information, such as credentials, is entered. Additionally, a connection check is launched at the end of the installation.

Installation Instructions

Setup Folder

TurboPlayerServiceSetup.exe, TurboPlayerServiceSetup.msi, the .Net 6.0 Runtimes (x86, x64) and the ASP .NET Core 6.0 Runtimes (x86, x64) are required for installing TurboPlayer Service with the Wizard.

We recommend to copy the complete installation folder (Setup) into a local directory, because access to mounted network drives may conflict with elevated privileges required during the installation process.
Double click on TurboPlayerServiceSetup.exe to start the TurboPlayer Service setup

In case the setup fails and there is no obvious reason, a log file can help to diagnose the problem. To enable logging see Troubleshooting and Logging | Setup-Log-File.

User Account Control

(1) Click Yes (or Ok in some versions of Windows) to confirm the User Account Control dialog.

Main Installation

The setup proceeds with the main installation

On the Welcome dialog, click the (2) Next> button

Installation Folder

On the Select Installation Folder dialog, click the (3) Next> button.

Service Logon Information

On the Logon Information dialog enter the credentials under which the TurboPlayer service will run. If you leave (4) User Name, Domain and Password empty the service will start using the LocalSystem account. Choosing a specific user to run the service is useful if the service needs access to files, directories, network shares, and mounted network drives, which usually depends on user rights.
Leave Domain field empty if you want to use a local user account.

If the installation completes successful and if Start TurboPlayer service after installation checkbox is checked, TurboPlayer service will start at the end of the installation.
Click the (5) Next> button to check the credentials. While checking, the text Testing Service Logon credentials… is displayed.
If the credentials are not valid, an red error text Password does not match or Invalid User Name is displayed. If the credential check fails, the setup can not be continued.

DPE credentials

DPE service connection is required because TurboPlayer service uses the DPE Parameter service, the DPE Rights service and optionally the DPE Logging service.

Enter (6) DPE URL, User Name and Password as DPE credentials

After clicking the (7) Next> button, the connection to the URL and the credentials are checked, indicated by blue text Testing DPE credentials….
If the credentials are not valid a message box is shown which displays the error. It also contains the option to skip the validation if you want to install DPE later.

Protocols

To use secure protocols (https and wss) a valid SSL certificate had to be installed prior to run the setup (see Pre-installation requirements)

Click on (8) Use secure protocols (https, wss)
Click on (9) Select Certificate…

The Select a certificate window opens

(10) Select the appropriate valid SSL certificate. It has to be installed in the LocalMachine/My section of the Windows certificate store

Confirm the selection by clicking (11) OK
Click the (12) Next> button to continue.

Connections

The connections dialog should be filled correctly with DNS name matching the selected certificate and the default WebSocket port number 8091.

If you had chosen to use unsecure protocols (http, ws) in the prior dialog, the DNS name is empty.

Click the (13) Next> button to continue.

Service Instance Configuration

TurboPlayer Service uses the configuration parameters which are stored in the local DigaSystem Registry under Local Settings/TurboPlayerService/<Configuration>. This configuration will be attached to the specified Windows Service and automatically used at service start.

Enter a (14) new Configuration name (new is currently a requirement, will be fixed in a later version, if you enter an existing configuration, parameters are not updated).

Click the (15) Next> button to continue.

TurboPlayer connection

TurboPlayer Service can reuse existing TurboPlayer configurations to avoid specifying each connection parameter individually.

Select a (16) Computer Registry from the drop-down list, to specify which computer the TurboPlayer service should connect to. After selecting the Computer registry the list of TurboPlayer Configuration Names are filled with the configurations from that computer.
Select a (17) TP Configuration Name from the drop-down list , to specify which TurboPlayer configuration should be used to connect.
Change the (18) GUI Number if required.
All GUI Numbers of TurboPlayer GUIs and TurboPlayer Services which connect to a specific TurboPlayer Engine must be different. Incorrectly configured GUI Numbers can cause TurboPlayer to freeze, which can lead to a disruption in on-air playout.
Click the (19) Next> button on the TurboPlayer connection dialog.

Ready to Install

On the Ready to Install dialog (20) click on the Install button

Prerequisites (Optional)

The setup first checks if all prerequisites are met and installs them if not available.

In case the Windows version does not have ASP .NET Core 6.0 Runtimes (x86, x64) then installation dialogs of the Runtimes are shown.
Check the (21) I agree to the license terms and condition.
Click on (22) Install. Follow the instructions on the screen.

After the installation of the runtimes click on (23) Close.

In case the Windows version does not have .Net 6.0 Runtimes (x86, x64) installed then installation dialogs of the Runtimes are shown.
Click on (24) Install. Follow the instructions on the screen.

After the installation of the runtimes click on (25) Close.

Main installation (continued)

After the installation process, (26) click on the Finish button.

TurboPlayer Service Connection Check

After the installation the TurboPlayer Service Connection Check page is opened in the default browser

Click Open WebSocket Connection button. The Connection Status should change to WebSocket Connection is open.
Click GetVersion button. The Result column should display the version number of the installed TurboPlayer service.
Enter a valid DigaSystem credentials (Username and Password) which has the required rights to monitor or control TurboPlayer.
Click Login. The Result column should display OK.
Click Heartbeat. The Result column should display OK.
Click GetGlobalStatus. If the Result column displays Service has not license, this is fine, if you haven’t got and copied the licenses file to the installation folder so far.

Next up

Once you have completed the installation, proceed to the https://davidsystems.atlassian.net/wiki/x/LQACFQ to get and install the license file.