.. _add_subscribers:


.. rst-class:: chapter-with-expand

Add Subscribers
---------------

.. _20.1.1|EKB-4471:
.. _20.1.1|VOSS-687|EKB-4500:
.. _19.3.3|VOSS-687|EKB-4500:
.. _19.1.1|EKB-143:
.. _19.1.1|EKB-792:
.. _18.1-Patch-Bundle-2|EKB-143:
.. _18.1-Patch-Bundle-3|EKB-426:
.. _18.1.2|VOSSSOL-12465:
.. _18.1-Patch-Bundle-3|VOSSSOL-9527:
.. _21.1|VOSS-790:
.. _21.1|EKB-9816:


Use this procedure as a high-level workflow to add one or more subscribers
in VOSS-4-UC.

.. note::

   If Enable CSS filtering is enabled at the customer dial plan, then for all
   calling search space fields in this procedure, the list of available calling
   search spaces includes only those that are marked as a Class of Service under
   **Dial Plan Management > Site > Class of Service** at the particular site. If
   another CSS is required, you can add custom CSSs in a CSS field if you know
   the exact syntax.
   
   If Enable CSS filtering is not enabled, then the list of available calling
   search spaces includes all CSSs that are configured on VOSS-4-UC. [#]_

1. Log in as customer or site level administrator. If you are logged on as the
   customer administrator for a specific site you can see all the fields
   described in this procedure. If you are logged in as the site administrator,
   you can see a subset of the fields that are available on the interface.
2. On the **Subscribers** form, click **Add**.
3. Choose the site to which you want to add the subscriber (only required if logged
   in as a customer administrator).
4. Configure the details on the following tabs (see below).
5. When you are finished adding information for the subscriber, click **Save**.
6. Repeat steps 2 to 5 to add another subscriber.


User
....

On the **User** tab, complete fields to add a Unified CM user and a VOSS-4-UC user.

Consider the following when adding a user:

* Use only alphanumeric characters.
* A selected Entitlement Profile will be associated with the Subscriber.
* The options available in the **Service Profile** drop-down menu are those that
  were imported from Unified CM.
* If an existing phone is to be associated with a user, choose the device from
  the **Associated Devices** group.
* After an existing phone is associated to the user in the **Associated Devices**
  group **Device** drop-down menu, click **Save**. The subscriber is updated so that
  the **Phones** tab is populated with the information of the new phone associated
  with the user.
* If the added user is configured as an LDAP user, the **Password** and **Repeat
  Password** fields are hidden. The **Enable Mobility** check box is auto-selected
  if any of the following are included or added: a remote destination phone,
  mobile identity for a phone, or remote destination profile (RDP).

  If subscriber self-provisioning has been set up so that subscribers
  can add their own smart devices (Company Phones *or* Personal Phones) and the
  **Enable Mobility** check box is *not* selected, then the setting will be enabled
  when subscribers add a smart device (Company or Personal Phone)
  on the Self-service interface.
* If the subscriber is entitled to use Webex Teams, you can add a standalone Webex
  Teams user by completing (at a minimum), the **Userid**, **Last Name** and
  **Email Address** fields and then going straight to :ref:`add_subscribers` (Webex Teams tab).

  Note:

  To enable Extend and Connect in VOSS-4-UC, complete the following task:

  1. Select the **Enable Mobility** check box.
  2. Add the following three groups of users:

     a. Standard CCM End Users
     b. Standard CTI Enabled
     c. Standard CCM Admin User

* If a Customer is configured for EMCC, and if you want the subscriber to have 
  access to the EMCC feature, select the **Enable EMCC** check box.
* Choose a **BLF Presence Group** for the subscriber from the drop-down.
  The chosen group specifies the destinations that the subscriber can monitor
  and is configured in Cisco Unified Administration.
  BLF Presence Group authorization works with BLF Presence Groups to allow or
  block presence requests between groups. The Busy Lamp Field default is set
  according to the selected number and specifies the Standard Presence Group
  that is configured with installation.
* Choose the Primary Extension for the subscriber by choosing from the **Pattern**
  drop-down list, which includes all lines available to the subscriber. The selected
  option is displayed in the Primary Line column for the subscriber on the **Subscribers**
  list view.
* The Subscriber Language and Role can be set in the Site Defaults of the 
  site hierarchy that the subscriber belongs to. If not set in the Site Defaults,
  hierarchy defaults apply.


Phones
......

On the **Phones** tab, click Phones **Add** and complete the required fields to
add a new phone.

Consider the following when adding a phone:

* Modify the values for the following fields if desired: **Product Type**, **Device
  Protocol**, **Phone Button Template**, and **Device Security Profile**. The possible
  value options for these fields change depending on which associated fields are
  selected.
  
  For example, when you enter the **Device Name** with the product prefix and the
  MAC address, 79XX-type phones have the device name 'SEP' prefixed, while ATA-type
  phones have 'ATA' prefixed to the MAC address. 
  Fields are validated and tooltips are available to assist you to select the
  **Product** type.
  
  You can override the default Phone Button Template value by selecting from the
  **Phone Button Template** drop-down, or by entering a custom value in the **Phone
  Button Template** field. The entered value will be applied on Unified CM if the
  Unified CM allows it for that phone type.
     
* Modify phone-specific settings such as **DND Option** drop-down menu, **Do Not
  Disturb** check box, and **Hot Line Device**. The phone settings that are available
  differ depending on the product (phone) type selected, the device protocol (for
  example SIP or SCCP), and the Field Display Policy (FDP) applied by the
  administrator.
  You can select a Mobile User ID Name from the drop-down list when a Dual-Mode
  Phone for Android or iPhones is selected. This associates the selected user to
  the Mobile Identity feature on this phone and must match the Userid added on
  the **User** tab.
* The advanced settings fields are updated automatically for the phone based
  on the phone type. The phone is automatically associated to the user and is
  then displayed as an associated device when you view the subscriber after
  adding it. If a phone that has been associated with a user is also associated
  with another user, the Owner User ID defaults to the first user.
* In the **Line** section, complete line assignments.

  * The **Pattern** drop-down list only shows lines with status 'Available' or
    'Used'.
  * When you select a **Route Partition Name**, the available **Pattern** options
    are filtered according to the selected partition. However, you can add a custom
    pattern by typing it into the **Pattern** field.
  * The associated **Enduser** field identifies the user for Presence, but you
    can add a new User ID. VOSS-4-UC adds the user first and then adds the User ID.
* In the **Speeddial** section, add speed dial information. Available speed dials
  depend on the Phone Button Template.
* In the **Busy Lamp Field** section, specify Busy Lamp Field values. Fields include:
  **Position**, **Label**, **Blf Destination**, and so on.  
* In the **Blf Directed Call Park** section, specify Busy Lamp Field Directed
  Call Park values. Values depend on a valid Directed Call Park on Unified CM.
* In the **Add On Module** section, specify Add On Modules if desired. The specified Add On Module
  **Model** selected must be supported by the specific Phone Type. **Load Name** should be left
  blank unless the default value should be overridden.
* In the **Service** section, add services that are valid IP services for Phones.
  To add a service to the device, a number must be added as the Uri Button index.
  If you do not add a number, only the service is added.
* Use the **Mobile Identity** section to configure mobile identity details when you
  select a Dual-Mode Phone. Fields include: **Name**, **Dual-Mode Device** 
  (automatically populated from the **Device Name** field), and **Mobility Profile** 
  (chosen from a drop-down list). The **Destination Number** field is a mandatory
  field and determines the destination number that is dialed when a call is
  made to the dual-mode phone.
* Use the **Remote Destination** section to configure your remote destinations
  when a Dual Mode Phone or Cisco Spark Remote Device is selected as the
  **Product**. Remote destinations represent the mobile (or other) phones that
  are able to accept transfer from the desktop phone and can be used to initiate
  calls. Set the Pattern for the Line Association to the Route Partition name.
  If you enter more than one Pattern and the new Pattern is not on the system,
  enter the Route Partition Name manually. The **Owner User Id** and **Dual Mode
  Device Name** fields are auto populated.
  
  .. note:: 
  
     When a CTI Remote Device is selected as the **Product**, a **CTI Remote Destination**
     section replaces **Remote Destination**. This allows you to configure your
     remote destinations specifically for a CTI Remote Device. The **Owner User Id**
     and **CTI Remote Device** fields are auto populated.  
  
* Use the **Vendor Config** section of the tab to view and edit the configuration
  settings for each device. The available configuration settings depend on
  each Product type selected. Modify settings as required.


  Note that:
 
  1. The administrator password from the ``AdminLoginDetails`` in Unified CM is not stored 
     in VOSS-4-UC. Data in VOSS-4UC is obtained from Unified CM.
  2. VOSS-4-UC cannot disable the ``Override Enterprise/Common Phone Profile Settings``
     setting once this check box has been enabled in the Unified CM GUI.

     This setting needs to be disabled on Unified CM if the user 
     wishes to disable it.


Extension Mobility
..................

On the **Extension Mobility** tab, complete fields to configure extension mobility
for the subscriber.

Consider the following:

* Only one EM Profile can be added for extension mobility in VOSS-4-UC. If
  a subscriber is associated with more than one EM profile on the Unified CM,
  and you sync with VOSS-4-UC, both will be displayed:
  
  * on the subscriber's EM tab (this tab)
  * on the **Extension Mobility** list view (see :ref:`standalone-extension-mobility`).

* As with the **Phones** tab, **Product**, **Protocol** and **Phone Button
  Template** fields change, depending on the selection of an associated field.
  
  The considerations regarding the fields on this tab are the same as on the
  **Phones** tab with the exception of remote destination information, which is
  not available on extension mobility (see *Consider the following when adding a
  phone* under **Phones** above).
* Ensure that you associate the extension mobility profile and target
  phone for login with the extension mobility service.
* If the Enable Extension Mobility Cross Cluster (EMCC) feature is enabled on
  the **User** tab, you must choose a CSS for this device from the **Extension
  Mobility Cross Cluster CSS** drop-down. The selected CSS is used as the device
  CSS that gets assigned to the phone when the user logs in to this remote phone.
  New CSS's or existing CSS's can be added or modified in Unified CM. Refer to
  the Cisco Unified Communications Manager Features and Services Guide for more
  details if required.
  
See also :ref:`standalone-extension-mobility` to add or edit an extension mobility
profile, and associate it to one or more subscriber.



Single Number Reach
...................

On the **Single Number Reach** tab, note that you cannot add more than one
Remote Destination Profile for Single Number Reach. However, you can add more
than one Remote Destination Rdp.

Note:

To enable Extend and Connect in VOSS-4-UC, make sure to complete the following
task:

1. Select the **Enable Extend and Connect** check box.
#. Select the CTI remote device that you created from the **CTI Remote Device
   Name** drop-down list.
   
  
Voicemail
.........

On the **Voicemail** tab, configure voice mail service for the subscriber if a
valid Cisco Unity Connection server is available.

Consider the following when configuring voice mail:

* You can leave the PIN and Password empty, in which case the default
  credential policy on the Cisco Unity Connection is used.
* If the user on Cisco Unity Connection is LDAP integrated, the **Password** field
  is visible but should be ignored.
* The **Voicemail Line** drop-down list only shows lines with status 'Available'
  or 'Used' that are not already configured for Voicemail. The Cisco Unity
  Connection server uses this line as a caller ID, so you should set it to the
  subscriber's default line.
* When Voicemail is added for a Subscriber, all **Call Forward To Voicemail** check
  boxes, except **Call Forward All**, will be enabled on the chosen Line, and the
  Voicemail Profile setting will be set based on the Site Default Doc setting
  "Default CUCM Line Voicemail Profile" (**Site Management > Defaults > Line Defaults**). 

   

WebEx
.....

On the **WebEx** tab, add details if a valid server is available. The mandatory
fields on this tab are populated with the values entered on the **User** tab.

.. Note::

   Any updates on the **User** tab do not update these values; values are populated
   only during the Add workflow.



Webex Teams
...........

On the **Webex Teams** tab, click Webex Teams User +, and select the check boxes
to select the desired Enabled Services and Roles for the subscriber: 
    
Consider the following:
    
a. Webex Teams is only available if a Webex Teams Service has been created at the required
   customer level (see :ref:`create-webex-teams-service`), and if the **Webex Teams**
   check box has been selected in the Entitlement Profile associated to the Subscriber.
#. The Webex Teams User fields, **Login Enabled** and **Invite Pending** check boxes are
   read-only and can not be edited.
#. "Enabled" is displayed in the Webex Teams column on the **Subscribers** screen next
   to the subscriber once successfully added as a Webex Teams user.
#. The Subscriber e-mail address is required to enable Webex Teams for the Subscriber.


Pexip Conference
.................

On the **Pexip Conference** tab, click **Pexip Conference +**, and enter the fields
required to configure the Pexip service for the subscriber.

Consider the following:

* The **Pexip Conference** tab is only available if a Pexip Conference service has 
  been configured at the required hierarchy (via the Quick Add Subscriber Group).
* Entitlement Profile: the **Conferencing** check box has been selected and
  associated to the Subscriber.
* "Enabled" is displayed in the **Conferencing** column on the **Subscribers** list
  view next to the subscriber once successfully added as a Conferencing user.
    


Contact Center Subscriber
.........................

:ref:`UCCX-Feature-Reference`


The Subscriber feature supports adding, removing or updating CCX agent capabilities to a Subscriber.

The **Contact Center** tab is only available if:

* CCX device has been added and is available to the hierarchy.
* Contact Center Service has been configured and is available to the hierarchy.
* Entitlement Profile: the **Contact Center** check box has been selected and associated to the Subscriber.
    
Consider the following for the Agent:
    
* Since CCX restricts the use of special characters, these are restricted in the **Alias**.
* **Team**, **Resource Group** and **Skill** names need to be set up or synced from
  the CCX device before they can be assigned.
* **Automatic Available** is enabled by default.
* An IPCC extension is automatically managed for the Unified CM user associated with
  the Contact Center Agent.
* It is possible to change the the agent’s **Controlled Device**. The device in question
  must already be associated with the Subscriber before attempting to set or change it.


.. [#] This only applies to the VOSS-4-UC *Provider* deployment.