This ReadMe contains the most important information about Swyx 15.00: new features, system requirements, installation, and notes for successful operation.
Swyx Direct for MS Teams enables customers to connect Microsoft Teams with Swyx telephony by using Microsoft Teams' Direct Routing functionality:
Starting with Swyx 15, a wider range of Yealink desk phones and expansion modules is supported. This enhancement enables consistent device management, provisioning, and functional compatibility for a larger part of the supported device portfolio:
Swyx 15 includes a wide range of performance and stability improvements throughout the system:
Information on the hardware requirements can be found in our knowledge base:
https://service-de.enreach.com/hc/en-gb/articles/28702012589212
Information on the software requirements can be found in our knowledge base:
https://service-de.enreach.com/hc/en-gb/articles/28702161086108
You need a "SwyxServer 15 Update" license to run Swyx 15 after an update from SwyxWare 14 or an older version. During installation, you must enter an update license key.
Please note that the above license is not linked to the "Software Update Licenses Service Key". See also: https://service-de.enreach.com/hc/en-gb/articles/16338899356316
Swyx 15 can be used to update SwyxWare 13.33 or later. Updates from older versions as well as updates from SwyxWare Compact are not supported. For information on Swyx migrations, please contact your dealer.
An update from version 14.xx (evaluation) to 15.xx is not supported
When updating, you should first update SwyxServer, Swyx Control Center and then Swyx Administration. The clients should be updated last.
It is recommended to update Swyx directly instead of uninstalling the old version first.
Information on software updates can be found on our online help pages: https://help.enreach.com/cpe/14.25/Administration/Swyx/en-US/index.html#page/help/chap_installation.08.01.html
We recommend stopping all Swyx services before the update. This can be done by executing the command 'ippbxconfig.exe /stop /y' in the Swyx program folder.
Microsoft services and updates
Ensure that the latest updates for the Windows operating system and SQL Server are installed. We recommend enabling automatic Windows updates to receive important Microsoft security updates for your operating system.
Ensure that the Windows user you use for the Swyx 15 setup has administrator rights on the system on which Swyx is installed.
Please note that the user account under which the Swyx services run must not have administrator rights. If you have created your own service account, ensure that the account is not in the local Administrators group or the Domain Admins group. This ensures that the Swyx services do not receive higher privileges than necessary.
A Windows Server can have multiple IP addresses permanently or temporarily, for example when using multiple network cards or remote access software. Under these conditions, the Swyx services may use an incorrect IP address. In such cases, you can configure the IP address to be used in the Windows registry to resolve the problem. To do this, add a string named "LocalIpAddress" in the registry under the key HKLM\SOFTWARE\Swyx\General\CurrentVersion\Options. Enter as its value the IP address that the Swyx services should use.
"ProviderProfiles.config"
If you use STUN for SIP trunks, the STUN server must always be available. If this is not the case, calls via these trunks may not be possible in some cases.
By using the supplied compatibility list "ProviderProfiles.config", STUN.SWYX.COM is configured for some providers instead of the server supported by the provider. The Swyx STUN server is intended as a placeholder. It is not always available. Replace the STUN server on the "SIP" tab of the SIP trunk group properties with a STUN server supported by your provider.
SwyxIt! is the desktop telephony client for Windows systems
A new SDK is now available for developing SwyxIt! Web Extensions. It provides a standardized interface for creating custom integrations that respond to telephony events:
The number of visible line keys is now determined by the number of lines configured for the user:
Known limitation: If Plantronics Hub for Windows is installed, disconnecting an active call on line 50 or higher causes the Client Line Manager (CLMgr) to crash.
SwyxIt! now includes an integrated media player for voice messages, allowing users to:
The SwyxIt! home screen now supports enhanced layout customization:
Installation via .MSI installation package requires administrator rights
By running the installation, both clients (SwyxIt! and SwyxIt! Classic) are always installed.
Start the SwyxIt! Setup.msi file and follow the installation instructions. Further information, including unattended installation, can be found in the SwyxIt! user documentation: https://help.enreach.com/cpe/15.00/App/Swyx/en-US/index.html#page/help/Title_Copyr.html
If you start SwyxIt! unattended (without displaying the user interface), e.g. with the command-line parameter "/qn" in the MSI, the update may hang. This happens if you have installed the Outlook Add-In and outlook.exe or another Office application is running. For a smooth unattended update experience, ensure that no SwyxIt!-related processes or Microsoft Office applications are running. Technically, there is a third-party component in the installer that displays a message box that cannot be seen and confirmed by the user in certain deployment scenarios, e.g. deployment via Microsoft Intune. We plan to improve the unattended update experience in a future update.
As a first workaround, add 'PERUSERADDINREGISTRATION=1' to the MSI command line if you are using a deployment tool such as Microsoft Intune. This switches the Outlook Add-In registration to a per-user mechanism instead of per-computer. This workaround takes effect during the update step after you have set the property to 1.
On a Windows Terminal Server, the Swyx TSP can offer an arbitrary number of lines. When installing SwyxIt! with the "TSP" feature enabled on a server, the TSP "Properties" dialog appears.
On a server, the configuration of the Swyx TSP also allows you to define the desired lines. A subsequent change to this value requires a restart of the telephony service.
A TSP line must be configured for each user of the Terminal Server:
In a terminal window, only assigned lines are visible for a user. Only administrators can see all lines.
Assign exactly one TSP line to one user. This ensures that the TSP lines can be assigned to the terminal sessions.
Enabling or disabling a telephony server:
TapiMgmt.mscIf the check box is not available, start the telephony service first:
After enabling the telephony server, you must still assign the administrator account for the service.
The logon account you specify must be a member of the Administrators group on the server. It must also be located in the same domain as the server or in a domain that has a bidirectional trust relationship with the server's domain.
Assigning telephony users to a line or a phone:
These steps determine whether clients can use the telephony devices available on the server. The changes take effect after the next restart of the TAPI service. To manage the telephony service, you must be a telephony administrator on the server or logged on as an administrator. If the menu entries for user assignment are disabled, log on as a local administrator.
If you use a Jabra device with SwyxIt!, please note the following information:
When using the Headset H390, the SwyxIt! volume slider does not work correctly. The device retains its own volume control and does not respond to the Windows volume control setting. Use the volume buttons on the device to change the volume of this headset.
The SwyxIt! audio devices H370 and H371 cannot, by default, be configured as ringing devices during automatic configuration. Both always signal incoming calls only with their own device-specific ringtones. However, you can configure the headset as a ringing device by setting a registry value:
On 32-bit systems:
HKEY_LOCAL_MACHINE\SOFTWARE\Swyx\Client␣Line␣Manager\CurrentVersion\Options\AudioDevicePlugIns\IpPbx.Client.Devices.Audio.Plugins.JabraAudioDeviceCollection
On 64-bit systems:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Swyx\Client␣Line␣Manager\CurrentVersion\Options\AudioDevicePlugIns\IpPbx.Client.Devices.Audio.Plugins.JabraAudioDeviceCollection
This setting applies if a forwarded call is not accepted by the recipient and the connection is kept after a timeout. Only then is the notification tone passed to the ringing device.
In some rare cases, SwyxIt! audio output can be disturbed if the SwyxIt! audio device is also used as the Windows default audio device. If you observe this problem, please use another audio device as the Windows default audio device. You should not use your headset or handset for Windows sound output.
Only audio calls can be initiated via Swyx from the contact card or the context menu of an Office contact.
After installation of the Office Communication AddIn, only presence information from SwyxIt! is displayed within the Office applications. To display the presence information of other IM clients, the AddIn must first be uninstalled.
After installation of the Office Communication AddIn and the first start of SwyxIt!, the Office applications must be restarted once to activate status signaling.
Swyx Control Center 15.00 enables complete configuration, control, and monitoring of the integration of Microsoft Teams with Swyx telephony:
Swyx Control Center 15.00 enables complete configuration of Web Extensions for individual users or groups:
As of Swyx 15, Swyx Control Center includes a new area for administrator notes. It gives administrators a central way to document and exchange operational information within a customer installation:
Information on setting up integration with Microsoft services can be found in our knowledge base
Information on the hardware requirements can be found in our knowledge base:
https://service-de.enreach.com/hc/en-gb/articles/28702012589212
Information on the software requirements can be found in our knowledge base:
https://service-de.enreach.com/hc/en-gb/articles/28702161086108
To install Swyx Control Center, click the corresponding link on the DVD. Swyx Control Center can also be installed using the correspondingly named .msi file.
You can also start the installation of Swyx Control Center from the command line. Start the installation using the following command: "msiexec /i". You can control the scope and course of the installation using certain parameters, for example:
msiexec /i "SwyxControlCenter.msi" /passive /l*v MyLogFile.txt WEBSITEFOLDER= "C:\Program Files\Swyx" INSTALLPORT=9443 INSTALLSHORTCUT=1
You can use the following parameters:
| Parameter | Explanation |
|---|---|
| msiexec /i | Starts the installation |
| SwyxControlCenter.msi | Name of the installation file. Please check the correct name of the MSI installation file |
| /passive | Use this parameter to display the progress bar for the installation. No prompts or error messages are displayed. The installation cannot be cancelled |
| /l*v <filename>.txt | Use this parameter to record the installation process in a log file. |
| WEBSITEFOLDER | Use this option to define the directory of the IIS website. Default value: /swyxcontrolcenter |
| INSTALLPORT | Use this option to define the port of the IIS website. (from 1 to 65535) Default value: 9443 |
| INSTALLSHORTCUT | Use this option to define whether a desktop shortcut should be created for establishing the connection. (=0:no, default value: =1:yes) |
After a successful installation, you can open Swyx Control Center via the Windows start menu or access it via the URL in a web browser. The default URL is https://127.0.0.1:9443/swyxcontrolcenter/ if you keep the default settings during installation.
The Swyx VisualGroups extension provides intelligent queuing capabilities with Supervisor Board (from version 2.0) for your Swyx installation. Swyx VisualGroups is useful for all teams that want to handle a large number of incoming calls more efficiently.
Swyx VisualGroups is licensed as a floating license on a per-user basis. Three license types are available: a standard version, an enhanced version with reports and statistics, and a supervisor license.
Swyx VisualGroups Supervisor is not a floating license. It must be assigned to a specific user and is not automatically transferable to another user. The supervisor license also includes the functionality of the enhanced license.
It is recommended to license Swyx VisualGroups before installation and configuration. With the evaluation licenses included in Swyx, you can test VisualGroups with five VisualGroups Enhanced users during an evaluation period.
Information on the hardware requirements can be found in our knowledge base:
https://service-de.enreach.com/hc/en-gb/articles/28702012589212
Information on VisualGroups 2.0 can be found in our knowledge base:
https://service-de.enreach.com/hc/en-gb/articles/27414597638684
Sustainable and long-term support for push functionality.
To allow communication between the Push Notification Service and the responsible push notification gateways at Apple/Google, the required ports must be opened in the Internet firewall:
Outgoing TCP connections to port 443 on api.push.apple.com
Outgoing TCP connections to port 443 on fcm.googleapis.com
Push notification gateways may use different IP addresses with the DNS names mentioned above. Allow connections to the DNS names, not to specific IP addresses.