This document helps you understand Wildix licensing and explains how to activate a Wildix Per User PBX (Hardware, Virtual, Cloud).
Created: June 2018
Updated: August 2021
Permalink: https://confluence.wildix.com/x/twM8AQ
Useful links:
Other documents related to WMP (Wildix Management Portal):
Title | Creator | Modified |
---|---|---|
How to configure and use CLASSOUND | Simon Darienko | Aug 21, 2024 |
Customer Care FAQ | Ksenia Babych | Aug 15, 2024 |
Wildix Terms and Conditions | Elena Kornilova | Jul 30, 2024 |
HWaaS - Hardware as a Service | Elena Kornilova | Jul 29, 2024 |
CLASSOUND Virtual DIDs | Tatiana Bieliakova | Apr 17, 2024 |
PBX Licensing and Activation - Admin guide | Elena Kornilova | Mar 05, 2024 |
Provisioning of Wildix devices - Admin Guide | Ksenia Babych | Feb 26, 2024 |
CLASSOUND Activation Request | Elena Kornilova | Feb 13, 2024 |
WMP Dashboards | Elena Kornilova | Jan 10, 2024 |
RMA UK Procedure | Ksenia Babych | Jan 09, 2024 |
CLASSOUND Instant Virtual Porting (IVP) | Tatiana Bieliakova | Dec 12, 2023 |
Common RMA Regulations | Ksenia Babych | Aug 22, 2023 |
How to process and pay bills directly via WMP | Ksenia Babych | Jun 09, 2023 |
What happens if Partner has overdue invoice payments | Ksenia Babych | Jan 03, 2023 |
VoIP and 911 Service | Tatiana Bieliakova | Dec 15, 2022 |
How to place WMP CAPEX orders | Ksenia Babych | Aug 24, 2022 |
Understanding Per User Licensing
Wildix currently offers Per User licensing. It means that you can add as many users of each profile as you need and add more users whenever you need. You pay per user / per period of time.
Here are the steps to activate a Per User PBX:
- Choose the platform: Hardware, Virtual, Cloud
- Choose the recurrent payment cycle: Monthly / Yearly / 5 years / Lifetime (lifetime is not available for Cloud)
- Choose the number of users of each Profile: Basic / Essential / Business / Premium / Wizyconf Room / Wizywebinar / Service
Note: you first select the period of time and then the number of users, this means you cannot select different recurrent payment periods for different types of user profiles, e.g. if the recurrent period is 1 year, it means the users of all types (Basic, Business, Premium) are added for 1 year. You can increase the number of users any time (add more users of any type).
Example: you need 10 users with basic phone services (fax machines, unattended phones, doorphones), 30 users with access to Collaboration and only 5 users with access to CDR-View. You activate 10 PBX-BASIC users, 30 UC-ESSENTIAL users and 5 UC-PREMIUM users. At any moment, you can add more users of any type.
Details on each user profile: https://www.wildix.com/licensing/.
Per User licensing is available for any PBX type:
Hardware
Virtual
Cloud
PBX Activation
Prerequisites:
For Hardware PBX you need first to purchase a Hardware PBX in WMP -> Cart (code: WPBX-HW):
Step 1. Add a new Per User PBX on WMP
Proceed as follows:
Connect to WMP using your credentials
Go to Customers tab; to create a new PBX, you first need to add a customer (if it does not exist yet); click Add:
Create a new customer (company): fill in the fields and click Save:
You need to create at least one contact: fill in the fields and click Add:
Now you can proceed with adding a new PBX: go to PBXs tab:
You are now under PBXs tab, click + to add a new PBX:
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 / lifetime (lifetime is not available for Cloud PBX)
PBX-BASIC / UC-Essential / UC-Business / UC-Premium / UC-Wizyconf Room / UC-Wizywebinar / PBX-Service: add the number of users of each profile (more about each profile: https://www.wildix.com/licensing/)
Storage size and enable Static IP(only for Cloud PBX): increase Cloud instance storage size. Refer to this chapter for more details
- x-caracal: tick the option if you want to use our light and agile ACD stats solution, fully integrated into the Wildix communication system. To activate x-caracal, the following requirements should be met: at least 1 Premium license and 10 Business/ Premium licenses, Cloud PBX, a monthly fee per each PBX. For more details on how to activate and use x-caracal refer to this documentation.
- MS-PhoneSystem: this is an option within teams4Wildix integration that lets you place and receive calls not only from Collaboration, but also from Teams dialpad of MS Teams interface. You can find more information on how to set up and use MS Phone System in the following guides: Instructions for Wildix Partners, Instructions for End Customers.
Click Add and then Save
To confirm the subscription fee, tick off
Your PBX has been added:
Note: after the PBX has been added, you can see its Software Serial (SW Serial):You can use SW Serial to activate new HW PBX in case of RMA or you can replace HW with VM PBX and vice versa. In this case new PBX will take Name, Licenses and attached Devices of the SW serial.
Please note, next activation of HW PBX will automatically convert HW Serial to SW Serial preserving its Name, Licenses and attached Devices. So HW Serial will disappear from portal and new SW Serial will appear instead.
Step 2. Activate PBX from WMS
For Virtual PBX: before proceeding, follow the guide to deploy PBX image:
- WMS version 5.0X: /wiki/spaces/DOC/pages/30283187
- WMS version 4.0X: /wiki/spaces/DOC/pages/30282467
For Cloud PBX: wait for approximately 3 minutes before proceeding. Your PBX will be activated.
Proceed as follows:
Connect to PBX via HTTPS to access WMS using credentials admin : wildix
Change admin user password:
Select admin user and click Set passwords
Generate or create a new WEB password, click Ok
Upgrade WMS to the latest stable release
go to WMS Settings -> Tools and utilities -> Upgrade
In case there is a new version available, click Perform Upgrade
Copy PBX key from WMP:
Only for Virtual and Hardware PBXs. Cloud PBXs are activated automatically (wait for approximately 3 minutes after completing Step 1).
go to Customers tab, select your company, then select the PBX that you have created (Step 1), optional: click Options button (Three dots) and select Edit
click the Copy icon (Copy PBX key to clipboard):
Insert the PBX key on WMS side:
Open WMS Settings -> Tools and utilities -> Activation / Licenses
Paste the PBX key copied on the previous step into the field User Mode and click Activate
Your PBX is now activated:
Important! After Cloud PBX is activated, make sure to change a default admin password as it is reset after 7 days of uptime.
In case you face any issues with reset, contact Wildix Support.
Assign correct license type to each user
Assigning licenses to users in WMS is supported starting from WMS version 4.01.44168.28.
After you have purchased the licenses on WMP and activated the PBX, please follow WMS Start Guide to configure the system and add users.
This chapter explains how to assign the license type to each user.
The "Admin" user is not included into the total count of users.
Since "Park orbit" type of users has no SIP registration, it is required to assign PBX-Service License (free of charge).
About license types
General recommendations regarding assigning license types to different types of users:
- Basic:
- unattended phones
- fax machines
- door phones
- hotel rooms
- users who need only telephony features without chat and presence
- Essential:
- users who need access to Collaboration
- users who need access to Wildix mobile apps
- users who need presence and chat features on supported Wildix devices
- Business:
- users who need to be able to create Wizyconf conference rooms in Collaboration (everyone can participate in video conferences, but only users with at least a Business license can create new rooms)
- users who need to be contacted via Kite
- users who use WebAPI and TAPI integrations
- Premium:
- one license per system is enough for WBI services (2 hours of service per one license). Note: For Voicemail Transcription to email, one license is necessary for each user who needs access to it (starting from WMS v. 4.03.44842.05)
- one license is enough for Fias and ESPA monitor integrations
- one license is necessary for each user who needs access to CDR-View
- one license is necessary for each user who needs access to Contact center feature in Collaboration (interactive queues)
- one license is necessary for each user who needs to manage Call groups (dynamically add or delete members) via WebAPI Wallboard
- Wizyconf Room (one license for each Wizyconf Hardware conference station):
- a Wizyconf hardware station must be assigned to a dummy (virtual) user of the system and this user must be assigned a Wizyconf Room license to be able to participate in video conferences
- Wizywebinar:
- one license for each user who needs to have access to Wizywebinar platform
- Service: (free of charge, doesn't support SIP registration, any login permissions (Collaboration/ WMS)
- park orbits
- virtual users created for call forwarding purposes (without login to Collaboration/ any device) in Dialplan
- virtual users used for Identities feature (without login to Collaboration/ any device) to replace a real user's number
For more details, please refer to the page https://www.wildix.com/licensing/.
Upgrade instruction in case of WMS network
Please follow the instruction provided below when you upgrade for the first time to the WMS version that supports assigning of licenses (if your current WMS version is inferior to 4.01.44168.28).
In case of WMS network:
- All the PBX must be upgraded
- First upgrade Client PBXs and only then the Server PBX
- In case you have already updated the Server or only one or several PBXs, proceed with updating all the PBXs in the network as soon as possible
After the upgrade all the users are assigned the maximum license type purchased for this PBX. E.g. if at least one Premium license is present, all users become Premium. It will be necessary to manually set the correct license type for each user.
In case you are using WMS Network Sharing of licenses (described in chapter Share Per User Licenses between PBXs over WMS Network), the number of licenses will be counted only on the "Server" PBX in the WMS network.
License usage exceeded
Currently in case the number of licenses used is exceeded, users do not lose access to any functionality. Hard enforcement of licensing is planned in March 2020.
In case the number of licenses used was exceeded, users do not lose access to any functionality, but the system administrator is informed:
notification is displayed in red in WMS telling the system administrator that the number of licenses was exceeded:
- notification via email is sent to the system administrator each day (temporarily disabled)
You can also check the number of licenses bought and used in WMS Settings -> Tools and utilities -> Activation / Licenses:
The "Admin" user is not included into the total count of users.
Assigning license type to each user
By default after the upgrade to the version that supports license assignment all users are set to the maximum license level purchased for this PBX. E.g. in case at least one Premium is present, all users become Premium. You need to manually assign the correct license type to each user.
Restrictions and privileges of each license type (Basic, Essential, Business, Premium) are applied only after you assign the correct license type to each user.
Currently not all restrictions for each license type are fully implemented. Full implementation of restrictions, as well as hard enforcement of licensing is planned in March 2020.
You can assign the correct type of license to each user in WMS -> Users:
- Select one or multiple users and click Edit
Scroll down to the field License type and select the type of the License type from the drop-down list:
- Click Ok to apply the changes
Newly created or exported users by default are assigned Essential license. It is necessary to manually set the correct license type.
Changes to the license - upgrade, downgrade, increase, decrease, change the term
Increase / decrease, upgrade/ downgrade of licenses
It is possible to increase/ decrease the number of accounts any time.
- Go to WMP -> Customers
- Select your company and customer
- Select the PBX -> click Edit
- Add/ remove the number of users of a required profile
- Click Save and Ok to confirm the operation
If you need an upgrade/ downgrade of the existing licenses: any upgrade or downgrade has to be done through the Portal by the Partner only. There will be no money back for the prepaid licenses.
Licenses will be automatically renewed and invoiced on the last day of their expiration term.
We recommend to carry out all of the license changes 2 days before the license expiration date.
IMPORTANT: No license decrease can be done on the last day of the month!
But licenses can be removed at any moment with no money back for prepaid ones.
Change the term of the license
To change the expiration period, follow the steps below:
- Go to WMP -> Customers
- Select your company and customer
- Select the PBX -> click Edit
- Decrease the number of user licenses to zero
- Click Save and Ok to confirm the operation
- Select the PBX again and click Edit
- Change the expiration period (term of the license)
- Add back user licenses
- Click Save and tick off I confirm the order
- Click Ok to confirm the operation
Licenses will be automatically renewed and invoiced on the last day of their expiration term.
We recommend to carry out all of the license changes 2 days before the license expiration date.
IMPORTANT: No license decrease can be done on the last day of the month!
But licenses can be removed at any moment with no money back for prepaid ones.
Scheduled deletion of Cloud PBXs
Once all user licenses are deleted (decreased to zero) from a Cloud PBX, the PBX is scheduled for deletion: will be stopped in five calendar days and irrevocably deleted in 14 calendar days.
What if I don't want this PBX to be deleted?
The PBX owner (the Partner) has five calendar days to revert this process. They should add back at least one user license and the PBX will no longer be scheduled for deletion.
What if I changed my mind after the PBX was stopped?
Starting from the day when user licenses have been decreased to zero, the PBX owner (the Partner) has 14 calendar days until the PBX is irrevocably deleted. Once the PBX is stopped (after five calendar days), the Partner still has five working days (9 calendar days) until the PBX is irrevocably deleted. If the Partner changes their mind regarding PBX deletion during this time span, they should add back at least one user license and get in touch with their Area Manager ASAP to notify them about this change.
The process:
- Once all user licenses are deleted from a Cloud PBX, it is scheduled for deletion. On the second day notification is sent to the PBX owner (the Partner).
- In five calendar days (since the PBX has been scheduled for deletion) the PBX is stopped.
- In 14 calendar days (since the PBX has been scheduled for deletion) the PBX is irrevocably deleted.
Move PBX to Cloud
Limitations:
- Only MySQL/ SQLite3 Database is supported for migration (WMS 4.0X)
- Only SQLite3 Database is supported for migration (WMS 3.XX)
- DB size for migration is limited by the root partition size on Cloud PBX: about ~6-7G
Important! After the migration to Cloud is completed, turn off or reset to default the old HW PBX to avoid routing/ network issues.
Move a Subscription-based PBX to Cloud (1 month/ 1 year/ 5 years)
Step 1 - Create a new Cloud instance on WMP
To move Per User subscription-based (1 month/ 1 year/ 5 years) PBX to Cloud, you need to access WMP where you have a button that allows creating a new Cloud instance instead of your current PBX. The licenses active on this PBX and the PBX serial will be moved to the new Cloud instance.
Important notes:
- PBX will not be reachable for up to 20 minutes, during which the DNS record will be updated (the migration time depends on the migrated DB size), remember to update/remove any local DNS proxies; phones/media gateways must use the DNS name for provisioning or they will not switch automatically to the Cloud PBX
- The old PBX will stop working as soon as the licence will be synced
How-to:
- Access WMP using your credentials
- Select your company and your customer
- Click Options button (Three dots) and select Edit
- Click Advanced features
- Click Migrate to new WCloud PBX
Step 2 - Run the script on old PBX to move all the data
Min supported WMS version (make sure your PBX is updated to this version before proceeding):
- WMS 3.88: 3.88.44723.49
- WMS 4.x: 4.03.44693.48
Now when you've created a new Cloud instance for your HW/ VM PBX, you need to launch the script on your old PBX that will move all the data from your old PBX to the new one.
Run the script:
- Access WMS, Open Terminal on the PBX, select the option 10 (Shell), access as root (su - wildix)
Only for 3.88 PBXs! Run these 2 commands:
rm -rf /usr/sbin/migrate2cloud wget https://files.wildix.com/migrate2cloud -P /usr/sbin/
Run the command:
migrate2cloud
Limitation for 3.88 PBXs: chat history is not moved!
Move a Per-Service or a LifeTime PBX to Cloud
Min supported WMS version (make sure your PBX is updated to this version before proceeding):
- WMS 3.88: 3.88.44763.50
- WMS 4.x: 4.03.44733.50
Step 1 - Create a new Cloud instance on WMP
Create a new Cloud PBX as described in chapter Add a new Per User PBX on WMP.
Step 2 - Run the script on old PBX to move all the data
- Access WMS, Open Terminal on the PBX, select the option 10 (Shell), access as root (su - wildix)
Only for 3.88 PBXs! Run these 2 commands:
rm -rf /usr/sbin/migrate2cloud wget https://files.wildix.com/migrate2cloud -P /usr/sbin/
Run the command:
migrate2cloud -s <serial of cloud pbx>
You will be prompted to enter the password of your new cloud PBX. During the script execution you will be prompted to confirm, which data you would like to be moved. As soon as the script finishes its execution, the data will be moved and you will be able to access the Cloud PBX using the password of your old PBX.
Limitation for 3.88 PBXs: chat history is not moved!
Enable SSH port on Cloud PBXs (optional)
Direct access to SSH port on Cloud PBXs is blocked for security reasons. Now it’s up to you to temporarily enable/ disable SSH port 2222 via WMP:
- Access WMP using your credentials
- Select your company and your customer
- Click Options button (Three dots) and select Edit
- Click Advanced features
- Select Enable SSH option
If there is a need to block the port, it can be deactivated via Disable SSH option.
Share Per User Licenses between PBXs over WMS Network
It is possible to share licenses over other Cloud, Hardware and Virtual PBXs in the WMS Network. Normally this scenario is used for Failover configuration. In this scenario you add UC profiles (users) only on Server PBX and then you can share the licenses enabled on Server PBX with Client PBX(s).
Prerequisites for this scenario:
The PBXs must belong to the same customer
WMS Network must be enabled between the PBXs
- All PBXs must be of Per User type
There must be no licenses enabled on the Client PBX
Limitations for Cloud PBXs:
- Cloud PBX cannot be connected to Server PBX with Lifetime license
- Cloud PBX with increased storage size cannot be connected to Server PBX
To enable WMS Network license sharing, proceed as follows:
Go to WMP -> Customers
Select your company and customer
Select the Client PBX -> click Edit
Select WMS Network License and select the Server PBX from the drop-down list
Click Save
Periodic License Check
As stated here: https://www.wildix.com/licensing/, all Virtual and Hardware systems update their license information daily connecting via port 443 to:
wmp.wildix.com – WMS version lower than 3.86
- api.wildix.com – starting from WMS version 3.86
(this doesn’t apply to Cloud systems)
If connection to the license server is not available, a Hardware / Virtual Per User PBX will continue working for 14 days only. After which the PBX will support only one call for emergency purposes.
In case any of your customer's PBXs are not able to renew its license, you are notified via email containing the following information:
- the name of the customer (company)
- PBX serial and model
- how many days have passed since the PBX couldn't renew the license
In case this PBX should continue working, all you need to do is to make sure the PBX is connected to the Internet again, and in this way it is able to renew its licenses.
Increase storage on Cloud PBX
By default you have 10 GB of storage available on one Cloud PBX. When there is less than 10% of storage left, the relevant email is sent to the system administrator. See an example of such an email below:
You can increase the storage size. To perform it, proceed as follows:
- Select the customer and choose the Cloud PBX (or add a new one)
- Click Options button (Three dots) and select Edit
- Increase the storage size: 1 license=10 GB
Confirm the operation by clicking Yes
Note: The change will be applied at 1AM.
Important: After you have increased the storage size, it will not be possible to decrease it.
Video Tutorials
Activation of Per User PBX (Hardware, Virtual)
Video tutorial - Starting from 2:07 (2m07s)
WMP Intro Video
Video tutorial: