HOWTO Touchless Provisioning
Description
Touchless provisioning is a method of setting up devices to automatically provision the phone without the need to enter the provisioning settings in the phone's user interface. It provides much faster phone provisioning without the need to go to every phone’s interface and enter provisioning details, which is a time-consuming process when you buy for example 100 new phones. With touchless provisioning feature, you will be able to provision those 100 phones with just a few clicks.
How to configure Touchless provisioning?
The first thing which needs to be done on Multi-Tenant systems in order to configure Touchless provisioning is to enable Touchless provisioning mode. To do that, navigate to:
Settings → Tenants → Show Advanced Options → General Settings section → Touchless Provisioning Mode
and set option ‘Touchless Provisioning Mode’ which defines how Touchless Provisioning will be configured. By default, this option is set to ‘Not Selected’ and in this case you will not be able to see the Touchless provisioning menu on PBXware.
Other two available options are: Master and Per tenant.
Master: Touchless Provisioning Configuration page will only be visible on the Master Tenant. Set this mode if you want one configuration to be used for all tenants.
Per Tenant: Touchless Provisioning Configuration page will be visible on every slave tenant. Set this mode if you want to be able to configure every tenant separately.
NOTE: In order to be able to use Touchless provisioning, it has to be enabled in license.
Also, it is possible to set an option called Touchless Provisioning Credentials Expiry (available from PBXware v6.6.1).
This option sets a time period in hours or days, after which the touchless provisioning credentials will expire. (E.g. If the user sets TLP Credentials Expiry to '1 hour', this means that after the Registration request is sent, the user has one hour to reset the device to factory settings and pick up the configuration.)
NOTE: On Contact Centre edition there is no option for Touchless provisioning mode as you basically have only one tenant. Under Settings → Servers → General settings → option ‘Touchless Provisioning Credentials Expiry’ can be found, and it is the same as for Multi Tenant.
If Touchless provisioning mode is set to ‘Per tenant’, when you navigate to Tenant in question → Settings, Touchless Provisioning menu will be shown and there will be two submenus: Devices and Configuration.
NOTE: In version 6.7.1 we introduced a small change in how Touchless Provisioning devices are being displayed on Master Tenant. In earlier versions, devices from all tenants were automatically displayed on the Devices page, and now you are able to display devices from a specific tenant, by selecting the tenant from the drop-down list. With this change in place, you will need to select a tenant first, before devices are displayed.
Devices page is available on both, tenant and master tenant, regardless of the touchless provisioning mode option. When viewing from Master tenant, there will be a column which shows which tenant that device belongs to.
Devices page will show all devices which can be provisioned over touchless provisioning.
How to provision the phone with touchless provisioning?
Configure Touchless Provisioning (if not configured before).
‘Settings’ → ‘Touchless Provisioning’ → ‘Configuration’ → choose provider
Configuration page is visible either on Master Tenant or per tenant. If visible only on Master Tenant, then the same configuration will be applied on all tenants. If visible per Tenant, then every tenant needs to be configured separately. The page shows a list of all available providers whose phones can be provisioned with the Touchless Provisioning service. Currently, supported providers are: Yealink and Snom. Instructions on how to configure Snom can be found on this link.
For Yealink do the following instructions:
Choose provider Yealink → click on Enable button and choose HTTP as protocol, add AccessKeySecret and AccessKeyId which can be found on Yealink RPS account.
To get these credentials, users need to have a Yealink RPS account. This account is free and can be acquired by contacting the Yealink support.
Once users have the Yealink RPS account, they can proceed with the following steps to get the credentials:
Go to https://dm.yealink.com and enter the login username and password that the Yealink support provided.
Once logged in, go to the System Settings tab and then click 'API Service'.
Click the 'Acquire' button to generate a new pair of credentials.
Copy the 'AccessKeyID' and 'AccessKeySecret' into the Touchless Provisioning Yealink Configuration.
Click 'Save'.
Once the configuration is saved, click the 'Test' button. If users get the "Test finished successfully" message, then Yealink is ready to be used.
Create/edit extension and make sure three things are set:
UAD Location must be set to ‘Remote’
Auto provisioning must be set to YES and enter MAC address of your phone
In UAD field must be UAD from supported providers (Yealink and Snom)
Register the phone to the provider's redirection service. This is done by going to:
Settings → Touchless provisioning → Devices
Select the device with phone’s MAC address and click on Register button
Reset the phone to factory defaults.
When the phone is factory reset, it will contact the provisioning server and automatically pull all the data needed for provisioning and will be provisioned to the assigned extension.
When adding a new extension or hot-desking device, it will automatically be registered to the provider's redirection service.
Once the phone is provisioned, it will be removed from the provider's redirection service.