Terminal Server#

System requirements#

Note

A central overview of all system requirements can be found at System Requirements.

Windows Terminal Server 2025 64 Bit
Windows Terminal Server 2022 64 Bit
Windows Terminal Server 2019 64 Bit
Citrix XenApp / XenDesktop 64 Bit

Hint

The required RAM depends heavily on the individual configuration (e.g., call load, connected databases, user behavior). From the second user onwards, only a fraction of the memory required for the first user is needed.
Full XPhone Connect Outlook integration is only guaranteed if both the XPhone Connect client (including the Outlook plug-in) and Outlook are installed on the terminal server.

The following restrictions apply when Outlook is running in an environment other than the XPhone Client:

The XPhone Connect Outlook Plug-In (integration of CTI, UM, conference, presence) cannot be installed.
Private Outlook contact folders must be connected centrally via the XPhone Connect Directory. A client-side connection is not possible.
The Outlook contact card cannot be accessed from the XPhone Connect Client.

Attention

When using WebView 2 in a Citrix Terminal Server environment, some Registry Keys must be set.
When using the Team Panel, Registry Keys must be set.

Hints#

XPhone Connect products are suitable for use in Microsoft Windows terminal server environments. The following information also applies for the Citrix terminal server.

We recommend that you set a resolution of at least 1280x800 and a colour display in High Colour (16 Bit) for optimal client display on the remote computer. You can vary these settings to match the server performance and the capacity of the connection.

Hint

The registry keys are located in 64-Bit operating systems on which a 32-Bit Office is installed under the key changed by Wow6432Node, e.g. HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\...

Windows Installer Coordinator#

Microsoft introduced a feature with the Windows Server 2008 R2, which was to optimise the parallel installation of multiple applications, called Windows Installer Coordinator. Unfortunately, this feature had an error and it can sometimes happen that the Windows Installer Coordinator gets stuck in a loop and the software is not installed.

To solve this problem, it is possible to switch off the local group policies of the server or the ActiveDirectory GPOs in the Remotedesktopserver compatibility server environment. To do this, start the gpedit.msc tool in the command line; you can find the corresponding setting under:

Computer configuration > Administrative templates > Windows components > Remote desktop services > Remote desktop session host > Application compatibility

The Deactivate Remotedesktopserver compatibility for Windows Installer must be set to Activated. The server should be restarted since this is a computer policy. Afterwards, the application should be installed without a notification from the Windows Installer Coordinator.

Outlook integration#

The Outlook integration of XPhone Connect requires an installed version of Outlook.

The XPhone Connect Client requires the VB script support for the integration in Outlook. It is usually not installed in the Office versions 2013 and 2010 by the Outlook standard set-up but can be added with the following command:

msiexec /i {<GUID>} ADDLOCAL=OutlookVBScript /qb

here, <GUID> is the GUID of the Outlook MSI package. You can find it in the registry under:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\14.0\Common\InstalledPackages

Windows Terminal Server#

Client installation#

Use the TweakMsi.exe tool located next to the MSI package of the XPhone Connect Clients to make company-specific adjustments at the MSI package of the XPhone Connect Client software. In this way, you can provide the IP address of the XPhone Connect Server conveniently for all users, for example.

Before installing on the Microsoft Windows Terminal Server, run the change user /install command under an administrator account. The user session is then ready for application installation.
Afterwards, install the XPhone Connect Client by directly running setup.exe and following the instructions.
When the installation is complete, execute change user /execute. The user session is then ready to run the applications.
You can now adjust the connection data (IP address and port) of your XPhone Connect Server for all users with the XpConfig.exe tool.
- After the installation, you can find this programme in the directory:
  C:\Program Files (x86)\C4B\XPhone Connect Client
- XpConfig.exe must be started with administrator privileges.
The command to set connection data is (where :port can also be omitted, the default is ::2230): XpConfig /S=<Connection data in the format hostname:port>.

Hint

It is not necessary to start the XPhone Connect Client in the administrator account after installation.

Deleting registry keys after installation#

After installation of the XPhone Connect Client software, the following registry keys must be deleted if they exist (in 64-Bit operating systems as key Wow6432Node, accordingly). You can delete the keys manually or start the XpConfig.exe tool with the command line XpConfig.exe /TS. It must be started with an administrator account (“Run as Administrator”)!

If available, delete the entry XPhone Connect in the following registry keys on the right side. If you do not delete this registry entry, it will also be transferred to the HKEY_CURRENT_USER registry for non-XPhone users and ensures that an attempt is made to call the XPhone Connect client when Windows is started. If the entry is deleted, no user will get this setting unintentionally. Do not delete the entire registry key RUN.
- 32-Bit Windows Terminalserver:
  HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows NT\CurrentVersion\Terminal Server\Install\Software\Microsoft\Windows\Run
- 64-Bit Windows Terminalserver:
  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Terminal Server\Install\Software\Microsoft\Windows\CurrentVersion\Run
If available, delete the following registry key. If you do not delete this registry key, it may also be transferred to the HKEY_CURRENT_USER registry for non-XPhone users and ensures that an attempt is made to load the XPhone integration in Microsoft Outlook, which will establish the connection to the XPhone Connect Server. If the entry is deleted, this setting is not unintentionally adopted for any user. The XPhone Outlook integration is loaded for regular XPhone users.
- 32-Bit Microsoft Office installation:
  HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows NT\CurrentVersion\Terminal Server\Install\Software\Microsoft\Office\Outlook\Addins\AddinOutlookApp.AddinModule
- 64-Bit Microsoft Office installation:
  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Terminal Server\Install\Software\Microsoft\Office\Outlook\Addins\AddinOutlookApp.AddinModule
If available, delete the following registry key. If you do not delete this registry key, it will also be transferred to the HKEY_CURRENT_USER registry for non-XPhone users and ensures that an attempt is made to load the XPhone AddIn in Microsoft Word, which will establish the connection to the XPhone Connect server. If the entry is deleted, no user will unintentionally get this setting. For regular XPhone users the XPhone Word AddIn is loaded.
- 32-Bit Microsoft Office installation:
  HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows NT\CurrentVersion\Terminal Server\Install\Software\Microsoft\Office\Word\Addins\AddInWordFaxApp.AddinModule
- 64-Bit Microsoft Office installation:
  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Terminal Server\Install\Software\Microsoft\Office\Word\Addins\AddInWordFaxApp.AddinModule

Configuring server settings#

The XPhone Connect Server offers the option of allowing or blocking specific functions in the client applications for users, e.g. telephony, fax, voicemail, SMS, conference services. These settings are made in the configuration groups of the server and affect all users in the respective groups. Further information can be found in the XPhone Connect Server configuration chapter.

Citrix App Layer#

Hint

To ensure high-quality voice transmission in Citrix environments, we require the following:

Implementation of the Citrix HDX RealTime Optimization Pack (RTOP) . This shifts the audio/video processing from the server to the end device and improves the sound quality and server performance.
Prioritization of the following network routes for minimal packet loss and low latency:
- XCC ⟷ Citrix XPhone Client
- Citrix XPhone Client ⟷ User workstation (local audio output).

These measures ensure clear, stable voice connections, even under load.

If the XPhone Connect Client is installed on a Citrix App Layer, the operating system does not provide the necessary information that it is a Terminal Server installation. As a result, desktop components are incorrectly installed for operation as a fax client instead of the terminal server components that are actually required. This leads to errors when rendering documents.

To avoid these problems, there is a new option for the MSI installer:

FORCE_TERMINALSERVER = 0 (Default) : Does not change anything and takes the information from the operating system.
FORCE_TERMINALSERVER = 1 : Forces the XPhone Connect Client Setup to the Terminal Server installation, thereby installing the components necessary for operation in App Layer.

Hint

When using Setup.Exe for installation, the FORCE_TERMINALSERVER option can be set in the associated Setup.ini file in the Commissioning section before starting the installation.

WebView 2#

When using WebView 2 in a Citrix Terminal Server environment, some registry keys need to be set.

On the Citrix Terminal Server, open the command line and add the following registry keys:

REG ADD HKLM\SOFTWARE\Citrix\CtxHook /v ExcludedImageNames /t REG_EXPAND_SZ /d msedgewebview2.exe /f
REG ADD HKLM\SOFTWARE\Wow6432Node\Citrix\CtxHook /v ExcludedImageNames /t REG_EXPAND_SZ /d msedgewebview2.exe /f
REG ADD HKLM\SOFTWARE\Wow6432Node\Citrix\CtxHook64 /v ExcludedImageNames /t REG_EXPAND_SZ /d msedgewebview2.exe /f

Hint

Further information is provided by the Citrix Support Knowledge Center - CTX107825.

Team Panel#

For the correct display of the Team Panel, this registry key should be set on the Citrix Terminal Server:

Key: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\C4B\XPhone50\XPhone

Value: AllowsTransparency=false

The amount of memory required depends heavily on the individual configuration (e.g. call load, connected databases, user behavior). From the second user onwards, only part of the memory required by the first user is needed.

Full XPhone Connect Outlook integration is only guaranteed if both the XPhone Connect Client (including Outlook integration) and Outlook are installed on the terminal server.

The following limitations should be noted if Outlook is running in a different environment than the Connect Client:

The XPhone Connect Outlook integration (integration of CTI, UM, conference, presence) cannot be installed.

Private Outlook contact folders must be connected centrally via the Connect Directory. A client-side connection is not possible.

The Outlook contact card cannot be called from XPhone Connect.

Toolbars for Office integration#

Once the XPhone Connect Client has been installed on a terminal server, the program is available to all users. Special care is required when adjusting the tool bars in the XPhone Connect Office add-ons (telephony, fax, text message, conference in Outlook as well as serial fax in word.

If Microsoft Outlook is called up on the terminal server after installing the XPhone Connect Client, the XPhone Connect toolbars are displayed in Outlook, but may have no function (e.g. if there are insufficient licenses). Several options are available to display the toolbars for certain users only.

Customize via server settings#

Once the XPhone Connect Client is installed, the Outlook add-ons are registered in HKLM and are then loaded for all users when Outlook starts. Depending on the XPhone Connect Server settings, the corresponding tool bars are visible or not visible for the user in Outlook. This method works for all users set up on the XPhone Connect Server.

The login script can be used if the add-ons are to be loaded only for selected users. In this case, the following registry keys must be deleted after installation if existing (in 64-Bit operating systems under key Wow6432Node, accordingly):

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\AddinOutlookApp.AddinModule
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Word\Addins\AddInWordFaxApp.AddinModule

Warning

After these keys were deleted, the XPhone Connect Office Integration data are no longer loaded for any user!

The XpConfig.exe programme is used in the login script. After the installation, you can find this programme in the programme directory of the XPhone Connect Client (C:\Program Files (x86)\C4B\XPhone Connect Client). This command is added to the login scripts of users using the add-ons: <Path>XpConfig.Exe /R

This will add all XPhone Connect Outlook add-ons installed on the terminal server to the user registry of the corresponding user and set in such a way that the add-ons are available when Outlook is started the next time. To remove the add-ons again, use the command: <Path>XpConfig.Exe /U

The add-ons can also be registered with specified loading behaviour. The command for this is <Path>XpConfig.Exe /R=x. With x being one of the following values:

Tabular reference

Value	Meaning
0 (Disconnected)	Not loaded, no connection to the managed COM add-in
1 (Connected)	Loaded, connection to the managed COM add-in established
2 (BootLoad)	Loading when the application starts: the managed COM add-in is loaded and used when the host application is started.
3 (Connected - Bootload)	STANDARD; a combination of 1 (connecting the managed COM add-ins) and 2 (the managed COM add-in is loaded when the host Application starts and is connected with it).
8 (DemandLoad)	Load only after user request: the managed COM add-in is loaded by the host application if required and connected with it - e.g. if a user clicks on a button using the functionality of the managed COM add-in.
16 (ConnectFirstTime)	Only load once: the managed COM add-in is loaded during first execution of the host application after registering the managed COM add-in and connected with the application.

XpConfig.exe can also be used with the Microsoft Active Setup technology to achieve a targeted installation and loading behaviour of the add-ons.

Customize toolbar via group management#

The Outlook tool bar can also be adjusted by assigning the corresponding policies. In this case, user groups are created and access to some registry keys is blocked for certain user groups.

First, define a suitable security group, e.g. XPhone Connect users, in the Windows group management tool. Make user that only this group has read permissions for the registry keys (for 64bit operating systems, this is the key Wow6432Node, accordingly):

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\AddinOutlookApp.AddinModule
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Word\Addins\AddInWordFaxApp.AddinModule

To directly switch the use of individual functions of Outlook integration on or off, use the settings of the configuration groups on the XPhone Connect Server.

You can set the read permissions for registry keys with the programme regedit32.exe by selecting the corresponding key and clicking Menu security/authorisations.

Set the authorisations for the registry keys above as follows:

Deactivate the inheritance of permissions by deactivating the function ALLOW INHERITABLE PERMISSIONS FROM PARENT TO PROPAGATE TO THIS OBJECT.
Transfer existing permissions by copying them.
Remove the rights to the key from all those users who are not allowed to use the XPhone Connect Client by deactivating the Read and Full control check boxes (the administrator should retain all permissions in case he or she needs to uninstall the software).
Assign read permissions for the key to the XPhone Connect users by selecting the users in the top window and then selecting the Read check box.
The same method applies when restricting access to desktop shortcuts, the program directory and start menu entries to the following directories:
```
<Program Files (x86)>\C4B\XPhone Connect Client
<Common Program Files (x86)>\C4B
```
Apply the existing permissions by copying them. In the configuration variant described above, the Outlook add-ons are always loaded for all users of the XPhone Connect user group and the tool bar is visible or not visible in Outlook for the user depending on the settings in the workstation template.

Limitations for application approval or XenApp#

Sending e-mail is unsuccessful (MAPI error because using the RDP Outlook client was attempted).
Hotkey control does not work or only works with limitations
No local Outlook integration (tool bars, presence display, UM forms)
UM services do not work properly when XPhone Connect is used as front end (fax printer driver, fax viewer, voicemail player…)
Dashboard: If a browser is opened in the dashboard, the browser opens in the terminal server
Change of presence: Available/Unavailable only possible with limitations
No approval of the local screen content
No integration of a local Busylight
Poss. limited use of local audio devices for Softphone (e.g. special functions of USB/Bluetooth headsets)

Hint

These limitations are only of relevance for XenApp shared application / application release, not for XenDesktop.

Terminal Server#

System requirements#

Hints#

Windows Installer Coordinator#

Outlook integration#

Windows Terminal Server#

Client installation#

Deleting registry keys after installation#

Configuring server settings#

Citrix App Layer#

WebView 2#

Team Panel#

Toolbars for Office integration#

Customize via server settings#

Customize via login script#

Customize toolbar via group management#

Limitations for application approval or XenApp#