Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

This step-by-step guide leads you through the process of activation and configuration of the Wildix system.

WMS version: 5.0X / 4.0X 

Updated: June November 2020

Permalink: https://confluence.wildix.com/x/VAQ8AQ

...

  • Per User licensing (available for Hardware / Virtual / Cloud PBX): add as many users of each profile as you need. Some users may have only basic telephony features, others may have access to UC&C features, and others may have access to advanced features. Pay recurring fees per user / per period of time. Add more users of each type at any time. More information on user profiles: https://www.wildix.com/licensing/.

In this guide it will be explained how to activate a Hardware PBX Per User and a Cloud PBX.

More information on Wildix licensing and licenses activation: https://confluence.wildix.com/x/twM8AQ .

Useful links:

...

  • LAN1: DHCP – Server, IP – 10.135.0.1/24

    • Use the IP address 10.135.0.1

  • WAN: DHCP – Client, IP – Dynamic

    • Use the IP address released by the DHCP server

Port

1

2

3

4

Type

WAN

LAN1

LAN2

LAN3

DHCP

Client

Server

Disabled

Disabled

IP

Dynamic

10.135.0.1/24

Disabled

Disabled

...

  1. Connect to WMP using your credentials

  2. Go to Customers tab; to create a new PBX, you first need to add a customer (if it does not exist yet); click Add:

    PDF avoid Pagebreak

    Image Modified


  3. Create a new customer (company): fill in the fields and click Save:

    PDF avoid Pagebreak


  4. You need to create at least one contact: fill in the fields and click Add:

    PDF avoid Pagebreak


  5. Now you can proceed with adding a new PBX: go to PBXs tab: 

    PDF avoid Pagebreak


  6. You are now under PBXs tab, click + to add a new PBX:

    PDF avoid Pagebreak


  7. Fill in the fields:

    • Model: select WPBX-CLOUD for Cloud / WPBX-VM/HW for Virtual or Hardware

    • Region (only for Cloud PBX): select the datacenter region

    • Name: PBX domain name by which your PBX is accessible via the browser; in the example provided below, the PBX can be accessed by URL https://elenatest2.wildixin.com

    • Expire: select the recurring billing period: monthly / yearly / 5 years / lifetime (lifetime is not available for Cloud PBX)

    • PBX-BASIC / UC-Essential / UC-Business / UC-Premium / UC-Wizyconf / PBX-Service: add the number of users of each profile (more about each profile: https://www.wildix.com/licensing/)

    • Storage size (Cloud): increase cloud instance storage size 

      PDF avoid Pagebreak


  8. Click Add; your PBX has been created:

...

Note

For Virtual PBX: before proceeding, follow the guide to deploy PBX image: 


Proceed as follows:

  1. Open the web browser (recommended browser: Google Chrome updated to the latest version)
  2. Type the PBX IP address (https mode is recommended), example: https://10.135.0.1/ (for LAN1) or PBX name set on WMP (Cloud PBX), example: https://mycompany.wildixin.com 

    Note

    Note: For access by default local IP 10.135.0.1 where your PC is connected to the LAN1 port, your PC must be in the same network segment as the PBX.


  3. Enter the credentials for the first time access:

    • user : admin

    • password : wildix


PDF avoid Pagebreak


Note

Note: To change the language of the WMS interface, double click on the “admin” user and select the language from the list.


Warning

Important! Before proceeding, it is necessary to change the admin password. This admin user is the “super admin” - the only user with full access to all the levels of the system management.

Change admin password 

Warning

Important! On Cloud PBXs, a default admin password is reset after 7 days of uptime. Make sure to change it.

In case you face any issues with reset, contact Wildix Support.


Proceed as follows:
  • Select admin user and click Set passwords
  • Generate or create a new WEB password, click Ok
    • Current: enter the current password (wildix)

    • New: click Generate to automatically generate a strong password (click Show to view the password generated by the system)

PDF avoid Pagebreak


Note

Note: You can also compose your own strong password, consisting of at least 8 symbols, at least 1 uppercase, 1 lowercase, 1 digit, 1 special character.


Note

Note: This password is used by the admin user to access the WMS interface, while SIP/VoIP password is used to register and assign remote devices.


  • Enter the email address of the admin user to be able to receive email notifications: double click on the admin user and fill in the field Email:

PDF avoid Pagebreak


...

To upgrade the system, proceed as follows:

  • The system checks whether there is a new version available in the selected repository: rel50 / rel40:

PDF avoid Pagebreak




Note

For Hardware/ Cloud PBXs: you need to first upgrade your PBX to the lastes latest WMS4 version and then update it to WMS5:

  1. Enter the following name of the repository into the field Upgrade repository: rel40 
  2. Click Save
  3. Click Perform upgrade to update your PBX to the latest WMS4 version
  4. Enter the following name of the repository into the field Upgrade repository: rel50 
  5. Click Save
  6. Click Perform upgrade to update your PBX to WMS5 version


  • In case there is a new version available, click Perform upgrade

  • As a rule, the Upgrade procedure takes several minutes:

PDF avoid Pagebreak


  • As soon as the update procedure is over, the button Reboot is shown:

PDF avoid Pagebreak


  • Click Reboot and wait till the system is being rebooted:

PDF avoid Pagebreak


  • As soon as the PBX has been rebooted, the login page appears
  • Log in to the WMS, the current WMS version is shown in the upper right part of the screen:

PDF avoid Pagebreak

PBX Activation (Hardware, Virtual PBXs)

Note

Cloud PBXs are automatically activated after they are created in WMP (see chapter Creation of Per User PBX on WMP).


  • Copy PBX key from WMP:
    • Go to the tab PBX per user, select your company, then select the PBX that you have created on step 1

    • Click Copy PBX key to clipboard

PDF avoid Pagebreak

Image RemovedImage Added


  • Insert the PBX key on WMS side:

    • Go to WMS Settings -> Tools and utilities -> Activation / Licenses

    • Paste the PBX key copied on the previous step into the field User Mode and click Activate:

PDF avoid Pagebreak

Image RemovedImage Added


Your PBX is now activated:

PDF avoid Pagebreak

Image RemovedImage Added


Introduction to WMS

...

...

The upgrade procedure is described in chapter Upgrade WMS to the latest stable release

Available repositories for upgrade: 

...

  • Park call timeout: timeout in seconds for return from park orbit. Make sure you define the value for a call to return from Park Orbit; more information about parking feature: How to implement the Parking feature

  • Prefix for external line: prefix to get the outside line (0 by default)

  • International Prefix: prefix to call abroad (00 by default)

  • National Prefix: prefix to call within your country (0 by default)

  • Internal call default timeout: timeout after which the call to another user is forwarded (if forwarding is enabled in user preferences) or terminated

  • First digit timeout (secs): timeout after which the call is terminated in case there is no input  (time countdown starts if the handset is raised)

  • Interdigit timeout (secs): timeout in seconds after which the number is dialed automatically unless the user presses the Send call key on the phone

  • Send call key: it’s possible to select #, *, or None as a send key

  • Playback tones while entering number: if enabled, DTMF tones are played

  • Quality of recorded voicemails / recordings: choose the optimal quality and file size

  • Send mail notification after the record is complete: if enabled, users receive notification by email after the record is complete

  • Attach files with records to emails: if enabled, users receive recording files attached to email notification

  • Convert Voicemails to text and send by email: if enabled, Voicemails are converted to text and sent to user by email (read the guide Wildix Business Intelligence - Artificial Intelligence services for more information)

  • Notify by email in case SIP trunk registration status is changed: if enabled, the PBX admin receives notification about SIP trunks changing their registration status

  • Announce date, time and caller phone number for Voicemail messages: if disabled, user is invited to press a key in Voicemail IVR menu in order to hear date, time and caller phone number for each Voicemail

  • Set dialplan variables: this field allows setting Custom Dialplan variables; documentation: Custom Global Dialplan Variables List

  • Set quick dial patterns: this field is used only for the first generation of WP phones (pre 2015)!  

PDF avoid Pagebreak

Image RemovedImage Added

WMS Network

Introduction to WMS Network

...

  • Multisite environment: you need to enable flawless communication between different offices of the company

  • Failover / redundancy or load sharing: one PBX is the primary, another PBX is the secondary (backup PBX), which works in idle mode and receives all the updates from the primary PBX; in case of the primary PBX failure, the secondary PBX takes on, ensuring the continuity of the service. In this case all the devices have a double SIP registration (both to the Primary and the Secondary PBX). Read the guide: Failover Guide.

Wildix system supports Hybrid scenarios, where Hardware, Cloud and Virtual PBXs can be connected in the same WMS Network.

Sharing of Wildix licenses is possible in WMS network. More information: https://confluence.wildix.com/x/twM8AQ.

In this guide we will show how to deploy the WMS Network for a multisite scenario.

...

  • Presence status of users and internal communication free of charge (pay only for Internet connection)No limit on the number of users in WMS Network

  • Users database resides on a distributed LDAP server; each user added to the system is immediately visible and can be contacted by other users of the system

  • Roaming profile: users can move between the sites of the company while keeping the same number and user preferences

  • One PBX in the network is assigned as the Server: any change that take place on a Client PBX first is passed to the Server and then from the Server to other Clients

  • Auto sync of users, call groups and ACL configuration between the PBXs in the WMS Network allows for significant time savings on configuration and maintenance

  • Direct peer-to-peer communication between PBXs, in case direct connection between two Clients is impossible, they can use Server as a proxy

  • WMS Survivability: continuity of internal and external calls in case one PBX in the network (including the Server) becomes unavailable

  • WMS Auto-recovery: in case of Server failure, another PBX in the WMS Network dynamically takes up all the functions of the Server

  • Local survivability: a Client disconnected from the network continues to operate, but without the possibility to receive the users database updates

  • Each PBX has its own local lines, users, IVRs and Dialplan procedures, however it’s possible to set up the Dialplan to route calls via a different PBX in the WMS Network, thus using its local lines (even in a different country

  • Up to 1000 nodes in WMS 5 (256 in WMS 4)
  • Up to 5000 users on one PBX in WMS 5 (1000 in WMS 4)
  • Up to 500 concurrent calls
  • Up to 100k users in WMS network
PDF avoid Pagebreak

Server and Client configuration

...

Note

Enabling Client mode on a PBX that has been previously in use will delete all users and groups from the Client; read how to prevent this from happening: WMS Settings Menu Guide.


Note

All the PBXs belonging to the same WMS Network can have only one admin user, which is the admin user of the Server PBX.

...

  • 1 - +: add user

  • 2 - Edit: change the same parameters, which are available upon adding a user

  • 3 - -: delete one or multiple users 

    Note

    Note: It is possible to remove user's personal data (calls, chats, voicemails, phonebooks, recordings, faxes) when deleting this user. 

    Limitations:

    • the feature works for standalone PBXs or for WMS Networks PBXs which share the same MySQL or MSSQL DB
    • if a user to be deleted is an owner of contacts in shared phonebooks, than contacts remains without an owner
    • voicemails left via FC "Voicemail: 81 are not reset (but it is possible to reset them via Terminal, consult this Article)


  • 4 - Set passwords: change user passwords; for security reasons only the admin user can set passwords for other admins of the system; by default strong passwords are automatically created by the system, read more about changing user passwords in chapter Set user passwords

  • 5 - Edit preferences: manage user preferences and phone features, for details, see chapter User preferences

  • 6 - Send Welcome Message: send a message to newly created users with details of access to Wildix Collaboration (URL, login, password); for security reasons, only the admin user can send welcome messages to other admins of the system

  • 7 - Move users to another PBX: in case of WMS Network, you can select one or more users and move them to another PBX in the network

  • 8 - Export CSV (available only for the admin user): save a CSV file containing users information in *.csv format to your PC 

  • 9 - Import: import users from MySQL / MSSQL, LDAP / AD, Google, Office 365, Exchange Server, CSV file, Zoho CRM, other resources; more information in chapteImport of users and phonebooks 

  • 10 - Select PBX: in case of WMS Network, you can select to view users of a different PBX in the Network or to view all the users registered to all the PBXs in the WMS Network

  • 11 - Search field

...

  • Activate the class: by default, all the settings are applied for Internal call class; to set up call Features for a different call class, first select the needed call classes, then enable the checkbox for the selected call class
  • Call reject: reject all calls

  • Call Forward Busy / No Answer / All: you can enable call forwarding in case user is busy / does not answer or unconditional call forwarding; enter the destination number or the VOICEMAIL into the field

  • Call waiting: enable the option to be able to receive more than one call at a time

  • Call timeout: if enabled, the call is terminated in case there is no answer within the specified timeout; enter timeout in seconds into the field

  • Mobility extension management: if enabled, the call is forwarded also to the user mobile phone number (mobile phone number must be specified for this user in WMS -> Users -> Edit) after the specified timeout; enter timeout in seconds into the field

  • Mobility confirmation: if enabled, the user is notified on who the caller is once he receives the call to mobility extension number, and is invited to enter the digit to accept the call

  • Notify missed calls via email / via sms: enable missed calls notification to email / via SMS

  • Custom Ring: enable the option and select the ringtone; ringtones selected here are applied to WP4X0, WelcomeConsole and Collaboration; Custom ringtones can be uploaded via Sounds menu (more information in chapter Record and playback audio messages)

Settings: user personal settings

...


Note

Note: It is possible to assign unprovisioned devices to users.

Available only for devices added via Remote Provisioning (Semi-automatic mode) or WMP. Refer to this chapter for detailed information about assigning to users.


...

For provisioning of Vision/ SuperVision, see chapter Provisioning and login of Vision / SuperVision.

WMP provisioning (Hardware, Virtual, Cloud PBX)

...

  • 1 - + Add: add a new device via Auto-provisioning or Semi-provisioning mode
  • 2 - Edit: edit device settings for one or multiple devices:

    • Comment: unique identifier, displayed in the Comment column of Devices table

    • Default zone / Tone zone (FXS/FXO): select the country / the geographical area for the correct tone recognition

    • DNS Server / Secondary DNS / NTP Server / NTP Zone: allows setting DNS and NTP settings, which can be useful in some network scenarios, e.g. with remote devices

    • Use DST: enables automatic switching to DST

    • Voice VLAN ID / CoS voice priority / Data VLAN ID / CoS data priority: allows setting priority for Voice and Data traffic and assign VLAN IDs

    • Use received IP: enables static IP

    • Syslog Server: you can specify the server IP address to which you would like to send syslog

    • SNMP Access (BRI, PRI, W-PA, some of WP4X0): authorizes SNMP monitoring on devices (it is also possible to authorize SNMP monitoring of the PBX in WMS Settings -> System -> SNMP Server)

    • Disable SIP Firewall (BRI, PRI, FXO, W-PA, GSM): it is necessary to enable this parameter in some complicated network scenarios, where a SIP Firewall is present between the PBX and the connected devices

  • 3 - - Delete: delete one or multiple devices

  • 4 - Configure / Sync device: send new configuration to one or multiple devices

  • 5 - Assign to user: assign WP4X0 and W01FXS to users; more information in chapter Assign WP4X0 to users

  • 6 - Sync from WMP: sync devices, assigned to this PBX from WMP; more information about WMP provisioning in chapter WMP Provisioning (Hardware, Virtual, Cloud PBX) 

  • 7 - Reset password: in case there is a risk that the provisioning password (displayed in the column Password) of one or several devices has been compromised, it’s possible to reset it without resetting the device: select one or multiple devices, click Reset password to reset the password, then click Configure / Sync device to assign a new password to the device

  • 8 - i: the blue icon indicates that there is a new firmware version available; more information about firmware upgrade in chapter Update firmware

  • 9 - Status icon: displays the device status, hover over it to see additional information (SRC port, transport used):

    • Green: device is registered (connected via SIP)

    • Grey: device is not registered

  • 10 - Model: for provisioned devices, the model is indicated correctly (e.g. wp480gr2wp480gr3), for not provisioned devices, only the device type is indicated (e.g. phone) in this column

  • 11 - Connect: enable / disable direct access to device (available for non-Cloud PBXs for devices which are in the same network as the PBX); more information is available in the guide Provisioning of Wildix devices

  • 12 - Extension: available for WP4X0 and W01FXS, displays the extension, this device is assigned to; displays loginX in case device is not assigned

  • 13 - Firmware: the current firmware version

  • 14 - Password: password to access device’s web interface after provisioning; password is displayed only for provisioned devices

  • 15 - Search field   

...

  • Go to WMS -> Devices -> Analog ports

  • The provisioned FXS is displayed in the table:

PDF avoid Pagebreak
Image Modified


  • Double-click on the gateway
  • Assign analog ports to users and click Save:

...

For W-AIR Base Small Business: after you have provisioned the base station, proceed to chapter Register and assign W-AIR handsets to users.

For W-AIR Sync Plus / W-AIR Sync Plus Base Outdoor: after you have provisioned W-AIR base station, proceed as follows:

...

Warning

This procedure is valid for the installation of only one W-AIR Base; for multicell installations, it is necessary to carefully plan the installation and do the site survey; for more information refer to the documentation: W-AIR Network Admin Guide - Sync over the airW-AIR Network Admin Guide - Sync over LAN.


Register and assign W-AIR handsets to

...

users 
Anchor
wair
wair

Proceed as follows:

  • Turn on the phone

  • Select Connectivity -> Register in the phone menu

  • Enter the code 0000 and select Ok

...

To assign W-AIR handset to user, follow procedure of phone login via Feature Code, described in chapter Assign WP4X0 to users.

Register and assign W-AIR Headsets to users

...

Check the ports to open on router / firewall: Ports used by Wildix services.

For the first time access to Wildix Collaboration Mobile application, proceed as follows:

...

Each trunk can be then associated to a pricelist (the first line in trunk configuration window). Read more about associating pricelists to trunks in the next chapter: Configuring SIP trunks and lines.

Configuring SIP trunks and lines

...

Connected SIP trunks and ISDN / FXO gateways are displayed in WMS -> Trunks:

PDF avoid Pagebreak

Image RemovedImage Added


Note

Note: Wildix offers its own built-in VoIP trunk CLASSOUND:

...

Note

Note: SIP trunks must be added manually.

BRI / PRI / GSM / FXO lines are displayed in the corresponding tables once the media gateways have been connected to the system and provisioned as described in chapter Provisioning of devices.

Each trunk is displayed in the corresponding section of the page with the following information:

...

Each trunk is associated to a Dialplan procedure (main by default), more information on Dialplan in chapter Wildix Dialplan.

Each trunk can have an associated Pricelist, this allows the system to calculate call costs, which can be later on viewed in CDR-View.

...

Documentation: Media Gateways Documentation.

After you have provisioned a BRI/PRI media gateway, the trunk is displayed in the corresponding section in WMS -> Trunks -> BRI/PRI table.

...

Documentation: Media Gateways Documentation.

To install a DaySaver media gateway, proceed as follows:

  • Connect antennas to the rear panel of the gateway
  • Insert the SIM card to the slot

    Note

    Note: Make sure the PIN code of the SIM card is disabled.


  • Connect the WAN interface of the gateway to the Wildix Switch

  • Provision the gateway as described in chapter Provisioning of devices

  • Once you have provisioned the gateway, a new trunk automatically appears in the corresponding section in WMS > Trunks -> GSM/UMTS section

  • The status is green, which means the media gateway is registered 

    Note

    Important: Status of signal quality is currently not supported!


...

  • Double click on the trunk to edit the trunk parameters:

    • Default Tone: select the country where the trunk is used

    • Country Code: select the country where the trunk is used for correct number normalization; select Custom country to manually enter the country code

    • Dialplan (main by default): Dialplan procedure used for calls via this trunk

    • Number of SIM: called number, which should be present in the Dialplan procedure, used for calls via this trunk; more information on Wildix Dialplan to follow, in chapter Wildix Dialplan

    • Enable SMS receiving: enable incoming SMS messages to the SIM card; specify the e-mail address in the field below

    • SMS2EMAIL service e-mail: e-mail address used for new messages notifications

...

  • Users: go to WMS -> Users, double-click on a user and edit the field Dialplan

  • Trunks: go to WMS -> Trunks, double click on a trunk and edit the field Dialplan

PDF avoid Pagebreak

Image ModifiedImage RemovedImage Added


Each time an entity (user, trunk) generates a call, the system checks the Dialplan procedure associated to the entity. For example, a user starts a call, in case the match for this called number is found inside the Dialplan procedure associated to this user (users by default) the system starts to execute Dialplan applications defined for this called number in the specified order.

...

  • main (associated to media gateways and VoIP trunks)

  • users (associated to users)

  • kite (this procedure is dedicated to Kite service, described in chapteWildix WebRTC Kite)

  • classound (this procedure is dedicated to CLASSOUND service, described in How to configure and use CLASSOUND)

...

  • create a new timetable in WMS -> Dialplan ->Timetable / Switch, and set up the state check time (it means that each time this Timetable is verified by the Dialplan, the system checks if your offices are closed at the moment, according to this timetable)   
  • create a new procedure in WMS -> Dialplan, add default as Called number and add Dialplan application Go to Voicemail 
Note

In the chapter Create a timetable it is explained how to create a Timetable and to work with it.

...

This is just one of the cases wherewhere Included procedures are used.

Dialplan practical examples

...

However, users procedure must cover all the destinations called by users of the system (national, international, mobile calls etc), and this is why it is recommended to use patterns, described in chapter: Matching called numbers.

The most common Dialplan applications used in users procedure are Dial the trunk / Trunk group. Dial the trunk allows you to select the trunk which is used to place a call. 

...

Example: you would like to route the calls to mobile numbers via GSM trunk, however you would like to have the opportunity to place a call via a different trunk, in case GSM trunk is occupied:

PDF avoid Pagebreak

Image RemovedImage Added


In this case call is routed via GSM trunk, if it’s busy, call is routed via the ISDN trunk.

...

To create call groups, go to WMS -> Dialplan -> Call groups:

  • Click on + to add a new Call group
  • Enter the Name of the call group into the field
  • Select the agents from the box on the left and move them to the box on the right
  • Click Save
PDF avoid Pagebreak

Image RemovedImage Added


PDF avoid Pagebreak

Image Modified


Note

You can add the same call agents to different groups. You can add users from all your PBXs in WMS Network to call groups.

...

HTML
<div class="container">
    <div class="video"><iframe width="560" height="315" src="https://www.youtube.com/embed/ljHQPyi2bSs?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
</div>
</div>


Create a switch switch 

Note

Note: Starting from WMS 5.02, there is no limit in the number of created switches and timetables. Prior to this version, you can create no more than 255.

You can create switches to enable the system to change the strategy of incoming calls routing depending on the actual Switch status.

...

  • Click + in the section Timetable
  • Enter the Timetable Name and select State check time (Check time state means that the PBX determines whether the timetable is active, based on the PBX time at the moment of the Dialplan execution)
  • Select the timetable and click Edit and specify the working hours:
PDF avoid Pagebreak

Image RemovedImage Added


In the same way as we did for the Switch, you must create a separate procedure to be executed in case the office is closed according to this timetable.

...

Note

Make sure SMTP client is defined in WMS Settings -> System -> SMTP client (see the chapter SMTP Client).


Fax to e-mail

Answers an incoming call using FAX Server and forwards fax to one or multiple fax numbers / users:

...

An example of Kite implementation can be found here: www.wildix.com/contacts.

One of the advantages of Kite is that it’s fully integrated into the Wildix telephony system:

...

Check Documentation: https://confluence.wildix.com/x/xQY8AQ.

WebRTC-based Wizyconf videoconference

...

Note

The admin user can access the Terminal directly from WMS, see chapter Introduction to WMS (Terminal).


To connect via SSH you can connect to the PBX via console (on Windows you can use “putty” or other SSH clients) or click on “terminal” icon in WMS upper menu (“admin” user)

...