The option to enable auto-provisioning of all SIP parameters for ConnecttoTeams end users using the existing device Provisioning Server is now available.
Config File Format
The auto provisioning feature leverages the Yealink config file format such that any Yealink compatible plain text file with [MAC Address].cfg (eg. 0015651133aa.cgf) will be retrieved and used to provision a Teams user.
To find the Auto Provisioning Settings, navigate to PBX page. Proceed to Add New PBX or edit an existing PBX. Then go to the Auto Provisioning Settings tab.
A Reseller Admin can create a new PBX or edit an existing PBX with an option to specify the URL of the Provisioning Server for that PBX.
Configuration of Auto Provisioning
To setup the Auto Provisioning feature, follow these steps:
Enable SIP Auto Provisioning - When a new PBX is created or an existing PBX has enabled auto-provisioning, the portal will attempt to retrieve SIP credentials for all users that are assigned to the PBX. It is also possible to enable auto-provisioning on a per-user basis by leaving this option disabled for the PBX.
Auto Assign UUID - Also referred to as MAC Address. If checked, this will enable the portal to generate a random MAC address to use for the User's SIP device.
NOTE: There are 2 possible provisioning workflows associated with the Auto-Assign UUID setting. In Workflow 1, devices are provisioned with MAC addresses in the PBX provisioning server first. It is assumed that the PBX administrator will create pseudo-MAC addresses for this purpose. Afterwards, the PBX administrator will bulk upload the PBX Users with their associated MAC addresses into the ConnecttoTeams portal. Once uploaded, the system will fetch the config files for auto-provisioning of SIP credentials based on the MAC address associated with each user. For this workflow, the Auto Assign UUID setting should be left UNCHECKED.
In Workflow 2, the users are created in ConnecttoTeams Provisioning Portal first, and the system will auto-create a UUID when a user is created. This UUID will then be configured in the PBX as the MAC address for the user’s device. For this workflow, the Auto Assign UUID must be CHECKED in order for the PBX administrator to obtain it initially.Provisioning Server URL - Enter the HTTPS URL of the Provisioning Server of the PBX that is used to fetch the SIP credentials of the user.
Provisioning Field for DID - Select from a drop-down menu which parameter in the provisioning file contains the DID.
The default selection is account.1.label.
None - If None is selected you must configure users' DIDs manually in the ConnecttoTeams Provisioning Portal.
Provisioning Username and Password - Enter the username and password used to access the Provisioning Server. These fields are optional and should only be used if the configuration files are password protected.
Upload Security Certificate - This is optional. If required by your provisioning server, you may upload a TLS security certificate here.
User Configuration
Below are the additional user configuration needed when Auto Provisioning is enabled for the PBX.
1. From the Users Page, navigate to Add User or Configure Valet App Users.
2. Select the PBX location
If auto-provisioning is enabled at the PBX location, then it is not necessary to enable auto-provisioning at the user level.
If auto-provisioning is not enabled at the PBX location, then you may enable auto-provisioning per user by checking the option to Enable SIP Auto Provisioning for each user.
3. Configure the UUID/MAC Address:
If Auto-assign UUID is not enabled for the PBX, then you must manually enter a MAC address at the bottom of the user’s settings. It is also possible to assign a MAC address to users with the bulk upload option.
If Auto-assign UUID is Enabled for the PBX, the system will generate and assign a unique user ID (UUID) to the User which will be used as a MAC for provisioning purposes. This is seen at the bottom of the add/edit user’s page
4. Enter the Provisioning Username and Provisioning Password for the user.
Note: The Username and Password entered at the user level will override the default provisioning Username and Password (if one is present under PBX settings). These fields are optional and should only be used if the configuration files are password protected.
Bulk Upload
To configure auto-provisioning by bulk upload, follow these steps:
1. Navigate to "Bulk Upload" then choose the desired voice route, User Type and PBX location from the dropdown menus.
2. Prepare the CSV files with the Mac Address.
AUTO_ASSIGN - if the users were created with auto-generate MAC Address (see workflow 2)
Actual Mac Address - if devices are provisioned with MAC addresses in the PBX provisioning server first. (see workflow 1)
3. Select Upload when you have successfully uploaded your desired Bulk Upload CSV file.
4. You will see a screen with the users extracted from the CSV file. click "Validate" in the upper right-hand corner. This will analyze the file and ensure there are no obvious data entry failures.
5. If there are no detectable errors the blue "Validate" button will change to say "Submit," as shown below. this will kick off the user addition process.
The Provisioning Process
After a user with Auto-Provisioning is added, the system will:
Attempt to retrieve the correct provisioning file from the configured provisioning server,
Update the SIP credentials in the ConnecttoTeams database, and
Register the User to the PBX.
The provisioning process requires several steps and may take up to 10 minutes to be completed. The status of the provisioning process can be seen in the Users table as denoted by the Auto Provisioning icon. A yellow Auto Provisioning icon means that Auto Provisioning has been enabled but the user is not yet provisioned. A green Auto Provisioning icon means that Auto Provisioning has been completed.
A user may be re-provisioned by selecting the Sync Auto Provision option. In case an error occurs during the initial provisioning, this option can be used to retry the process.
Re-provisioning with Check Sync
Once a user has been successfully provisioned, the PBX administrator may trigger a re-provisioning by sending the check0sync message in a SIP NOTIFY packet.
Troubleshooting
In case the auto-provisioning process encounters an error, status messages will be displayed in the activity feed.
