5.4.2 Configuring Swyx
After the installation the Configuration Wizard starts. Use this Wizard to define the configuration parameters for the installed components.
The Configurations Wizard can also be restarted at a later time in an existing installation, for example, to make changes to the Swyx configuration.
|
|
For online licensing, have the activation key that you received from your service provider ready.
|
|
|
Please note that the Swyx Configuration Wizard suspends all Swyx services. Even active calls are interrupted. It is not possible to telephone during configuration with the configuration wizard! If the configuration wizard is interrupted, all services remain suspended. If you quit the configuration wizard, all services will be started again.
|
How to Configure Swyx
You can launch the " Configurations Wizard " by going to "Start | Programs | Swyx | Swyx Configurations Wizard. "
1 Connect to SQL Server
Enter the SQL Server instance here on which you want to set up the database for Swyx.
Windows authentication (Standard)
Select this form of authentication if the user currently logged in has administrative rights on the SQL Server.
SQL Server authentication
Alternatively, select authentication with the name and the associated password of an SQL Server user.
|
|
The Windows user account specified here must have administrator rights on the SQLServer instance to create a new database. If an existing database is to be updated, administrator rights to this database ('db_owner') are required.
|
2 Database installation type:
You can choose whether you
create a database
This is only possible if an SQL Server is installed locally. This process uses the default settings and installs the Swyx database schema.
Enter a name for the new Swyx database, as well as a username and password. The user account that Configurations Wizard currently uses to access the SQL Server requires SQL Server administrator privileges ("sysadmin") to create the Swyx database.
use the existing Swyx database
Select an existing database from the drop-down list. For this, the user account specified in step
(1) needs at least the rights of a database owner ('db_owner').
3 Select database account
SwyxServer needs only restricted rights for database access. If you have selected an existing database, specify here the user name and password with which the SwyxServer should access the database.
For the rest of the installation the Configurations Wizard grants the necessary rights (db_datawriter; db_datareader; IpPbxUser) to the user account specified here.
4 SwyxServer Database:
Create... or Update...
Click on "Create..." to create a new local database.
If an existing database was selected, the database schema can be updated here.
Restore**
You can also use "Restore" here to restore an existing local database, such as one from an older Swyx installation.
Backup*
|
|
Please note that when using an existing database the update of the database is irreversible. The Configuration Wizard automatically updates the existing database from an older Swyx installation. In addition, a backup copy is made before the update of a local database. You can find this backup copy in the Swyx program directory under "C:\ProgramData\Swyx\Backup".
|
Only local databases can be restored or backed up here. A database that is installed on another computer cannot be backed up or restored by the Configuration Wizard. Use the mechanisms provided by Microsoft for this.
5 Service account:
Specify here the user account under which the Swyx system services will be started (for example, "ippbx").
A domain user account is required, if
different components are installed on different computers (e.g. a separate gateway)
SwyxFax Printer Gateway will send printing jobs to a network printer
The calendar-based call management will be used
The user name should be selected by using the "Browse" button. You then only enter the password. The validity of your entries will be checked by the Setup program. This check may take several seconds. If there is an error in the entries an error message will appear and you can repeat the procedure.
If SwyxServer does not need a domain user account, you can let the Configuration Wizards create a local user account.
The service account is added to the local group "Swyx Services," which has also been created. This group is used exclusively for Swyx services.
6 Service Account Information
The Configuration Wizard gives an overview of the user account used, and the created group.
7 Licensing (not for Swyx for Data Center)
If you have selected the standard installation in step
(5), you can choose between the following licensing types:
|
|
The selected Licensing type, Online Licensing or Licensing via License Key, cannot be changed afterwards. If you want to select a different licensing type after the licensing process has been completed, you must uninstall and reinstall Swyx and the Swyx database; see also the chapter " SwyxServerConfiguration," section "Uninstallation."
|
Online Licensing
The Swyx license server sends requests to check the licence presence. For this purpose, there must be a permanent Internet connection between the license server and your SwyxServer, for which you can specify a proxy server in one of the following steps or later, see step
(8). Additionally you have to create an instance for your system in the Swyx Operator Portal.
The following steps only apply to the "Online Licensing" type of licensing:
8 Connect SwyxServer to the Swyx License Server
Call Transfer
Click on the button to test the connection to the Swyx license server.
9 Enter the activation key you received from your service provider.
10 You can also use a proxy server for the connection, which you can define in this step or later via Swyx Control Center, see also the Swyx Control Center documentation, section "Defining proxy servers".
Outbound HTTP Proxy
Enter the IP address or DNS name of the proxy server.
Encryption mandatory
Select the check box if authentication is required to connect to the proxy server.
Enter the user name and password for authentication.
11 When you have defined a proxy server, a step for re-testing the connection to the Swyx license server appears.
12 If you have activated the programme via Swyx License Server, a step to activation via SwyxServer will appear. Click on "Activate".
13 If the activation has failed, a step to re-check the Internet connection appears.
Click on "Activate" and/or repeat the activation in Swyx Operator.
|
|
You can also enter the license key later via Swyx Control Center, see also the Swyx Control Center documentation for users, chapter "Editing General Settings", section "Entering License Activation Keys".
|
The following steps apply only to Swyx for Data Center:
14 License Server
Use this system as licensing server
The current system (back end server) is configured as licensing server. The Swyx for Data Center license is imported into this system. All other Swyx for Data Center installations (front-end servers) contact this installation to obtain their own licenses. The reporting service must be activated on this server.
Connect to a Swyx for Data Center license server
Enter here the name of the licensing server. The configured system then contacts the licensing server regularly to confirm the license validation.
15 Connect to the SQL Server Reporting Database (for Swyx for Data Center backend servers only)
Specify the SQL Server instance on which a reporting database was set up. Specify whether the Configurations Wizard should log in there with the current user account or with user name and password. For updating an existing reporting database, administrator rights ('db_owner’) on this database are needed in any case.
16 Reporting Database (for Swyx for Data Center backend servers only)
Select a previously created reporting database. The user account specified in
(15) must be ’db_owner’ in this database.
17 Account for reporting database
The reporting service, which regularly records the license data of all servers, accesses the reporting database with restricted rights. Specify the user name and password for this access.
The following steps only apply to the licensing type "Licensing via license key":
18 Swyx Licenses
If you want to insert license keys, click on "Add License...". Another window, "Add SwyxWare License Key" will now open. Indicate whether you will enter a limited or a permanent license from your license certificate (PDF). The limited license key is sent to you as a PDF.
Enter the limited license key or the name of the file containing the permanent license key.
Use this step to add all license keys for the options you want to install.
If you license a Swyx for Data Center license server, you only need one license key.
The license key (PDF) supplied is limited to a period of 30 days and includes the number of users and channels you have ordered. After the key is entered, the corresponding licenses will be shown.
Install Swyx using these limited-use keys, and request permanent keys after installation. You then insert this permanent license key into the SwyxServer configuration at this point by activating the option "File with permanent license keys", see
7.4 Pre-Configured Users and Groups.
The following steps apply to all types of licensing:
19 SwyxServer location:
Time zone
From the selection list, choose the time zone that is applicable for the default location of this SwyxServer.
Own country code
Here you define your country code. For the United Kingdom, it is '44’.
Own area code
Enter your area code here without the preceding '0', for example, '20' for London or '161' for Manchester.
Prefix for international calls
The code for international calls is entered in this field. In Germany, this code is '00'.
Prefix for long distance calls
Here you enter the digit(s) which must be dialed in order to make a long distance call. In Germany, the digit required for long distance calls is always '0'.
Public Line Access
This is the number Swyx users must dial to make external calls. Default value: ‘0’.
20 Create an administrator account to log in to Swyx Control Center.
21 Swyx Messenger
Starting with Swyx version 12.10, a new messenger with a wide range of features is available to you.
For further configuration steps see the Swyx Control Center documentation, section "Connection to Cloud Services".
|
|
For the provision of the Swyx Messenger / Swyx Meeting service, user-related data will be transmitted to and processed by our order processor, Voiceworks B.V. (also part of the Enreach Group) on the basis of a corresponding order processing contract. These products require the transmission of various data such as IP address, login data, chat messages, names of communication partners, dial-in numbers (Swyx Meeting), files sent and screenshare content (Swyx Meeting) each time they are used. Please note your duty to inform your users according to Art. 13/14 GDPR.
|
22 Active Directory extension
You can integrate the Swyx user administration into a Windows Active Directory environment.
If the log-in user account doesn't have the according rights, please enter under "Register" a user account (name and password) which has the authorization to change the Active Directory configuration, e.g. a domain administrator account.
23 Conference:
Define the user under which the ConferenceManager will later log in to the SwyxServer (default name: Conference).
The user "Conference" is always created. Conference rooms and conferences with more than three participants are only supported by Swyx after installing the "SwyxConference" option package.
In a Swyx for Data Center environment, conferences are made possible by the "SwyxAdHocConference" option.
24 After installation, set up ISDN trunks in Swyx Administration. The link to SwyxGate is made via the name of the computer on which the service was installed.
25 The Swyx database is configured using the entered parameters.
26 SwyxFax Server Properties
Enter here the Fax Station ID of SwyxFax Server.
27 SwyxFax Server configuration overview
The parameters for the SwyxFax- configuration are displayed.
28 Configuring Fax Settings (This step is not available in Swyx for Data Center)
The displayed SwyxFax configuration takes place. As many fax channels are created as licenses are present. The configured Fax Station ID is configured on all fax channels, and can be changed later in the properties of the individual fax channels.
29 Automatic updating of the system phone whitelist
You should determine a Windows task for the automatic daily updating of the system phone whitelist.
Activate the "Create scheduled task" checkbox. A new task "PhoneWhitelistUpdate" is created in the Windows task schedule and executed once. I. e. the whitelist is updated immediately. See
Install and update Whitelist.
|
|
If you do not activate the "Create scheduled task" checkbox any exisisting tasks for the automatic update of the whitelist will be removed.
|
30 If Internet connections with Swyx Clients should be supported, activate the SwyxRemoteConnector. As of V13.20, RemoteConnector is no longer configured in the configuration wizard. The required settings can be defined in the Swyx Connectivity Setup Tool (SCST), see
6 Swyx Connectivity Setup Tool
31 Close the configuration wizard afterwards with "Finish".
All services (SwyxServer, SwyxConfigDataStore, SwyxGate, PhoneManager, Swyx Utility Program, Conference Manager) will be started automatically during the configuration and are ready for operation after the configuration.
The Configurations Wizard creates a trace file ConfigWiz-<time in format yyyy.mmdd-hhmmss>.log. You will find this, like all other trace files, in the directory <common_app_data>\Swyx\Traces. Here, <common_app_data> is the standard application directory of Windows, e.g. C:\ProgramData