WMS Settings Menu Guide - English
Mar 21, 2018 18:40
WMS Settings Menu Guide provides the basic information on the Settings options and explains how to set up various parameters.
Updated: February 2018
Set up the connection between Server and Client PBXs.
Information on ports:
- Enable the port 443 TCP (or another custom secure port) and 1194 UDP on the side of the Server PBX
- Access to WMS network nodes between PBXes: incoming 1194 UDP
To set up WMS Network:
- Choose the Data sync role: Server or Client
- Server PBX IP (Client PBX): enter WAN IP address or *.wildixin.com domain name of Server PBX
- Sync configuration port: (443 TCP by default) communication port for sync of configuration
- Server/ Client VPN port: (1194 UDP by default) communication port of WMS protocol
- MTU: the size of the largest protocol data unit that can be passed on VPN (MTU = maximum transmission unit)
- Login: user name (must be the same on Server and Client)
- Password: password (must be the same on Server and Client)
Click Start button to activate sync between the PBXs (first start the sync on Server, then on Clients).
Click Stop button to deactivate the configuration sync for this PBX.
Click Re-initialize Client button to restart the connection (only on Clients).
Click Update parameters button to update the parameters after they have been changed.
Server configuration example:
All the PBXs belonging to the same WMS Network can have only one admin user, which is the admin user of the Server PBX.
Enabling Client mode on a PBX that has been previously in use will delete all users and groups from the Client, to avoid this, follow the procedure of Server replacement, described below.
WMS network Server replacement procedure:
Proceed as follows:
- Move all users from Client (future Server)
- Disable wms-network on this Client
- Delete this Client from PBXs page on Server
- Make a backup on Server
- Apply this backup on Client
Language & region
Specify the PBX language and region settings:
- Language: select the default PBX language (do not confuse with the WMS interface language that can be set up in WMS -> Users -> select a user/ users and click Edit). All the system sounds will be pronounced in the selected language. Before selecting the language, make sure that the corresponding sound package is installed.
Default Tone Zone: select your country / region
Country Code: select your country code for the correct routing of incoming and outgoing calls
Time zone: select your time zone for the sync with the external NTP server (NTP server section)
Sounds packages: select the sound packages to be installed (maximum three sound packages can be enabled at a time)
Call and chat history
On Cloud PBX you can simply disable / enable the PBX to save chat and call history (CDR):
On Hardwrare / Virtual PBX, you can set up and select the backend used for storing chat history and call history (CDR). Hardware / Virtual PBX supports three CDR storage modes:
External server Microsoft SQL: MySQL or MSSQL. The server must be previously installed and must be reachable by the PBX.
Internal database: CDR Sqlite. In this case CDR is stored on the PBX (on the backend specified for CDR storage). This backend is recommended for PBXs with 40 users and less
CSV file: file can be saved to a storage device (USB or network share).
Step 1. Enable connection to the database (Hardware, Virtual PBX)
Go to tabs CDR MSSQL / CDR MySQL / CDR Sqlite - you must enable connection to at least one database (however all the modes - CDR MSSQL, CDR MySQL, CDR Sqlite and CDR CSV - can be enabled at the same time)
Example of MSSQL/MySQL configuration:
- Enabled: check the box to enable connection to the backend
- Hostname: the name or the IP address of the remote server
- Database name: the existing database where the CDR must be saved
- CDR table name: the name of the table that the PBX creates on the remote database
- User: the user to access to the server
- Password: the password to access to the server
- Port: specify the port used for connection
Note: It is also possible to enable connection to MSSQL instance.
Requirement: SQL Server browser must be running on MSSQL host. Please check the Microsoft documentation for detailed information on SQL browser.
To enable the connection, check the box "Enabled" and fill in the following data:
- Hostname: specify MSSQL instance in the form of ip_adress_of_SQL_server\instance_name. For example, 10.100.3.123\SQLEXPRESS
- Database name: the name of database where the CDR will be stored
- CDR table name: enter the name of the table created by the PBX on MSSQL Server
- User and Password: enter the credentials to access to SQL Server
- Port: there is no need to specify the port when connecting to MSSQL instance. By default MSSQL itself listens on TCP port number 1433, but for instances the TCP port is dynamically configured
Step 2. Select the backend for CDR storage (Hardware, Virtual PBX)
Go to the tab CDR Settings to select the backend that will be used for displaying CDR statistic in Settings tab. You can choose only one backend.
- CDR-backend (Hardware, VIrtual PBX): choose the backend for saving CDR
- Enable contact notes: enables the Notes feature of Wildix Collaboration
- Tags: this field allows you to addtags; later on these tags can be selected via Dialplan application "Set" (see Dialplan applications User Guide) and set via Coallaboration (see Collaboration User Guide)
- Hide in CDR-View: allows hiding last X digits in CDR-View from phone numbers consists of more than 7 digits. Must be used together with ACL “Can/cannot see full number in CDR-View”.
- Delete after: old CDR will be deleted after a number of months specified in this field.
Click Save to save the configuration.
For each backend there is a log shown in the right part of the screen, with the actual status and eventual problems and errors.
General PBX parameters and parameters for the voice transport:
- Auto discover external IP address (Hardware, Virtual PBX): if enabled, uses DynDNS url specified below to discover the external IP
- DynDNS website url (Hardware, Virtual PBX): url of the service to discover the external IP
- External IP address (Hardware, Virtual PBX): external IP address manually set up
- External secure port (Hardware, Virtual PBX): (default 443): option to use a different port for TLS connections
Use only https (Hardware, Virtual PBX): If enabled, all http connections are redirected to the port 443 or the alternative https port (if configured)
Note: the parameter is enabled for Cloud PBXs by default.
- Random music on hold (available from WMS version 3.88): if enabled, music on hold to be played back is selected randomly by the system
- Default music on hold: select default music on hold
- RTP start port / RTP end port (Hardware, Virtual PBX): set up the port range out of which the RTP ports are dynamically taken, normally 10 000 : 15 000
- Outgoing registration timeout (seconds): set up timeout for SIP registrations on the PBX, for stable connections it’s better to augment this value to reduce the network traffic
- Jitter buffer (min / average / max delay): set up the jitter buffer delay values
- RTP / T.38 ToS / DSCP and SIP ToS / DSCP: optimal values are set up by default for these parameters and should be changed only if necessary
To set DSCP QoS for all the Wildix devices:
- Set DSCP value at af41 or higher in WMS Settings -> PBX -> SIP-RTP
- Configure all the routers / firewalls to prioritize such traffic
It is possible to enable / disable DSCP QoS for WebRTC phone (Collaboration on Chrome) and ubiconf conference in Collaboration Settings -> Web Phone -> DSCP QoS:
- Default: If DSCP value is set to af41 or higher in WMS Settings -> PBX -> SIP-RTP, then DSCP is enabled by default
- On / Off: Force DSCP on or off, independently from the settings on SIP-RTP page
Occasionally routers / firewalls / operators can block traffic with DSCP settings different from 0, in such case:
- Administrator must disable globally DSCP QoS in WMS Settings -> PBX -> SIP-RTP
- User can disable QoS separately for WebRTC Phone (Web Phone on Chrome) in Collaboration Settings -> Web Phone
- Use TLS / SRTP for local devices (Hardware, Virtual PBX):* TLS is by default ON for remote devices, here you can enable/disable TLS/SRTP encryption also for local devices
- Require provisioning password in local networks (Hardware, Virtual PBX): when enabled, the system does not provision automatically those devices whose passwords are different from the passwords present on Devices page (default passwords are given to devices during reset procedure; more about auto-configuration of Wildix devices: Provisioning of Wildix devices)
- Auto add new devices in local networks (Hardware, Virtual PBX): when enabled, devices are added and provisioned automatically in local networks
- Enable wideband codec usage for all networks: when enabled, codec priority is given to the wideband codecs of the remote devices
Codec priority is chosen automatically, normally the priority is given to the not compressed codec (G.711 aLaw) in LAN network and compressed (G.729) for remote connections.
- Enable wideband codec usage in LAN (Hardware, Virtual PBX):* enabled by default, the system uses G.711 codec in local network (IP classes specified in “Network field which must be considered local”)
- Networks where force usage of wideband codecs:* if the usage of wideband codec is disabled, it’s still possible to force its usage on some networks
- Custom Direct RTP Subnets: the networks that are considered local by the PBX and on which the wideband codec usage is forced
TLS Certificate (*.crt) (Hardware, Virtual PBX): upload a TLS certificate file
Generate certificate for SIP-RTP page on LINUX system:
- openssl genrsa -des3 -out server.key 2048
- openssl rsa -in server.key -out server.key
- openssl req -sha256 -new -key server.key -out server.csr -subj “/C=IT/ST=TN/L=My City/O=My Company/CN=examplecompany.com” (use your country instead of IT (Italy) and your region instead of TN (Trento))
- openssl x509 -req -sha256 -days 3650 -in server.csr -signkey server.key -out server.crt
Output: server.crt server.csr server.key
Upload server.crt and server.key to WMS Settings -> PBX -> SIP-RTP page.
- TLS Private Key (*.key) (Hardware, VIrtual PBX): upload a TLS private key file
* In case of changing these parameters, it’s necessary to go to the tab Devices, select all the devices and click Configure/ Sync device.
Enable integration with Oracle / Fidelio PMS and other hotel management systems that support FIAS protocol.
Refer to the Hotel Integration Guide for detailed information.
QueueMetrics (Hardware, Virtual PBX)
QueueMetrics is not supported starting from WMS version 4.0
Enable the integration with QueueMetrics software.
Note: QueueMetrics is working only with MySQL DB.
- Remote queues logging: enables MySQL remote Queues logging service
- Hostname: IP or host name of MySQL database
- User: the user to access to the server
- Password: the password to access to the server
- Database name: the name of the database
Network (Hardware, Virtual PBX)
Set up the network parameters based on the selected network scenario: you can keep the data and voice networks separated or shared.
On Virtual systems, Network parameters are available in read only mode.
Shared data and voice networks scenario
In this scenario the single connected port is WAN eth0, the IP address is received from the DHCP server.
- WAN eth0 (dhcp) inrterface gets the IP address from DHCP server, LAN eth1 interface is inactive:
Separated data and voice networks scenario
In this scenario the PBX itself functions as a DHCP server. WAN eth0 port is configured as DHCP client, LAN eth1 port must be set up with the static IP and DHCP server enabled. The default address of the eth1 port is 10.135.0.1.
- WAN eth0 interface gets the address from DHCP server: LAN eth1 interface – static:
Read more about network scenarios: WMS Start Guide - English#Choosinganetworkscenario(HardwarePBX)
After you have changed the network settings, click Apply network settings to apply the new parameters.
WMS Network interface
- DMZ wtun0 (static) interface is used for connection to WMS Network. The interface cannot be edited unlike enth0 and enth1 interfaces
- Click + Virtual to add a virtual interface to be able to assign more than one IP to a physical interface
- Click + Vlan to add an interface with VLAN settings
- Click Enable routing eth0 to enable devices connected to other interfaces to use the data connectivity of the PBX (WAN port)
- Click Enable traffic shaper eth0-eth2 to create a bridge between the two interfaces and give a higher priority to the data traffic coming from eth0; more information in WMS Start Guide - English#Choosinganetworkscenario(HardwarePBX)
- Click - to delete the selected virtual interface
- Click Edit to edit the settings of a selected interface (IP, subnet, status)
Routing and gateways
If the PBX’s WAN interface is connected to the network with the active DHCP server, the entry is automatically created in this table, containing the gateway assigned by DHCP server.
- Click + to add a new interface
- Click - to delete a selected interface
- Click Edit to edit the settings of a selected interface
- Click + to add a new host. Enter its address and hostname
- Click - to delete a selected host
- Click Edit to edit parameters of a selected host
You can also modify the DNS server and System name. System name is used as the PBX alias name – *.wildixin.com domain name.
Each PBX with Public IP can be accessed by either its serial number or by the value set up in System name:
Note: value set up in System name is synced with the one set up in WMP -> PBX Details -> Name.
If you modify the DNS server, click Apply DNS service to apply the new parameters.
HTTP proxy client (Hardware, Virtual PBX)
Allows you to enter the data for connection to a proxy server.
- Enable HTTP proxy for Support VPN: this option allows you to activate remote support and connection to Wildix server in case HTTP proxy is used
- Proxy host: IP address of the proxy server
- Port: listening port of the proxy server
- Proxy authentication method: authentication method used by server (None, Basic, NTLM)
- Login: user name (if required by authentication method)
- Password: password (if required by authentication method)
LDAP/Radius server (Hardware, Virtual PBX)
Set up connection to LDAP server and Radius server. This feature allows you to use a PBX as an LDAP server for users sync.
- Enable external connections to LDAP/Radius: enables access for external connections to the PBX
- Allowed host(s): security parameter allowing access only to the subnets entered here (e.g.: 192.168.0.0/24, 10.0.0.0/8); when using Overlay solution, enter here the IP of the Overlay Core
- Password: allows you to set up a password for connection to the server
DHCP server (Hardware, Virtual PBX)
If the chosen network scenario uses the service of the DHCP server of the PBX, make sure that the options of the service are enabled with the correct settings.
DHCP server is integrated for auto provisioning of supported devices. It’s possible to enable the server for the initial configuration of the devices and successively disable it, otherwise, enable the parameter Deny unknown clients.
Click + button to expand DHCP server parameters:
- Enable DHCP server at boot time: enables internal DHCP server and allows you to select the interface on which the server is enabled (normally eth1)
- Start/ End address: range of IP addresses that can be assigned to hosts
- Default lease time (mins): minimum time period for lease duration
- Maximum leases: maximum number of leases that can be assigned
- Domain name suffix: if the hosts are inserted in the network which is managed by the domain controller
- Default gateway: IP address of the router or of the PBX (in case of LAN interface)
- Primary / Secondary DNS server: addresses of DNS servers
- Primary /Secondary NTP Server: addresses of NTP servers
- Primary / Secondary WINS Server: addresses of WINS servers
- Deny unknown clients: if enabled, IP addresses are not automatically assigned to unknown hosts
After you make some changes, click Save changes button.
All the IP addresses which DHCP server has assigned to devices, appear in this table.
- To delete a lease, click - button
- To set up this IP address as static, click Edit button
- To release the previously assigned addresses, click Purge leases button
Enable the PBX to send notifications of the new voicemails, missed calls, chat requests, call recordings, faxes, etc.
Note: Wildix Cloud PBXs offer default server for sending email notifications. Just enable Default settings option to be able to use the default server.
To activate SMTP client, enter the following parameters:
- Default settings (Cloud PBX): enable the option to be able to use the default server for sending notifications
- Email from: address to be used by PBX to send emails
- SMTP mail server: server’s postal address used by the company
- Port: listening port of the SMTP server
- SMTP authentication method: choose the authentication method for the SMTP server
- Timeout: select the timeout for the SMTP server to send notifications
- User: user name to access the server
- Password: password to access the server
- HELO domain: domain defined for sending emails. Default value is “localhost”, change it in case anti-spam filters of the SMTP server block sending the message
- Enable TLS: TLS protocol enabled for the security of the connection to the server
- Enable STARTTLS: STARTTLS option enabled if provided by SMTP
After you have entered all the parameters, proceed as follows:
To make sure that the entered parameters are correct, enter the email address into the field located in the upper right section and click Test
The logs are displayed in the field below and you receive the following email:
Note: in case you are having problems setting up SMTP client with Google account, proceed as below:
- Enable 2-Step Verification in your Google account settings (account settings of the user to access the server):
- Add Apps password (appears only after you set up 2-Step Verification)
- Use this apps password for authentication in SMTP client. Insert it in the Password field
Allows you to enable Mail2Fax and Mail2SMS services and specify the general parameters for FAX/SMS management.
For SMS sending, W01GSM is required.
- Send a copy of sent and received faxes and sent SMS to this e-mail: this option allows you to enter an email address to which all the incoming and outgoing faxes are saved
- Standard SMS header: allows you to enter the header for SMS messages sent by PBX
- Remote PBX (for SMS sending): allows you to select the PBX in WMS Network to send SMS messages
- Fax delivery notification: allows you to enable fax delivery confirmation notification
- Curl SMS send enabled (available from WMS version 3.88): enable to send SMS with a curl request
- Curl SMS send (available from WMS version 3.88): enter the curl command. Click ? button to see the list of curl command examples and possible variables
Click Save to apply the settings.
The PBX checks the mailbox, once new emails corresponding to the parameters of Mail2Fax service are found, the PBX sends them to the destination fax number(s) present in the email.
To create a new Fax/ SMS server profile:
- Click + to add a new Fax/ SMS server profile
- Enter the following parameters:
- Name: enter the profile name (identifier)
- Protocol: select the protocol of communication with your email server (POP3 or IMAP)
- Server: settings of your email server to access incoming messages
- Use SSL: enables secure connection to the server (required by some email servers)
User: email address of user to access to the server
Note: don't use here an email of a user who must send faxes via Fax2Mail service.
- Password: password to access to email address of user specified in the field above
- Keep e-mails and faxes on server: enables storing of messages on the server
- Dialplan procedure: select the Dialplan procedure to manage
- Protection password: security password for MAIL2FAX service
- Default LOCALSTATION: sender’s fax machine ID, appears at the top of each page of outgoing fax, if not specified the default value “Fax Server” is used
- Default LOCALHEADER: fax header to identify the sender, appears at the top of each page of outgoing fax, if not specified the default value “Wildix PBX” is used
Click Save to apply the changes
Select the profile from the list and click Test fetching mails to make a test and check if the entered parameters are correct.
You can delete a selected profile by clicking - or make changes by clicking Edit.
For more information about Fax/ SMS Server, read Wildix Fax/SMS Server Manual.
SNMP server (Hardware, Virtual PBX)
Start the SNMP server integrated into the PBX to allow remote monitoring of system resources.
- SNMP Server: enables the access to the SNMP server
- Community: enter the server identifier
- Port: external port of access
- Trusted IP: enter the list of the clients that can connect to the server
Storages (Hardware, Virtual PBX)
Configure a backend to store all the data of the PBX (Voicemail, call records, faxes, CDR, backups, etc).
For an on-premise PBX, the USB drive inserted into the PBX serves as a backend for storing all the data. It is recommended to store the Backups on another USB drive or on a Windows share, to be able to restore the system in case of the primary USB drive’s failure.
This table displays all the storage devices mounted at the system startup with the relative table of the partitions and the usage of the specified partition.
- Click Initialize to start the partition and formatting procedure of the storage device
- Click + to add the partition for each service
- Click - to remove a selected partition
Add NFS/Windows share
Click + to add a new NFS/ Windows share.
- Type: select NFS/ Windows share
- Host: IP adress or host name of the server
- Path: name of the NFS share created at the host
- Service: select the service to be saved to the NFS share (Call generation, CDR CSV)
- Host: IP address or host name of the server
- Path: name of the Windows share created at the host
- Domain: domain name of the host machine
- User name: user name to access to the resource
- Password: password to access to the resource
- Service: select the service to be saved to the Windows share (Call generation, CDR CSV)
Synchronize the PBX with an external NTP server.
- Use an NTP Server: enables the sync
- Primary NTP server: enter the primary server address
- Secondary NTP server: enter the secondary server address
- Synchronize manually: use the parameter only in case the sync with an external NTP server is disabled (not recommended)
- Time: set up the time and the date manually
Tools and utilities
Displays the information about the Wildix server, which is used for remote support and the PBX sync with the Wildix Management Portal.
Check information on ports to open for Remote Support: https://manuals.wildix.com/ports-used-by-wildix-services/
In the lower part of the screen you can set up the PBX to send the geographic position of the PBX to the Wildix server (geolocation tools are provided by Google) (Hardware, Virtual PBX).
Create and download the system backup and set up a scheduled system backup.
You can create the copies of PBX configuration on the Windows share or on the USB storage device (defined in System -> Storages (Hardware, Virtual PBX), otherwise the backup can be created and downloaded directly on your PC.
To perform the backup procedure:
- Generate a backup file by clicking Generate backup
- In case you have the generated file and you need to upload it: click Choose file, select the file and click Upload to upload it. The file will be available to in list of available backup files
- Select the preferred file from the list and click Apply backup
- Confirm the backup by clicking Yes:
Note: in case you have set up WMS Network, you will need to click Re-initialize Client button on WMS Network page on each of the Client PBXs to have users and groups synchronized.
Note: "restore network" option allows you to restore network parameters saved in Settings -> System -> Network. In case you don't need to restore these parameters, uncheck the box (the network parameters will be restored by default).
- After the backup is completed, you'll need to reboot your PBX. Click Reboot button to start the process:
- After the reboot is completed, you will be forwarded to the login window
- Log in to proceed with the system
- Click Generate and download backup to generate a copy of the backup file and saves it to your PC. The downloaded file can be used for performing the backups on other PBXs)
- Click Generate and download sounds backup to generate a backup copy of all the sounds saved on the PBX. The backup of the configuration does not contain all the sounds that can be saved after the first modifications to a separate file
- Click - to delete a selected backup file
- Click Download to download a selected backup file to your PC
- Click Reset o reset to the default parameters
Limitation: In case of applying backups from another PBX, it is necessary to go to WMS -> System -> Storages and add back storages (for Virtual / HW PBX).
You can set up a scheduled backup to share, FTP or email which will be performed daily/ weekly/ monthly
Enable one of the options for the scheduled backup:
- Backup to share (Hardware, Virtual PBX):
- Perform: enable the system to perform the backup every day/ week/ month
- Backup to FTP:
- FTP host: host address of FTP server
- FTP port: enter FTP port
- FTP login: user name
- FTP password: user password
- FTP upload directory: directory IP adress or domain name for uploading of backup files
- Enable passive mode: tick off to enable
- Perform: enable the system to perform the backup every day/ week/ month
- Email: enter an email address to get backup reports
- Perform: enable the system to perform the backup every day/ week/ month. The backup is performed during the night
Click Save to save the changes.
Click Perform backup now
Check if there is a new version available and perform the upgrade.
Check the ports to open for Upgrade: https://manuals.wildix.com/ports-used-by-wildix-services/
Downgrade is not supported!
- Enter the name of the repository (rel380) into the field “Upgrade repository” and click Save
Available repositories for upgrade:
- Wait till the system checks whether there is a new version available in the selected repository
- In case there is a new version available, click Perform upgrade button:
- As a rule, the Upgrade procedure takes several minutes (however it depends on your Internet connection and the number and volume of packages that must be downloaded):
- As soon as the upgrade is completed, click Reboot button. You can review the upgrade log by clicking Show log button or download it by clicking Download full log button:
- After the reboot is completed, you will be forwarded to the login window
- Log in to proceed with the system
You can check the current WMS version in the upper right part of the screen.
How to perform the upgrade in case the version contains no WMS interface package? In case the page shows that there is no new WMS version is available, but it was announced by Wildix that there is a new version available, it means that you can install additional packages ("additional packages" = Callweaver package, firmwares, sound files, etc) from the repository. Click Upgrade additional packages.
You can set up automatic upgrade to be performed at the specified time.
- Upgrade repository: enter the name of the repository (rel380)
- Email: enter the email address to which the upgrade result (only in case the upgrade was performed) will be sent
- Perform: enable the system to check each day / week / month if there is a new version available, and if yes, perform the upgrade automatically. Auto-upgrade is performed during the night.
Activation / Licences
Activate PBX and Wildix licenses.
Read the guide PBX Licensing and Activation for the information about PBX activation and activation of other licenses.
To deactivate the PBX Activation license, click Deactivate license.
If you need to replace an old PBX by reusing PBX Activation license on a new PBX, do not deactivate license, but follow the procedure desctibed in PBX Licensing and Activation guide.
Gold Partners have the option to display their company logo in WMS / Collaboration interface. The logo must be uploaded in WMP → Company Settings. Click Download logo to make the logo appear in the upper right part of WMS / Collaboration interface / Remove logo to remove the logo from WMS / Collaboration interface.
Generate a *.pcap trace which allows you to debug and analyze problems with VoIP traffic.
There are several ways to generate a trace:
- Tick off IP Address and leave the input field empty
This option allows you to capture all the traffic passing through the PBX interfaces.
- Tick off IP Address and enter the host address
This option allows you to capture all the traffic passing to or from a specified host.
- Tick off Custom tcpdump and specify the interfaces, the ports and the hosts in the input field
After you have selected the way to generate a trace, enter the Trace name and click Start.
When finished, click Stop. You can start a trace and continue navigating other menus of the MWS.
Open the trace with Wireshark program.
Please find more information on using *.pcap trace generation feature in this Guide on debugging and troubleshooting VoIP problems.