Home / Cloud Device Manager / Tenant Admin Guide

Tenant Admin Guide


Overview

  • Device(s) - Since the Cloud Device Manager is a generic configuration tool for SIP based devices we refer to the devices that we write out configuration files for as Device.  This can include SIP Phones, ATAs, Gateways, Door Control Boxes, Overhead Paging or Dect Base Stations.
  • Options and Settings - Because Templates are agnostic to manufacture and models of phones not all settings in a template will apply to all manufacture and models of phones.

Logging In

  • Open a web browser to https://devices.clearlyip.com
  • Login with your Clearly IP Single Sign On (SSO) Username and Password. This is the same username and password used to login to Clearly IP Support Site and different Portals.
  • Click on the CDM Tab at the top.  If you do not have a CDM tab that means your account is not setup with CDM access.  At this time CDM is not sold or offered as a stand alone product and is bundled with the Clearly Cloud offering only.


Location Overview

Locations in CDM are best described as a unique PBX or tenant on a multi tenant PBX.  It contains information about the PBX such as the IP Address or Domain Name on how to connect to the PBX for the SIP End Points, What Codecs the Location supports and what its standard feature codes are that may be used in program buttons.

A location gets created and belongs to a Tenant and the users of that Tenant can now manage that Location.

Creating a new Location

  • Once Logged into CDM from the Menu bar click on CDM > Locations


  • Click on the "Add A New Location" button to add a new Location


  • Add Location Step 1 Wizard - Press the next button for step 2
    • Tenant Owner - Pick which Tenant this Location belongs to.  If you are logged in as a tenant you will not be able to pick a different Tenant. This only pertains to Reseller Level logins.
    • Name - Provide a Name for this Location
    • Description - Optionally provide a Description for this Location
       
  
  • Add Location Step 2 Wizard - Press the next button for the 3rd and final step
    • Outbound Proxy - Optional field if your PBX is setup that requires an Outbound Proxy.  Usually only used in Multi Tenant style PBXs. This is either the IP Address or Fully Qualified Domain Name (FQDN) of your Outbound Proxy server.
    • Outbound Proxy Port - Optional field to define the port to be used with the above Outbound Proxy IP or Domain name. 
    • Primary Local Host - The IP Address or Fully Qualified Domain Name (FQDN) of your PBX that your Devices will register too.  This is a required field
    • Primary Local SIP Port - The SIP Port that your Primary Local Host is setup to listen to SIP on.
    • Primary Remote Host - This is an optional field that can be used as a alternative IP Address or Fully Qualified Domain Name (FQDN) of your PBX.  This field is usually used if you have a PBX setup with an Internal IP that some extensions will register too and an external IP address for other Extensions that are remote. When you go to map extensions to a location,  by default the extension will use the Primary Local Host and you can optionally tell the Extension to use this Primary Remote Host instead.
     
  • Add Location Step 3 Wizard
    • The following settings are only set if you have a PBX setup where your Devices will register to a Primary Server as defined above and if that Primary Server is down the Devices will attempt to register to a Secondary Backup Server.  This is not a very common setup but here is where you can define how to reach that Backup System for us to provide that data into the device provisioning for devices that support this feature.
    • Backup Outbound Proxy - This is either the IP Address or Fully Qualified Domain Name (FQDN) of your backup outbound proxy server.
    • Backup Outbound Proxy Port - Field to define the port to be used with the above backup outbound proxy IP or domain name. 
    • Failover SIP Port - The SIP Port of your primary backup or failover Server
    • Failover SIP Server - This is either the IP Address or Fully Qualified Domain Name (FQDN) of your backup or failover server
 
  • Press Next to complete the location wizard

  • Verify the details are correct and press the Add Location button

  • Your Location has now been created and your can follow the steps below to go view and edit the details of the Location such as defining what Codecs you want the phones to use when mapped to this location.

 

Managing existing Locations

  • Once Logged into CDM from the Menu bar click on CDM > Locations


  • From here you can see a list of all the Locations that your login has access to and what Tenant they belong to if you are a reseller where you can see all the Tenants that are under you and manage things.


  • Click on the Binocular icon.  under the Action column to view and edit the details of the Location

  • Click on the Trash Can icon   under the Action column to delete the Location

Template Overview

Templates are where we provide the information about the End Point Settings we want to configure such as Line Keys, BLF keys and all the options and features of the end points. A template gets linked to a Tenant and can be mapped to any Extensions of that Tenant along with any Locations for that tenant.

Because Templates are agnostic to manufacture and models of phones not all settings in a template will apply to all manufacture and models of phones.

Creating a new Template

  • Once Logged into CDM from the Menu bar click on CDM > Templates


  • Click on the Add New Template button at the top


  • Add Template Step 1 Basic Wizard - Press the next button for step 2
    • Tenant Account - Pick which Tenant this Template belongs to.  If you are logged in as a Tenant you will not be able to pick a different Tenant. This only pertains to Reseller Level logins.
    • Name - Provide a name for this template
    • Description - Optionally provide a informative description on this template so you can remember what its used for in the event you have a lot of template.

  • Add Template Step 2 General Wizard - Press the next button for step 3
    • General
      • Admin Username - For Devices that support a Admin User login here is where you can set what username you want the admin user to be. 
      • Admin Password - For Devices that support a Admin User Login above this is the password you would use to login as that user.
      • User Username - For Devices that support a User level login here is where you can set what username you want the User Level user to be
      • User Password - For Devices that support a User level Login above this is the password you would use to login as that user.
    • Provisioning
      • Provision Username - This is the username that is used by the Device when it is requesting a provisioning file from Cloud Device Manager for any Devices that are mapped to this template.  We auto generate a random username here.  
      • Provision Password - This is the password that is used by the Device when it is requesting a provisioning file from Cloud Device Manager for any Devices for the user above that are mapped to this template.  We auto generate a random password here.  
    • Resync
      • Resync - Enable or disable the how often the phone should re-check with Cloud Device Manager for a new or updated configuration file.
      • Resync Time - How often in minutes the phone should re-check in if enabled above.  The default is 1440 mins which is every 24 hours.  
  • Add Template Step 3 Regional Wizard - Press the next button for step 4
    • Time and Date
      • Time Server - What NTP or Time Server the Device will sync its clock with.
      • Time Zone - What Time Zone the Device will be set too.
      • Daylight Savings - Enabled or Disabled will hard set the Device to have Daylight Savings on or off.  Setting it to Auto will have the phone determine if its in Daylights Saving mode or not at any given time.
      • Time Format - 12 or 24 Hour format for the clock display on the Device
      • Date Format - What format you want the date shown on your Device
    • Languages - Not all Devices support the same languages here so verify that the language you pick here is supported by your manufacture of your Device.
      • Phone Webpage Language - What language should the Devices built in Web GUI use.
      • Phone GUI Language - What language should the Devices built in LCD menu on the device use.
  • Add Template Step 4 Phones Wizard - Press the next button for step 5
    • Phone Settings
      • Display Missed Calls - Enable or Disable if the Device should show missed call notifications
      • Call Waiting - Enable or Disable if the Device should honor Call Waiting
      • Call Waiting Tone - Enable or Disable if the Device should play a beep when a Call Waiting call is received.
      • Line Label - For Devices that use LCD Keys to display your Extension Registration/Lines do you want the LCD to show the following;
        • Ext - This will show the "Extension Number" on the LCD that are setup as line keys
        • Ext-Name - This will show the "Extension Number - Extension Name" on the LCD that are setup as line keys
        • Name - This will show the "Extension Name" on the LCD that are setup as line keys
        • Name-Ext - This will show the "Extension Name - Extension Number" on the LCD that are setup as line keys
      • Headset - To enable the Device to be in headset mode as the default mode.
      • Backlight Timeout - For Devices that support having the phones backlight go into dim or off mode after a period of inactivity time you can set that period of time here
      • Conf Call Release - If the Device hangs up on a 3 way conference call here is where you can define what should happen to the remaining parties of that call for Devices that support this feature.
      • Transfer Mode - When pressing a BLF or speeddial while on an active call here is where you can control what should happen to the active call that you are talking to.
      • Headset Ringer - What should play ringing on an inbound call.

  • Add Template Step 5 Review Wizard - Press the Add Template button to complete the adding of this Template


  • Now that we have created the Template we need to go Edit the template following the Guide below on Managing existing Template to setup the different Models of Devices and buttons on those Models.

  • We also have a lot more settings related to a Template that are displayed when you go and edit a Template that we do not expose in the Template Creation Wizard.

Managing existing Templates

  • Once Logged into CDM from the Menu bar click on CDM > Templates


  • From here you can see a list of all the Templates that your login has access to and what Tenant they belong to if you are a reseller where you can see all the Tenants that are under you and manage things.

  • Click on the Binocular icon.  under the Action column to view and edit the details of the Template. 

  • Click on the Trash Can icon   under the Action column to delete the Template

Managing Device Models in a Template

  • Following the steps above on Managing Existing Template once you have clicked on the Binocular Icon for a Template we can click on the Models tab and start adding, editing or deleting any Device Models for a Template.  From here you can Add, Edit or Delete any Model.
    • Delete - click on the orange Garbage Can inside each model box.
    • Edit - click on any Model box to go edit the settings for that Model
    • Create New - Clicking on the Add A New Model button allows you to go create a new Model
  • Each Template can have 1 or more Models added and you can add the same Model more than once to a template if you need to setup buttons for different groups of users without having to create a new Template.

  • Editing or Creating a new model will bring up the following options

  • Add Model Step 1 Model Wizard - Press the next button for step 2
    • Select A Model - Which model of a device you want to setup from a drop down sorted by manufacture.
    • Select a Firmware - Pick from a drop down of what firmware you want this Device to install once it pulls its configuration file from a list of Firmwares that are tested by us and compatible with CDM
    • Description - A friendly name or Description on what this model is used for for your own reference.

  • Add Model Step 2 Required Fields Wizard - Press the next button for step 3
    • These fields are dependent on the Brand and Model of the device and relate to custom features that the model supports and the options here will be different depending on this.

  • Add Model Step 3 Line Keys Wizard - Press the next button for step 4
    • Here is where you can setup your Lines, BLFs, Speeddials and any other buttons that your specific model supports as Line Keys

  • Add Model Step 4 Horizontal Keys Wizard - Press the next button for step 5
    • Here is where you can setup your Horizontal Soft Keys for Models that support changing these Button
    • Some Models support changing the Layouts of the Horizontal Buttons on a per Call State such as On A Call or Hold and others do not.

  • Add Model Step 5 Expansion Modules Wizard - Save Model Button to save your model changes
    • Here is where you can setup and link any Expansion Modules to this Model for Models that support Expansion Modules

Retrieving Provision URL for a Template

  • Once Logged into CDM from the Menu bar click on CDM > Templates


  • From here you can see a list of all the Templates that your login has access to and what Tenant they belong to if you are a reseller where you can see all the Tenants that are under you and manage things.

  • Click on the Binocular icon.  under the Action column to view and edit the details of the Template.   At the top of the Template you will see the full URL that you devices will need to use to receive their provisioning data from CDM.


  • The URL is broken into the following sections. Some devices let you paste in the full URL and others make you break apart the Username, Password and Protocol from the URL
    • exampleusername - is the actual username you setup in the template for provisioning.
    • examplepassword - is the actual password you setup in the template for provisioning.
    • devices.clearlip.com/provision/1155/ is the URL portion of where the phone receives its provisioning data from using the username and password above.

Cloning a Template

  • Once Logged into CDM from the Menu bar click on CDM > Templates


  • Click on the Clone Template button at the top

  • You will be asked what Template you want to Clone and it will create a new Template with the same settings and configurations of the Template you just cloned and let you now go edit that clone to change things.


Extensions Overview

Extensions are where you define the extensions from your PBX and include the Extension name, username and SIP Password for each extension.  Once Extensions are created we can now map Extensions to Specific Templates, Device Models and Locations to build out the configuration file for each Device based on the Devices MAC Address.

Creating new Extensions

  • Once Logged into CDM from the Menu bar click on CDM > Extensions


  • Click on the Add A New Extension button


  • Add Extension Step 1 Basic Wizard - Press the next button for step 2
    • Location - Pick which Location this Extension is tied to
    • Name - Name of this Extension you are creating
    • Number - The Extension Number or on some PBXs known as the SIP User Name
    • Secret - The Extension SIP Password or Secret to register as this SIP Extension
    • Device Count - How many devices can register to this extension.  For example if you set this to 3 than when we setup Device Mapping next CDM will only allow you to map 3 different Device MAC Addresses to this same extension.
    • Description - Friendly Description on what this Extension is.
  • Add Extension Step 2 Review Wizard - Press Add Extension to complete the process of adding this Extension into CDM

Managing existing Extensions

  • Once Logged into CDM from the Menu bar click on CDM > Extensions


  • From here you can see a list of all the Extensions that your login has access to and what Location they belong to. If you are a reseller you can see all the Extensions that are linked to any Location that belong to Tenants that are under you.


  • Click on the Binocular icon.  under the Action column to view and edit the details of the Extension. 

  • Click on the Trash Can icon   under the Action column to delete the Extension

Mappings Overview

Mappings are where we pull in all the information of Locations, Templates, Models and Extensions and map them to specific Device MAC Addresses that are used to provide all the configuration details to the Device when it logs in and request the configuration information.

Creating new Mappings

  • Once Logged into CDM from the Menu bar click on CDM > Mappings

  • Click on the Add A New Mapping button

  • Add Mapping Step 1 Template and Model Wizard - Press the next button for step 2
    • Location - Pick which Location this Device will be linked to
    • Template - What Template are you wanting to use for this Device
    • Select a Model  - Based on what Template you picked above you will be given a list of all the Models that you have setup under that Template that you can pick from.
    • MAC Address - The MAC Address of the device that you are adding.
    • Provisoning URL - Allows you to copy the full Provisoning URL that this device will need to be provided on how to get its configuration file.  This is a Read only field and provided base on the template you picked above.

  • Add Extension Step 1 Mappings Wizard - Press the Add Mapping button to complete the process of adding this device.
    • Registration - Generally this would be set to 1 as the main registration on the device but if you were trying to program the same device to 2 different extensions you may pick a different registration for this device.
    • Extension - Which Extension we are mapping to this device
    • Device - This is a drop down of which Device Count this mapping will use.  Earlier when we setup the Extension we defined how many devices are allowed to connect to the same extension and here we are just pick one of the free slots.
    • SIP Port - This is the Device local SIP port that you want it to be configured with. Normally this would be left at 5060
    • Transport Type - This would be the Transport Type the Device should be setup to communicate with the PBX.
    • Media Type - This would be the Media Type the Device should be setup with based on the PBX.
    • Remote Phone - If this is checked this will tell the phone to use the"Primary Remote Host" host of the Location versus the default Primary Local Host.
    • Add/Remove - This allows you to map an additional Extension to the Device on an additional Registration such as Registration 2.  This is only used when you are trying to have a single Device register as different extensions on the same device.

Managing Mappings

  • Once Logged into CDM from the Menu bar click on CDM > Mappings


  • From here you can see a list of all the Mappings that your login has access to.  If you are a reseller you can see all the Mappings that are linked to any Location that belong to Tenants that are under you.

  • Click on the Binocular icon.  under the Action column to view and edit the details of the Mapping. 

  • Click on the Trash Can icon   under the Action column to delete the Mapping

Custom Config Overview

Custom Config is for advanced users. It exposes all the config options for each model of phone that you have setup and lets you change or set any Custom Config setting that the Device supports.  This is used mainly to set custom settings for a Device for a setting that is not exposed in the Template of a Device.  You will need to understand your Devices configuration structure and options as each manufacture has their own way of handling configuration files and options within those files.

Modifying a Custom Config

  • Once Logged into CDM from the Menu bar click on CDM > Custom Config


  • From here you can see a list of all the Models that your login has access to.  If you are a reseller you can see all the Models that are linked to any Template that belong to Tenants that are under you.


  • Click on the Config Icon  under the Action Column for the Model that you would like to modify the Custom Config on.

  • From here a text editor will be opened and you can start modifying the configs of anything you need to change.


  • Press the Save Custom Config button at the bottom of the page.  You will now need to reboot your phones that are mapped to this Model to have them update their config.








     RSS of this page