.. _replace-phone-overview:

Replace phone
-----------------

.. _21.3|EKB-10424:
.. _24.1|EKB-15928:
.. _24.1|EKB-18918:



.. note::

   This software release currently only fully supports the replacement of an
   existing desk phone type with any other desk phone type.


.. tip:: 

   :ref:`use-action-search-to-navigate-automate`


Overview
.........

You will need to replace a phone when choosing a new phone for a user or when a 
phone type is no longer supported. 

The feature provides an easy way to replace an existing (old) phone with a
different phone model, while retaining as much of the old phone's configuration
as possible. 

Phone replace does the following: 

* Copies the old configuration 
* Deletes the old phone
* Adds the replacement (new) phone along with the old configuration
* Updates user information to reflect the change in the controlled devices

.. note::

   * Speed dial, Busy Lamp Field (BLF), Blf Directed Call Park, and Services settings are
     *not* copied from the old phone configuration. Configure these settings manually
     on the appropriate tab on the replacement phone **Phones** screen if required.
     See "Configure Phones".
   
   * If the new phone has attributes that weren't present on the old phone, you
     must manually set the required values if the default values are not appropriate.
     Alternatively, you can select an optional configuration template, which will
     override the configuration copied from the old phone as well as any manual
     settings.

If you need a customized Phone Template, a default template can be cloned, renamed,
and modified via the **Configuration Templates** page. The new 
customized template is then available in the **Phone Button Template** drop-down of the Replace Phone
feature.

The ``Replace Phone Template Variable`` template is available to allow for the option
of manual input of the following fields:

* ``phoneTemplateName``
* ``product``
* ``protocol``
* ``securityProfileName``

.. note::

   When using this template, *only* these fields are configured by the template.      

See "Configuration Templates" for more details if required.



.. rubric:: Related Topics 

* :ref:`ini-reserve-for`


.. _using-replace-phone:

Replace a phone
................


To replace a phone: 

1. Log in as Site administrator or higher.

#. Go to **Replace Phone**. 
#. Choose the relevant site (where you want to replace a phone). 

   .. note:: 

      You can only replace a phone at the Site level. 

#. On the **Existing Phone** tab:

   a. At **Device Name**, select the phone you wish to replace. 
      
      .. note:: 
         
         * Other fields on this form are read-only. 
         * When choosing a phone name, you can configure (via the **Phones** tab in the **Global Settings**), 
           how phone names display in this field. For example, the drop-down may 
           list phones by their description only (default) or by first line only, or by description 
           plus first line. At this drop-down, you can search for the phone using relevant criteria, for example, 
           first letters of a description or line numbers (depending on the Global Setting for phone 
           display).  

#. On the **Replacement Phone** tab:
   
   a. Enter the **Device Name** of the replacement phone (mandatory).
   #. Optionally, choose a **Phone Template** for the replacement phone.    

      .. note::

         Values in the phone configuration template you choose will override attributes 
         copied from the original phone, and any additional, manually applied 
         settings in the rest of the fields on this tab.
   
   #. Choose the **Product** (phone model) of the replacement phone (mandatory). 
   
      .. note:: 
         
         If the existing phone was associated with an entitlement profile, the 
         replacement **Product** drop-down only displays phone types that are allowed
         by the entitlement profile.
   #. Choose the **Device Protocol** (mandatory).
   #. Choose a **Phone Button Template** value for the replacement phone, if one is
      available (optional).
   #. Choose the **Security Profile** for the replacement phone (mandatory).
   #. Enter a **Description** for the phone (optional).

5. Click **Save**. View transaction progress and details in the Transaction Logs. 
   See Transaction Logging topic. 



.. rubric:: Related Topics

* 
  .. raw:: latex
  
     Global Settings in the Core Feature Guide.

  .. raw:: html

     <a href="concepts-global-settings.html">Global Settings</a>

* 
  .. raw:: latex
  
     Transaction Logging and Audit in the Core Feature Guide.

  .. raw:: html

     <a href="concepts-transaction-logging-audit.html">Transaction Logging and Audit</a>




.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM