Versions Compared

Key

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




Html
<div class="fb-like" data-href="https://confluence.wildix.com/x/twM8AQ" data-layout="button_count" data-action="recommend" data-size="large" data-show-faces="true" data-share="true"></div>

...

Html
 <div class="lang-box-pdf">
	<div>
		<div class="google-lang">
			<div id="google_translate_element">
			</div>
			<script type="text/javascript">
					function googleTranslateElementInit() {
						new google.translate.TranslateElement({pageLanguage: 'en', includedLanguages: 'de,es,fr,it,nl', autoDisplay: false}, 'google_translate_element');
						}
			</script>
			<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>
		</div>
		
		<div class="pdf-button">
			<a href="https://confluence.wildix.com/spaces/flyingpdf/pdfpageexport.action?pageId=20710327" alt="Convert to .pdf" title="Convert to .pdf"><img src="https://confluence.wildix.com/download/attachments/14549012/pdf-button-download-wildix-documentation.png"></a>
		</div>
	</div>
</div>
Html
<style>
.button {
  background-color: #dd9932; /* Green */
  border: 2px solid white;
  border-radius: 8px;
  color: #003366;
  padding: 16px 32px;
  text-align: center;
  text-decoration: none;
  display: inline-block;
  font-size: 16px;
  margin: 4px 2px;
  transition-duration: 0.4s;
  cursor: pointer;
  
}

.button:hover {
  background-color: #dd9932;
  color: white;
}

</style>
<button class="button" onclick="window.open('https://forms.gle/pBD3vq6hLdZsfwZv8')">Please help us improve by answering three simple questions. <b>Click here!</b></button>

Info

This document helps you understand Wildix licensing and explains how to activate a Wildix Per User PBX (Hardware, Virtual, Cloud).

Date: June 2018

Updated: February 2020

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

Useful links:

Toc

Other documents related to WMP (Wildix Management Portal):

Content Report Table
labelswmp

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:

  1. Choose the platform: Hardware, Virtual, Cloud
  2. Choose the recurrent payment cycle: Monthly / Yearly / 5 years / Lifetime (lifetime is not available for Cloud)
  3. Choose the number of users of each Profile: Basic / Essential / Business / Premium/ Wizyconf/ Service
Note

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.

...


Info

This document helps you understand Wildix licensing and explains how to activate a Wildix Per User PBX (Hardware, Virtual, Cloud).

Date: June 2018

Updated: February 2020

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

Useful links:

Toc

Other documents related to WMP (Wildix Management Portal):

Content Report Table
labelswmp

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:

  1. Choose the platform: Hardware, Virtual, Cloud
  2. Choose the recurrent payment cycle: Monthly / Yearly / 5 years / Lifetime (lifetime is not available for Cloud)
  3. Choose the number of users of each Profile: Basic / Essential / Business / Premium/ Wizyconf/ Service
Note

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 
Anchor
step1
step1

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 (License field is optional):


  • 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 / PBX-Service: add the number of users of each profile (more about each 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):

...

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 (License field is optional):

...

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 / PBX-Service: add the number of users of each profile (more about each profile: https://www.wildix.com/licensing/)

    • Storage size (only for Cloud PBX): increase Cloud instance storage size. Refer to this chapter for more details

Note

If you made a mistake during the system activation, please contact immediately your Area Manager. Issue must be reported within 1 (one) business day.

  • Click Add and then Ok to confirm the subscription fee; your PBX has been added:

Note

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 

Note

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

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:

Note

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)

  • 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

...

Info

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. 

Note

The "Admin" user is not included into the total count of users.

Note

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
    • 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)
  • Wizyconf
    • one license per 1 Wizyconf web conference to activate Wizyconf user and participate in videoconferences
  • 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

Note

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:

...

You can also check the number of licenses bought and used in WMS Settings ->  Tools and utilities -> Activation / Licenses:

Note

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. 

Note

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:

...

Scroll down to the field License type and select the type of the License type from the drop-down list:

...

Note

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

...

    • )

    • Storage size (only for Cloud PBX): increase Cloud instance storage size. Refer to this chapter for more details


Note

If you made a mistake during the system activation, please contact immediately your Area Manager. Issue must be reported within 1 (one) business day.

  • Click Add and then Ok to confirm the subscription fee; your PBX has been added:


Note

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 

Note

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

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:

    Note

    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)

    • 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:

Assign correct license type to each user 
Anchor
assignlicense
assignlicense

Info

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. 

Note

The "Admin" user is not included into the total count of users.


Note

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
    • 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)
  • Wizyconf
    • one license per 1 Wizyconf web conference to activate Wizyconf user and participate in videoconferences
  • 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

Note

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:


Note

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. 

Note

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:

  1. Select one or multiple users and click Edit
  2. Scroll down to the field License type and select the type of the License type from the drop-down list:


  3. Click Ok to apply the changes


Note

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.       

  1. Go to WMP -> Customers
  2. Select your company and customer
  3. Select the PBX -> click Edit
  4. Add/ remove the number of users of a required profile
  5. Click Save and Ok to confirm the operation
Note

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. 


Note

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.


Note

If the Partner has made a mistake during the system activation, please report it to your Area Manager within 1 (one) business day, include the following details:

  1. partner’s name
  2. customer’s PBX S/N
  3. quantity and type of licenses that should be on the PBX

IMPORTANT: Partners should not change anything by themselves! Only report a mistake to the account manager.


Change the term of the license

To change the expiration period, follow the steps below:

  1. Go to WMP -> Customers
  2. Select your company and customer
  3. Select the PBX -> click Edit
  4. Add/ remove the number of users of a required profile
  5. Click Save and Ok to confirm the operation
Note

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!

...

  1. -> click Edit
  2. Decrease the number of user licenses to zero
  3. Click Save and Ok to confirm the operation
  4. Select the PBX again and click Edit
  5. Change the expiration period (term of the license) 
  6. Add back user licenses
  7. Click Save and Ok to confirm the operation


Note

If the Partner has made a mistake during the system activation, please report it has to your Area Manager be reported within 1 (one) business day, include by sending an e-mail to the area manager with the following details:

  1. partner’s name
  2. customer’s PBX S/N
  3. quantity and type of licenses that should be on the PBX
  4. expiration term to be set

IMPORTANT: Partners should not change anything by themselves! Only report a mistake to the account manager.

Change the term of the license

To change the expiration period, follow the steps below:

  1. Go to WMP -> Customers
  2. Select your company and customer
  3. Select the PBX -> click Edit
  4. Decrease the number of user licenses to zero
  5. Click Save and Ok to confirm the operation
  6. Select the PBX again and click Edit
  7. Change the expiration period (term of the license) 
  8. Add back user licenses
  9. Click Save and Ok to confirm the operation
Note

If the Partner has made a mistake during the system activation, it has to be reported within 1 (one) business day, by sending an e-mail to the area manager with the following details:

  1. partner’s name
  2. customer’s PBX S/N
  3. quantity and type of licenses that should be on the PBX
  4. expiration term to be set

IMPORTANT: Partners should not change anything by themselves! Only report a mistake to the account manager.

Note

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

In case you delete all the user licenses (decrease them to zero) from your Cloud PBX, the PBX will be scheduled for deletion in 2 weeks.

One week before the scheduled deletion, you will receive a reminder via email about the scheduled PBX deletion. In two weeks your Cloud PBX will be deleted.

...

to the account manager.


Note

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

In case you delete all user licenses (decrease them to zero) from a Cloud PBX, the PBX 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?

You have five calendar days to revert this process. Just add back at least one user license and the PBX will not be deleted.

What if I changed my mind after the PBX was stopped?

Starting from the day when user licenses have been decreased to zero, you have 14 calendar days until the PBX is irrevocably deleted. Once the PBX is stopped (after five calendar days), you are notified via email. After that you still have five working days (9 calendar days) until the PBX is irrevocably deleted. If you change your mind regarding PBX deletion during this time span, add back at least one user license and get in touch with your Area Manager ASAP to notify them about this change.

The process:

  1. Once all user licenses are deleted from a Cloud PBX, it is scheduled for deletion. 
  2. In five calendar days (since the PBX has been scheduled for deletion) the PBX is stopped and the PBX owner (the Partner) receives a confirmation via email. 
  3. In 14 calendar days (since the PBX has been scheduled for deletion) the PBX is irrevocably deleted and the PBX owner (the Partner) receives a confirmation via email. 



Move PBX to Cloud

Warning

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

...

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. 

Enable SSH port on Cloud PBXs (optional) 
Anchor
Sshport
Sshport

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:

...