Scroll export button | ||||||||
---|---|---|---|---|---|---|---|---|
|
Info |
---|
The List of custom config parameters that allow changing various settings in config files. Created: August 2018 Updated: October 2023 Permalink: https://wildix.atlassian.net/wiki/x/Fh3OAQ |
Table of Contents |
---|
To make any changes to config files, access them via SSH as root:
Code Block |
---|
nano-tiny /etc/<sub-directory>/<config file name> |
Call Groups
Check registration status of Call group members during call distribution
The feature is enabled by default and it prevents unavailable Call group members (means no registered devices or no push for mobile apps) from receiving calls from a queue. The logic is applied only for Call group calls!
...
Reload SIP by running the command:
Code Block callweaver -rx 'sip reload'
Allow overriding of Global Call groups settings
The option allows overriding of Global Call groups settings (see the chapter below) and saving custom parameters after each system upgrade.
...
Note |
---|
|
Collaboration
Disable file transfer in Collaboration chat messages
Note |
---|
The support starts from WMS 5.03. |
...
Code Block |
---|
COLLABORATION_FILE_TRANSFER_ALLOW=false |
Disable Chat and Post-It functionality in Collaboration
Note |
---|
The support starts from WMS 5.03. |
...
Change the default Departments tree separator Anchordepartmentsastree departmentsastree
departmentsastree | |
departmentsastree |
Starting from WMS 5.04.20220309.1, the Colleagues tab in Collaboration shows only the list of Departments and there is possibility to create a multilevel hierarchy of Departments and display them in a tree view.
...
Note |
---|
The support starts from WMS 5.04.20220309.1 |
By default, only people added to rosterare shown on the Colleagues tab. To display all users registered on the PBX, add the following line to the /rw2/etc/env.custom.ini file:
...
Warning |
---|
Current limitation: The status of users that are not added to the roster is not displayed. |
Enable Noise suppression on the PBX level
Starting from WMS 6.04, Collaboration users can enable Noise suppression in Collaboration Settings -> Web Phone. To enable Noise suppression on the PBX level for all users, edit the following parameter in the /rw2/etc/env.custom.ini file:
...
More about advanced settings on mobile: Appendix 3: Advanced Settings
Devices
Modify devices sync
Warning |
---|
Important: By default, the sync is enabled. It is necessary to disable it in case of FAILOVER scenario on Failover PBXs! |
...
Add the following parameters to the config file /rw2/etc/pbx/device_sync.conf
Code Block disable_sync_portal=1 disable_sync_manual=1
Available values: 1 – sync is disabled; 0 – sync is enabled.
Modify g729 transcoding for web phone calls to trunks which do not support g711
Warning |
---|
Important:
|
...
Run the command:
Code Block callweaver -rx "sip reload"
Manage wideband codecs usage
Starting from WMS 5.04.20220309.1, there is custom provisioning parameter WideNarrowbandUse, which allows to manage wideband codecs usage. By default, the parameter is disabled and wideband codecs are forced for all devices. When the parameter is enabled (WideNarrowbandUse=yes), the previous behaviour remains: all devices use wideband codec priority or narrowband codec priority and remote codecs priority or local codecs.
...
Run the command:
Code Block callweaver -rx "sip reload"
Modify the behaviour of Colleague BLF keys if a colleague is a Call group member
The feature is disabled by default . There are two options for its configuration:
...
Note |
---|
Supported devices:
|
...
Note |
---|
During ongoing calls, a lock on a phone's screen indicates that Direct SDES-SRTP is established. |
Select a specific GSM gateway
Anchor | ||||
---|---|---|---|---|
|
The option allows setting a specific GSM gateway for SMS sending for each separate user:
Edit the config file /etc/wildix/smsd-route.conf by specifying user extension and MAC address of GSM gateway, for example:
Code Block 101,9c7533014b00 102,9c7533014b00 103,9c7533014b00 104,9c7533014b01
Modify geolocation sharing on geolocation sharing on PBX
Note |
---|
The support starts from WMS 5.02. |
...
Note |
---|
Notes:
|
Security
Enable SSL connection to remote MySQL server
...
Note |
---|
Note: Starting from WMS 6.04.20231020.2, it is possible to manage location-based MFA via WMS -> PBX -> Features. Documentation: WMS Settings Menu - Admin Guide |
Dialplan
Exit code 0 from voicemail
Support for exit code 0 from voicemail allowing caller to speak with an operator was added.
...
- Add the parameter operator=yes to the file voicemail.conf. It allows sender to hit 0 before/ after/ during leaving a voicemail to reach an operator
Use online streaming of mp3 http/ https sources as music on hold
Note |
---|
The support starts from WMS 5.02. |
...
Note |
---|
Note: Starting from WMS 5.04.20220309.1, in case you have several streams, modify the parameter [radio] to [radio1], [radio2], etc. in the config file and choose the corresponding option ("radio1", "radio2") when setting music on hold in the Dialplan. |
x-caracal
Change time range limit for reports
Starting from WMS 5.04, depending on the PBX load, some limits of allowed days range apply when generating x-caracal reports. Learn more in x-caracal documentation.
...
Code Block |
---|
MAX_ALLOWED_DAY_RANGE=50 |
Modify Inactivity Timer
By default, after 10 minutes of inactivity, x-caracal page needs to be refreshed. Starting from WMS 6.03, it is possible to modify its inactivity timeout.
...
The Maximum value is 600 (10 hours). In case you set the inactivity timeout to 0, it gets disabled.
Integrations
Hotel PMS
WHoteld package supports some custom configuration parameters that can be changed by editing the file /etc/wildix/whoteld_manager_custom.conf.
...
Note |
---|
Note: Information about hotel integration: Hotel Integration - FIAS protocol - Guide. |
Integrate custom HTML code by using Google Tag Manager
Warning |
---|
The feature is available only for Cloud PBXs! Supported services:
|
...
Create a new config file template.conf including GTM ID in the file /rw2/etc/pbx/, for example, use the command:
Code Block echo 'gtm=GTM-12345678' > template.conf
where 123445678 is Google Tag Manager ID.
...
after the <HEAD> section:
Code Block <!-- Google Tag Manager --> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-XXXX');</script> <!-- End Google Tag Manager -->
after the <BODY> section:
Code Block <!-- Google Tag Manager (noscript) --> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-XXXX" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <!-- End Google Tag Manager (noscript) -->
Feelingstream
Wildix supports integration with the Feelingstream platform for voice recognition and call recordings in stereo format. Feelingstream allows to conduct STT analysis of stereo recordings received from Wildix PBX.
...
Note |
---|
Note: Stereo recordings can be activated and used separately on any PBX, without Feelingstream integration, consult the documentation Custom Global Dialplan Variables List. |
Fax Server
Adjust the resolution of outgoing faxes
Note |
---|
Note: The default resolution is 204x196 (fine). |
...
- Edit the config file /rw2/etc/faxglobal.conf by specifying the desired horizontal and vertical resolution of the image in pixels per inch. For example:
Code Block XResolution=204 YResolution=391
Other widespread resolutions: 204x98, 204x391, 408x391.
Disable Error Correction Mode (ECM)
Note |
---|
Note: The support starts from WMS 5.04.20220309.1. |
ECM is enabled by default. To disable it, add the following line in /etc/callweaver/res_fax_custom.conf:
Code Block |
---|
ecm=no |
Set maximum/ minimum fax transmission speed
Note |
---|
Note: The support starts from WMS 5.04.20220309.1. |
Maximum transmission speed
To change the maximum transmission speed, modify the following parameter in the /etc/callweaver/res_fax_custom.conf file:
...
Possible values: 2400 | 4800 | 7200 | 9600 | 12000 | 14400
Minimum transmission speed
To change the minimum transmission speed, modify the following parameter in the /etc/callweaver/res_fax_custom.conf file:
...
Possible values: 2400 | 4800 | 7200 | 9600 | 12000 | 14400
Kite
Deliver Kite chat requests to all Call group members
Note |
---|
The support starts from WMS 5.03. |
...
- onebyone (default) - sends Kite chat requests to Call group members one by one
- sendall - sends chat requests to all CG members simultaneously.
Trunks
Enable Q-value (serial forking) for trunk registration
To enable q-value (serial forking) parameter via custom register string:
...
Run the command:
Code Block callweaver -rx "sip reload"
Modify sending keep-alive packets via UDP packets to keep RTP ports opened
The option improves symmetric RTP/ NAT by allowing keep-alive packets to be sent via UDP packets for PBXs located behind NAT.
...
Add the following parameter to the file /etc/callweaver/sip-general-custom.conf
Code Block rtpkeepalive_mode=udp
Available values: udp | rtp.
Run the command:
Code Block callweaver -rx "sip reload"
Include the session-expires timer in UPDATE message
The feature is disabled by default. It is applied for some specific carriers when calls can drop due to the missing session-expires timer in UPDATE messages.
...
Run the command:
Code Block callweaver -x 'sip reload'
Allow calls from users with same public IP address as a static trunk
Note |
---|
Note: The support starts from WMS 6.01.20221019.4. |
...
- init: reinitializes the connection. This value is used by default.
- ping: restores the connection by sending a ping request
Enable sending presence events to support Microsoft Teams 2-way presence sync Anchor MS Teams presence sync MS Teams presence sync
MS Teams presence sync | |
MS Teams presence sync |
For the correct user presence sync, it is necessary to enable sending of presence events to Analytics on PBXs with UC licenses (for x-bees licenses, it is enabled by default). For this, follow the steps described below:
Create a directory /etc/systemd/system/pbx-data-engine.service.d
Code Block # mkdir /etc/systemd/system/pbx-data-engine.service.d
Create a file /etc/systemd/system/pbx-data-engine.service.d/override.conf and add the following lines
Code Block # vi /etc/systemd/system/pbx-data-engine.service.d/override.conf [Service] ExecStart= ExecStart=/usr/sbin/pbx_data_engine.py --daemon --mode calls presence -cr
Reload systemd and restart the service to apply the changes
Code Block # systemctl daemon-reload # systemctl restart pbx-data-engine
Run the following command to check what events are sent to Analytics
Code Block echo mode | socat - UNIX-CONNECT:/var/run/data_engine/data_engine.sock
Macrosuite divider macro | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...