WMS Settings Menu - Admin Guide
WMS Settings Menu Guide provides the basic information on the Settings options and explains how to set up various parameters.
Created: February 2018
Updated: October 2025
Permalink: https://wildix.atlassian.net/wiki/x/mBfOAQ
- 1 PBX
- 1.1 WMS network
- 1.2 Language & region
- 1.3 Call and chat history
- 1.4 SIP-RTP
- 1.5 Hotel integration
- 1.6 Integrations
- 1.7 Features
- 1.8 Security
- 2 System
- 3 Tools and utilities
- 3.1 Remote support
- 3.2 Backup system
- 3.3 Upgrade
- 3.4 Activation / Licences
- 3.5 Generate trace
- 4 Security Audit
PBX
WMS network
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 PBXs: incoming 1194 UDP
Note: Starting from 19 April 2022, only one PBX with active licenses is allowed per customer and this PBX automatically becomes main (Server) PBX. Other PBXs of the same customer are added to the same WMS Network as Client PBX and inherit the licenses from the Server PBX.
To set up WMS Network:
Data sync Role: Server/ 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
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 Generate credentials to generate login and password.
Note: It is only possible to automatically generate credentials, without manual editing.
Admin has to regenerate Server PBX credentials using Generate credentials option. After completing, update credentials also for all Client PBXs in WMS Network. If credentials are not updated, WMS Network will stop working.
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:
Client 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 WMS Network on a PBX that was previously in use:
In case you enable WMS Network on a Client PBX that had been previously in use, users and groups will be deleted from the PBX. To make sure you keep the existing users, follow these steps:
Export the CSV file of users of the Client
Enable WMS Network on the Client
Import CSV file to the Server
Access the Client, select the newly exported users and move them from the Server to the Client
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
Also, you can go to WMS User -> Users and select a WMS Network PBX from the alphabetically sorted dropdown list to display users from a specific network.
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
Each user can select a preferred language in Legacy Collaboration Settings -> Personal. This language is applied for Legacy Collaboration web interface, WP4X0 interface. All the System sounds (audio prompts) are also played in the language selected by the user, but only if the corresponding Sound package is installed. Otherwise, System sounds are played in the default Language of the PBX.
Call and chat history
On the AI + Data Boost tab, you can see statistics of CDS space usage in WMS and configure data rotation settings.
The tab displays the total number of space used and a bar graph visualises the space distribution between backups, recordings, voicemail and free space.
Note:
The AI + Data Boost tab is available for root admin only, starting from WMS 6.06.20240425.1. Read more about CDS in this document: Company Data Storage Flow.
When the amount of used storage reaches 95%, an email is sent.
Hovering the mouse over a section on the bar graph, the number of used space is displayed for the relevant section.
The graph in the next section displays the usage of transcription and Voice bot hours. Hovering the mouse over a bar graph for the selected month, the number of used hours is displayed, along with the hours for the current bundle.
In the table below you can find information about oldest file of different types and size of files, as well as data retention period. In the Data retention period column you can configure how long the data should be stored for different file types:
Note:
By default, 12 months are set.
In case there is no bundle purchased, the maximum rotation period that can be set is 12 months.
For information about expected data retention time check out the documentation Company Data Storage Flow.
On the Settings tab, you can set up and select the backend used for storing chat history and call history (CDR). The following CDR storage modes are supported:
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 (Hardware / Virtual PBX): file can be saved to a storage device (USB or network share)
Other Settings:
Enable contact notes: enables the Notes feature of Wildix Collaboration
Tags: this field allows you to add tags; later on these tags can be selected via Dialplan application "Set" (see Dialplan applications User Guide) and set via Legacy Collaboration (see Legacy Collaboration User Guide)
You can add multiple tags separated by comma. Maximum character length in the "Tags" field is 255 characters.
This change is applied to new PBXs automatically
On existing PBXs it's possible to change CDR table manually using the following command:
ALTER TABLE cdr MODIFY lastdata varchar(255);
Hide in CDR-View: allows hiding last X digits in CDR-View 2.0 from phone numbers consisting of more than 7 digits. Must be used together with ACL “Can/cannot see full number in CDR-View” (see ACL rules and Call classes management Guide)
Delete calls / chats / voicemail / recording after: these options allow auto-deleting old calls, chats, voicemails and recordings after a specified number of months
Step 1. Enable connection to the database
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.0.0\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 Settings to select the backend that will be used for displaying CDR statistic. You can choose only one backend
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:
SIP-RTP
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)
Random music on hold: 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
Auto add new devices in local networks (for 2 hours) (Hardware, Virtual PBX): when enabled, devices are added and provisioned automatically in local networks. After 2 hours the option is automatically disabled
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
TLS Private Key (*.key) (Hardware, Virtual PBX): upload a TLS private key file
Note: Wideband codec is forced for all devices (g711 always has higher priority compared to g729).
If you want to enforce g729, this can be done via Dialplan configuration (Set application -> Codecs -> choose the preferred option).
With wideband codecs, the following priorities apply:
opus
alaw
ulav
g729
Hotel integration
Enable integration with Oracle / Fidelio PMS and other hotel management systems that support FIAS protocol.
Refer to the Hotel Integration Guide for detailed information.
Integrations
Cloud integrations
Note: In case of WMS version lower than 6.05.20240119.1, the tab is named Calendars.
Enable integration with:
Google Calendar: refer to the guide How to set up and use Google Calendar integration for more information
Microsoft Teams Presence: for detailed information, check the guide teams4Wildix - integration of Microsoft Teams with Wildix PBX - Documentation
Webhook: refer to the document How to set up Webhook integration for more information
HubSpot integration (x-bees and Collaboration 7): refer to HubSpot Integration – Admin Guide for more details
Salesforce integration (x-bees): refer to Salesforce Integration with x-bees – Admin Guide for more details
Client integrations (x-bees, Collaboration 7): for detailed information, check the document How to set up Client integrations
SMS (x-bees, Collaboration 7): for detailed information, check the document How to Configure SMS and WhatsApp Conversations in WMS
WhatsApp (x-bees): see the documents How to Configure SMS and WhatsApp Conversations in WMS and WhatsApp Integration with x-bees for more details
Company API Keys
Refer to the How to Create and Manage Company API Keys guide for details on how to create and manage Company API Keys.
Zoho Integration
Enable integration with Zoho CRM. Refer to Zoho CRM integration with Wildix PBX for detailed information.
Microsoft 365
Enable integration with Microsoft 365 including calendars and phonebooks sync. Consult Microsoft 365 Integration Guide for detailed instructions.
Applications
Server to Server
The option is available only for a super admin user!
S2S authentication via token for Wildix PBX API significantly increases security and protects your PBX from potential attackers.
Documentation and instruction on how to generate the token and how to sign it with a secret key, is available on your PBX: https://<pbx_host>/api/v1/doc/#tag/Authentication/bearer
OAuth 2.0
The option is available only for a super admin user!
C2S (client to server) authorization provides the safe use of APIs for integrations without session cookies and without using basic authentication.
Documentation is available on your PBX: https://<pbx_host>/api/v1/doc/#section/Authentication/oauth2
Simple Token
The option is available only for a super admin user.
To ensure the best security, it is recommended to use Server to Server or OAuth 2.0 authentication, if possible.
Simple Token authorization is a simplified method of Wildix PBX API integration via access key (token).
Documentation is available on your PBX: https://<pbx_host>/api/v1/doc/#section/Authentication/Token
Token expiration
Starting from WMS versions 6.10.20250609.6 and 7.02.20250609.3 when creating any token (S2S, OAuth2 and Simple Tokens), you have to define its expiration period (e.g. 30 days, 90 days):
Starting from WMS versions 6.10.20250620.2 and 7.02.20250620.2, admin gets email notifications:
each time a new token is created
7 days before a token expires
when a token has expired
Analytics
Enable x-caracal ACD Stats. Refer to x-caracal Guide for detailed information.
Callback URLs
Callback URLs allow opening Zoho CRM or other CRM systems upon receiving or placing a call and pass parameters (static parameters or supported variables).
Refer to How to set up web application integration via Popup URL for detailed information.
Verify certificate (optional)
You can enable the validity verification of the CRM server. Enter your credentials for basic authentication.
Limitations:
Digest authorization is not supported
Host certificate verification is not supported. Only certificate's validity is verified (means the certificate is issued by the certification authority and not self-signed)
Redirects are not supported (for example, from http to https)
Features
Manage such PBX Features as:
Cloud Analytics (available from WMS 6.03.20230630.3): enables events sending/ data gathering for Cloud Analytics (CDR-View 2.0) in Legacy Collaboration, Collaboration 7 and x-bees. Starting from WMS v. 6.06.20240530.1, it is activated by default on all types of PBXs. Also, enabled Cloud Analytics is required for Webhook integration (for more information, check the document How to set up Webhook integration).
Note:
If sending of the events was enabled and then disabled, the old data is still stored in the data base. For the old data be removed, a ticket to customer care has to be opened.
On versions prior to WMS v. 6.06.20240530.1, Cloud Analytics is enabled by default if a PBX or whole WMS Network are running in the Cloud. In case of a standalone Virtual/ Hardware PBX, or if there is a mix of Cloud and Virtual/ Hardware PBXs in a WMS Network, Cloud Analytics should be enabled manually by admin.
Important: If you need to disable Cloud Analytics on a PBX with x-bees or Collaboration 7 licenses, please contact Wildix Technical Support, as the Cloud Analytics setting may affect presence sync in x-bees/ Collaboration 7.
On a PBX with Legacy Collaboration licenses Cloud Analytics can be turned off without additional configuration from the Technical Support side.
Legacy Collaboration call control (available from WMS 6.03.20230630.3): enables Call control mode for Legacy Collaboration. By default, only 1 active Legacy Collaboration session is permitted. However, there is an option to allow the second Collaboration tab – in Call Control mode. This can be used, for example, for media devices when connecting via remote desktop. The option is particularly practical for teams4Wildix integration. Once the feature is activated, an additional option appears on the Legacy Collaboration login window – Call Control only.
Use case: User can set "Call control only" mode to be automatically enabled by adding a parameter in the URI (useful when it is needed to share the link among all employees or bookmark the page)
How-to: add ?sip=no to PBX domain name -> https://pbxname.wildixin.com/collaboration/?sip=no
Location-based multi-factor authentication (available from WMS 6.04.20231020.2): enables location-based MFA on the PBX, which uses users' location (determined by the IP address) to confirm their identity. If the IP address appears to be from an unfamiliar location, users need to confirm the IP address via email. Starting from WMS 7.01, location-based multi-factor authentication for Legacy Collaboration is enabled by default. Read more in the documentation: Security Policy at Wildix
Allow Legacy Collaboration (available from WMS 7.01.20250512.1): allows / forbids access to Legacy Collaboration on PBXs with WMS 7 version. When the checkbox is disabled and user tries to log into Legacy Collaboration, there is a notification that Legacy Collaboration access is disabled and user is suggested to use Collaboration 7 instead.
Security
CORS
Configure domain whitelist to protect PBX from cross-site request forgery (CSRF) attacks.
Refer to Domain Whitelist (Allow Origin) Configuration Instruction for detailed information.
Important: Trusted domains must be added to a domain whitelist! Please note that any Web API / PBX API integration will stop working if the domain is not added.
Trusted IP list
Note: The support starts from WMS 6.02.20230306.1.
Enter the IP addresses you want to add to the trusted list. Any trusted IP addresses for reaching the PBX should be indicated here.
Note:
Allowed values are: valid IP addresses (subnets are not allowed)
Maximum number of IP addresses that can be added: 32
TLS
Enable Allow TLS 1.0, TLS 1.1 option. To ensure better security, Wildix has implemented TLS 1.2, enforcing it by default for newly created systems and right after PBX reset.
However, there is a number of deprecated devices that don’t support TLS 1.2, for example, WP600AXX, WP R1/R2, W04FXOR2, W04FXSR2, and W01/02 FXS R1. Documentation: List of Wildix devices EOL that do not support TLS 1.2.
The option Allow TLS 1.0, TLS 1.1 ensures support and backward compatibility of such deprecated devices. It is enabled by default after the upgrade.
Important: If you disable the option Allow TLS 1.0, TLS 1.1, the devices that don’t support TLS 1.2 stop working.
Note: For more information on why it is important to switch to TLS 1.2, check out our article TLS 1.2 and You: Why You NEED to Upgrade Your Security.
Active Directory Single SignOn via Kerberos (Negotiate)
You can set automatic Single Sign-On via Active Directory.
Refer to Active Directory Single Sign-On for detailed description.
Active Directory Single SignOn via SAML 2.0
Note: The support starts from WMS 6.07.20240906.1.
It is possible to configure support of Active Directory Single Sign-On via SAML 2.0 protocol.
Check out the document How to configure support of Active Directory SSO via SAML 2.0 protocol for instructions.
System
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) interface 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: Choosing a network scenario (Hardware PBX).
After you have changed the network settings, click Apply network settings to apply the new parameters.
WMS Network interface
LAN eth1 (static) interface is used for connection to WMS Network. The interface cannot be edited unlike enth0 and enth1 interfaces
Options:
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 Choosing a network scenario (Hardware PBX)
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 +Add to add a new interface
Click Edit to edit the settings of a selected interface
Click -Delete to delete a selected interface
Hosts
Click +Add to add a new host. Enter its address and hostname
Click Edit to edit parameters of a selected host
Click -Delete to delete 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:
[PBX_serial_number].wildixin.com
[PBX_system_name].wildixin.com
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.
Parameters:
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)