Getting Started › Installation

Server#

Video tutorial: Installation and initial setup wizard

System requirements#

Note

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

Expansion stages

Operating mode - XPhone Connect as

User

UC solution incl. CTI and Presence and UM services

5.000 [1]

Directory service with fax

10.000 [2]

Directory service without fax

16.000 [2]

Resource need

Our CSM-Webtools also contain a tool for automatically calculating the required system resources.

Hint

These are general recommendations. Actual requirements depend on many factors. Some of the constraints are explained in the following sections. Some other parameters are difficult to quantify (e.g., hard disk performance, network performance, call behavior), so the recommendations must be adjusted in practice.

Virtualization

The following virtualizations are supported:

  • VMware ESX / ESXi Server

  • Microsoft Hyper-V

  • Citrix Xen Server

Hint

Please also note our infrastructure requirements on the topic Virtualization.

Operating systems

Important

  • Current service packs are required.

  • The XPhone Connect Server must not be installed on a terminal server or domain controller.

  • Inplace upgrades of Windows systems on which an XPhone Server is running are not supported. Instead, a complete Windows reinstallation with subsequent restoration of the XPhone Server data using Backup and Restore is required.

Microsoft Client Access License (CAL)

In addition, Microsoft CAL licenses are required to authorize the server to accept client connections under licensing law. There are several ways to achieve this:

  1. Licenses can be acquired for each server so that any number of clients can be active in the network but only a certain number is authorised to connect to the corresponding server. This solution is often more useful if only one server is present in the network.

  2. The licenses are acquired per workstation so that the workstation is able to connect to any number of servers in the network. This option is often more economical for several servers.

Microsoft server products usually contain a small number of client access licences.

Software components

These software components are required before the XPhone Server installation and are not part of the installation wizard:

  • Microsoft .NET Framework: 4.8

  • Microsoft .NET Framework: 3.5 SP1

  • Microsoft Windows PowerShell 5.1

    • Installed by default in Windows Server. May be disabled.

  • For MAPI with Exchange Server Subscription Edition: Microsoft Outlook 2024/2021 (32-bit)

    • Optional: Only required if MAPI functions are to be used.

These software components are required depending on the features to be used and operating mode, and are installed using the installation wizard.

  • Microsoft SQL 2019 Express

    • If you want to use Microsoft SQL Standard/Enterprise, follow the integration guide.

  • Microsoft .NET CORE

  • Microsoft Visual C++ Redistributable

  • Microsoft Visual C++ 2013 Redistributable

  • OpenSSH

    • Optional: Only required if the XCC is outsourced to a satellite *.

  • TE Systems XCAPI

  • SQL-Server Management Studio

  • Wireshark

Browser

C4B tests the available browser version of :

  • Mozilla Firefox

  • Google Chrome

  • Microsoft Edge

Hints#

  • Please note the System requirements before installation!

  • Please activate the Printer queue (spooler) in the Windows services for Windows Server 2022 if you want to install the XPhone Fax printer driver. You should also set the startup type to Automatic.

    Otherwise, the XPhone Connect Fax printer driver cannot be installed.

  • Parallel installation of an XPhone Connect Client on an XPhone Connect Server is strongly discouraged. This is not supported by C4B Support.

    However, should it be necessary to do so for test purposes, the following points must be taken into consideration during installation:
    • Only the XPhone Connect Client may be selected for the installation features; Outlook integration, fax printer drivers, etc. may not be installed as well.

    • During the XPhone Connect Client installation, the XPhone Connect Server service or other dependent tools must not be started.

    • The XPhone Connect Client must have the identical version of the server.

    • If the server or client is to be updated to a higher version, it must be ensured that all XPhone Connect software has been closed. Both client and server must both be updated to identical version before next use.

  • The entire server directory must be excluded from the virus scanner. This is the default path, unless you have changed it:

    C:\Program Files\C4B
    

Installation#

Attention

If you want to perform a major release upgrade from V9 to V10, follow the Upgrade documentation.

  • Download the software from the C4B homepage <https://www.xphone-connect.com/de/service/software-download/>.

  • Unzip the compressed file and start the XPhone Connect Server Setup from the directory:

    \XPhoneConnect_V10_X_XXX\Software\Server\setup.exe
    

If the operating system meets the requirements, the Installation Wizard will open, otherwise a message will appear.

Installation wizard#

Start

The Installation wizard opens. If you do not use an approved operating system or the current service pack, the corresponding notification will appear. The following window appears if the operating system complies with the requirements:

req_1

MAPI selection

This shows you a selection of options depending on whether or which MAPI is already installed:

req_2

Tip

Please also note the MAPI integration instructions.

Operating mode

In the following window, you can select one of three operating modes:

  • XPhone Connect as UC solution

    In this operating mode, you can use all features offered for XPhone Connect including directory services (XPhone Connect Directory).

  • XPhone Connect as Web service

    This operating mode allows you to install the web applications on a separate computer.

    Tip

    Outsourcing web applications - Description for the installation of web applications (Analytics, Mobile, Meeting, UMSettings) on a separate computer (DMZ).

req_3

Note

  • The XPhone Connect as Directory Service operating mode is no longer available. Instead, you can use Contacts by XPhone.

  • A specially adapted installation is required for Contacts by XPhone, which reduces the configuration effort for Contacts by XPhone.

  • Further information can be found on the Contacts by XPhone website and in the CbyX Administrator manual.

  • If you want to migrate the XPhone Server in XPhone Connect as Directory Service operating mode to Contacts by XPhone, please follow these Migration instructions.

Installation mode

Furthermore, two installation modes are available:

  • Complete

    All components required for operation of the XPhone Connect Solution are installed automatically. Necessary restarts of the operating systems are done automatically. Input from the administrator is not required.

  • Custom

    The components required for operation of XPhone Connect can be installed by activating the setups manually.

req_3-1

Hint

If you want to use existing SQL server, select User defined as the installation mode.

Requirements

The components shown below are installed (user-defined or automatically) for XPhone Connect operation. During the complete installation, you have the option to cancel or pause the installation.

req_4

These components are automatically installed one after the other when you select the Automatic installation mode. With User defined you can have the components installed automatically one after the other via the Install all button or one after the other from top to bottom.

You may be prompted for a Windows system restart.

req_5

IIS

All required components of the Microsoft Internet Information Service (IIS) are installed on the next page:

req_7

Optional components

Select whether you want to install Open SSH.

req_8

SQL Server

The next dialogue installs two Microsoft SQL Server Express instances and possibly the SQL Server Management Studio:

  • XPCONNECT

    In this instance, all data of the XPhone Connect Server is saved.

  • XPANALYTICS

    In this instance, the data for the statistics module XPhone Connect Analytics is saved.

Hint

  • Please always install the XPhone Connect Server with both SQL server instances suggested by the installation wizard, even if you want to operate it later with an external SQL server. If the XPhone Connect Server is missing the local instance for the Connect Server data during initial configuration, problems will occur when changing the account under which the server service is run. However, this is a prerequisite for access to the external SQL server.

    • Workaround: If the above-mentioned problem still occurs, you can also run the XPhone Connect Server Manager with another user account that has access to your own SQL server. If Windows does not offer the option Run as another user in the context menu, this can be activated in the registry. A description for this can be found e.g. here. The Server Manager user can now change the service account in their own database.

Attention

If you are using an outsourced SQL server: After the update/upgrade, check the Application Pool Identity of XPhoneConnectAnalytics in IIS Manager. It must contain an Active Directory user. Further information can be found in the chapter Outsourcing the SQL server - procedure for Analytics.

req_10

req_12

Telemetry

In this dialog you install Prometheus:

prometheus

Hint

You can find out how to record and evaluate the telemetry data in the Telemetry chapter.

IP-CAPI

The IP-based CAPI XCAPI can optionally be installed on the following page. The installation is only required if you use the feature Fax or Voicemail. Please note that the corresponding licenses for XCAPI must be purchased from C4B.

req_14

XPhone Call Controller

The installation of Wireshark and Npcap is recommended. With npcap network traces can be created for the SIP gateways. These may be necessary, e.g. for support requests for XCC conferences or AnyDevice / Softphone. Only network information for the local port of the SIP gateway is recorded.

These trace files can be analysed with Wireshark

Tip

A Remote network trace is also possible with Wireshark.

req_15

Installation

Finally, activate the setup of the XPhone Connect Server:

req_17

Server setup#

The setup for the XPhone Connect as UC solution operating mode now appears:

xpsv10

Select the features you want to use now. It is possible to add features with Control panel > Add Programs and features:

xpsv10-feat

Here you can see all the features in detail:

xpsv10-1-feat

Hint

Deactivate the features that you do not want to license or use. Otherwise, error messages may appear in the XPhone Connect Server and Windows Event Log when starting unlicensed features, for example.

After completing the setup, the XPhone Connect Server Manager is automatically called up, provided the corresponding option has been selected at the end of the setup. The XPhone Connect Server service is not started, e.g. to make changes to the database connection (atlas.xml) or to change the service account. If you do not want to make any settings to the service account, click on Start. Once the service has been fully started, you can begin with the XPhone Connect Server configuration. To do this, click on XPhone Connect Server under Administration. The Web-Administration opens.

xpc_servermanager

Tip

When you open the web administration for the first time, the Setup wizard appears.

Your opinion matters!

Be it praise, helpful ideas, or a tip about an error – we truly appreciate every message.
Just send us an email at doku@c4b.de. And help us make this documentation even better.
Thank you very much for your support!