.. _quick-add-subscriber-cucm-users:
Quick Add Subscriber (Cisco)
-----------------------------
.. index:: Quick Add Subscriber (Feature)
:bdg-primary:`Cisco`
.. _19.2.1|VOSS-630|EKB-1208:
.. _19.2.1|VOSS-630|EKB-1210:
.. _19.3.1|VOSS-577:
.. _21.3|EKB-10424:
.. _21.3-PB1|EKB-12278:
.. _21.3-PB2|EKB-12677:
.. _21.4|VOSS-1061:
.. _21.4-PB2|EKB-16245:
.. _21.4-PB4|EKB-16760:
.. _21.4-PB5|EKB-18840:
.. _24.1|EKB-18255:
.. _24.1-PB2|EKB-21316:
Overview
.........
Quick Add Subscriber (QAS) for Cisco Unified Communications Manager (CUCM)
provides a single page where you can add a CUCM user as a subscriber with a line, and a voicemail and Webex account,
and provision the subscriber with services such as voice, extension mobility, single number reach (SNR), and conferencing
and collaboration services.
.. important::
QAS is a simple, generic method for provisioning subscribers that
applies single values from configuration templates (via Quick Add Groups), and the site defaults.
For more complex provisioning requirements, such as adding route partitions or multiple values for
other service fields (such as two or more lines), use VOSS Automate's advanced subscriber management functionality
(default menus: Subscriber Management > Subscriber), or bulk loaders. For example, you could use QAS to add subscribers with only the first line on phones, then use advanced
subscriber management to add the second line to the phone.
For details around how QAS handles the application of a Line configuration template
associated with a selected Quick Add Group (QAG) when adding or updating a
subscriber, see :ref:`shared-lines`.
.. rubric:: Supported User Types
QAS for CUCM users supports several user types, including:
* LDAP users
* CUCM-integrated users
* LDAP-integrated users on CUCM
* Manually created users
.. note::
If the default Self-service Language is set on the site default docs (SDD), users are assigned
the corresponding Self-service language.
.. image:: /src/images/quick-add-subscriber-cucm.png
.. rubric:: Related Topics
* :ref:`provision-webex-app`
* :ref:`quick-add-subscriber-device-pool`
* :ref:`quick-add-subscriber-class-of-service`
* :ref:`provision-the-voice-service`
* :ref:`quick-add-subscriber-group-default-model`
* :ref:`concepts-config-templates`
* :ref:`expose-class-of-service-on-QAS`
* :ref:`qas-webex-teams`
* :ref:`provision-the-extension-mobility-service`
* :ref:`provision-the-voicemail-service`
* :ref:`provision-the-pexip-service`
* :ref:`provision-the-jabber-device-service`
* :ref:`provision-contact-center-agent`
* :ref:`enable-self-provisioning`
*
.. raw:: latex
Global Settings in the Core Feature Guide.
.. raw:: html
Global Settings
*
.. raw:: latex
Introduction to Entitlement in the Core Feature Guide
.. raw:: html
Introduction to Entitlement
.. _qas-configuration:
Configure Quick Add Subscriber
.........................................
.. index:: Quick Add Subscriber (Feature);Feature Configuration
To create or configure users, to enable users with services, or to associate
users with devices, configure the following items on the system:
.. tabularcolumns:: |p{5cm}|p{10cm}|
+--------------------------------+-------------------------------------------------------------+
| Configuration | Description |
+================================+=============================================================+
| 1. Configure servers | Configure the following servers in VOSS Automate: |
| | |
| | * Cisco Unified Communications Manager (CUCM) server |
| | |
| | Adding a CUCM server allows the following: |
| | |
| | * Syncing of manually provisioned users or |
| | LDAP-integrated users in CUCM to VOSS Automate |
| | * Syncing in of users phones, directory numbers, |
| | extension mobility profiles in CUCM to VOSS Automate |
| | * Creation of subscribers (push users to CUCM) |
| | * Pushing of users' associated phones, directory numbers, |
| | and extension mobility profiles, to CUCM. |
| | |
| | * LDAP server |
| | |
| | Required only if you want to configure LDAP-synced users |
| | in VOSS Automate, else, optional. |
| | |
| | * Cisco Unity Connection (CUC) server |
| | |
| | Required only if you want to add CUC voicemail users that |
| | are configured in VOSS Automate. |
+--------------------------------+-------------------------------------------------------------+
| 2. Configure dial plans | Provider deployment only. Configure a dial plan at both the |
| | customer and site hierarchies. |
+--------------------------------+-------------------------------------------------------------+
| 3. Configure voicemail service | Deploy voicemail service with a pilot number created and |
| | associated to a site in VOSS Automate (via **Services > |
| | Voicemail**). This step is required to create a "Default |
| | CUC Subscriber Template" (via **Site Defaults > CUC |
| | Defaults**. The template is required to create CUC |
| | voicemail users. |
+--------------------------------+-------------------------------------------------------------+
| 4. Configure Webex service | Configure a Webex Server in VOSS Automate to deploy any |
| | Webex users provisioned through QAS. Set a password for |
| | Webex users in the Site Defaults. |
+--------------------------------+-------------------------------------------------------------+
Enabling Services in Quick Add Subscriber
...............................................
When adding a subscriber via Quick Add Subscriber (QAS), you can enable
user services, such as voicemail, extension mobility, single number reach, conferencing (meetings),
and collaboration (messaging) services (such as Webex App).
The QAS page displays services included in a selected entitlement profile (if entitlement profiles are used).
For example, if the entitlement profile excludes voice services, the checkboxes for
Voice, Jabber, and Self Service ID won't appear on the page. The selected entitlement profile also
filters options available in the **Phone Type** drop-down (showing only devices enabled
in the entitlement profile).
.. note::
It is possible to use QAS to add a subscriber without an entitlement profile. For example,
entitlement profiles may not exist on the deployment, or they may not be associated with the subscriber.
In this case, a phone type, for example, may still be associated with the subscriber via the
Quick Add Group (QAG).
For the Voicemail service:
* Configuration settings are only available if the site's SDD has a
default value on the CUC Defaults tab for the Default CUC Subscriber Template.
The default value (``voicemailusertemplate``) should already exist on the CUCM
and is automatically populated on an HCS system when a voicemail pilot is created.
* A CUC device must be configured at the related Network Device List (NDL), at site level.
* If the selected QAG specifies any CFT entries for UserPin or UserPassword,
these are applied. Otherwise, the values from the User Template defined on CUC
apply. For default CFTs, see: :ref:`quick-add-subscriber-group-default-model`.
While the Admin Portal hides configuration settings for unavailable services, API and bulk load
operations have provisioning workflow checks that check for the presence of the Default CUC User Template
in the SDD and a configured Webex server in the NDL, before the selected services can be added.
A CUCM (call manager) must be configured at the subscriber's hierarchy. If this does not exist, the
QAS bulk load transactions and API calls display the following warning: *No Call Manager has been configured*
Add a User via Quick Add Subscriber
...........................................
This procedure adds a CUCM user via Quick Add Subscriber (QAS).
.. rubric:: Before you start
* To choose phones by their description or description and line, configure the Phones tab in the
Global Settings for displaying additional information.
* The default user template (``voicemailusertemplate``) must exist on CUCM. You can update the
default by editing the default CUC User Template value in the SDD.
* Configure Quick Add Groups. See :ref:`quick-add-subscriber-groups`
.. note::
For details around how QAS handles the application of a Line configuration template
associated with a selected Quick Add Group (QAG) when adding or updating a
subscriber, see :ref:`shared-lines`.
* If required, expose device pools and Class of Service (CoS) in QAS. See :ref:`expose-class-of-service-on-QAS`
* Ensure the site defaults are correctly configured.
.. rubric:: To add a user in QAS
1. In the Admin Portal, go to (default menus) **Subscriber Management > Quick Add Subscriber**.
.. note::
* You can switch between a tab or panel layout on this form.
* You'll configure details for the user on the **Users** tab/panel. On this tab/panel,
LDAP-synced or LDAP-integrated at CUCM user fields are read-only.
* The **Existing Services** tab/panel displays devices and services associated with the user you choose.
If the user has existing dual mode devices, the **Phones** field includes details for
mobile identity, remote destination, andd CTIRD remote destination.
* Fields that display on the **Existing Services** tab/panel are associated with services that are
enabled/disabled at the customer level via the Global Settings.
2. On the **User Details** tab/panel, configure the following:
* Select the username.
* If the username you require doesn't exist at the current site, select **Include users at higher hierarchy**
to add users above the current site.
.. note::
* You can only edit existing CUCM users via QAS if these users exist at site level.
* The field associated with this checkbox (``lookUpForUser``), is hidden
by default. You can expose it via a custom field display policy. This setting is
also available for bulk load sheets and API calls.
* To prevent adding users that don't exist on CUCM, select **Fail Transaction if user not found**.
.. note::
The field associated with this checkbox (``failIfNotFound``) is hidden by default.
You can expose it via a custom field display policy.
By default, the transaction won't fail. This option is used when users have not been synced from
LDAP to CUCM. This setting is also available for bulk load sheets and API calls.
* Fill out a first name and a last name (mandatory).
.. note::
First name is mandatory only if you're provisioning the user with a Webex account.
You can set only one Webex account per user. The first name and last name is auto-populated
as a display name on the Webex user record. The display name is used when making Webex calls.
* Fill out an email address, if required.
* To send the user a welcome email, select **Send welcome email**.
.. note::
This checkbox displays only once you add an email address, provided you have the following
enabled and configured:
* SMTP server must be set up (:ref:`SMTP-server`)
* In the Global Settings (Email tab), enable (for the relevant hierarchy)
**Allow email to be sent to user after Quick Add Subscriber**. See :ref:`global-settings`
A welcome email is sent to the subscriber email address using the configured
"Quick Add Subscriber" HTML email template that applies to the hierarchy. See :ref:`email-setup`.
* Fill out a password and PIN.
* Choose an entitlement profile, if one exists, to associate with the subscriber you're adding.
* Choose a Quick Add Group (QAG).
.. note::
* You can configure Quick Add Subscriber Groups via the Quick Add Subscriber Groups menu, or
use the default group.
* The list of available Quick Add Groups are filtered by vendor (see :ref:`quick-add-subscriber-vendor-filtering`),
and are restricted to those available at a selected hierarchy, based on the option selected for **Quick Add Group & Subscriber Profile lookup level** in
the General Settings of the Global Settings. See :ref:`global-settings`.
* Choose a device pool.
* Click the Plus (+) icon at **Lines** to add directory numbers (one or more). Alternatively,
select **Use next available line** to automatically populate the **Directory Number** field
with the next available line. The default for **Use next available line** is False (disabled).
.. note::
You can create a directory number in CUCM in two ways:
* Create a voicemail line in QAS
* Create a line in QAS
When creating a voicemail or voicemail line using QAS, the **Directory Number Used**
field is set to "true" in the directory number inventory (**Subscriber Management >
Directory Number Inventory**.
A directory number created without any device associations (for example, a voicemail line),
is tagged under **Subscriber Management > Lines** as 'DN created without device from QAS.'
* Select relevant services:
.. tabularcolumns:: |p{5cm}|p{10cm}|
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Description |
+===========================+===========================================================================================================================================================================================================+
| Voice | Provisions the voice service. Since you can create multiple devices for a user, this checkbox is always available. Selecting the Voice service displays these additional fields: |
| | |
| | * **Phone Type** (Lists phone types allowed by the entitlement profile, if one exists, else, phone type is retrieved from the QAG) |
| | * **Phone Protocol** |
| | * **Phone Button Template** (You can override the default phone button template value by entering a custom value in this field. However, the new value is only applied on the CUCM if allowed for the |
| | phone type.) |
| | * **Phone Security Profile** |
| | * **Phones** |
| | |
| | Add one or more phones. You can associate a line with multiple phones, and you can associate a phone with multiple lines. The **Phone Name** drop-down lists available phones at the user's site, |
| | based on the phone type specified in the SDD for this site, in the associated QAG at the customer level, or synced from CUCM. To add a new phone, you can enter a valid name in the **Phone Name** |
| | field. The phone name must consist of a prefix, for instance `SEP`, followed by a MAC address (12 hexadecimal characters). The transaction will fail if you enter the phone name incorrectly |
| | (for example, too few or too many characters). |
| | |
| | Choosing alternative options in these fields overrides values set up in the Quick Add Group (QAG), configuration template (CFT), site defaults document (SDD), or any other backend (read-only) CFTs. If |
| | the QAG does not specify a phone template, or if the specified phone template has blank values for the phone fields, the phone field values are pulled from the SDD. To avoid conflicting QAS settings, |
| | it is recommended that you configure settings on the QAS form in the following order: |
| | |
| | 1. Entitlement Profile (only if these exist on the deployment, and are associated with the subscriber) |
| | 2. Quick Add Group |
| | 3. Voice (then choose phone type, phone protocol, phone button template, and phone security profile) |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Extension Mobility | Provisions extension mobility. Only one extension mobility profile per user, so the checkbox displays only until you create an extension mobility profile. |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Voicemail | Provisions voicemail service. |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. tabularcolumns:: |p{5cm}|p{10cm}|
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Service | Description |
+===========================+===========================================================================================================================================================================================================+
| Single Number Reach | Provisions single number reach (SNR) service, and allows you to specify the SNR mobile number. If a mobile number is already configured for a subscriber, it is used to pre-populate the Mobile Number |
| | field when adding SNR for that subscriber. You can enter a different mobile number for SNR, if required. SNR mobile numbers are formatted with a Plus (+) and the number, for example `+99218732876`. |
| | SNR mobile numbers cannot include include spaces, dashes, or other special characters. The SNR mobile number can be the same as the user's number that displays via (default menus) |
| | **User Management > Users**. |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Jabber / Dual-Mode Device | Provisions Jabber / Dual-mode device service, and allows you to add Jabber and Dual-Mode devices. You can associate multiple Jabber and Dual Mode devices to a user. Jabber and Dual Mode devices get the |
| | first line assigned to them (specified in QAS). |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Enable self-provisioning | Defines whether to enable self-provisioning for this user, and allows you to choose the relevant self-provisioning user profile. When enabled, phone lines are added using the Universal Line Template |
| | (ULT) referenced in the selected self-provisioning user profile. When adding a user with lines but no devices, or when adding a user with devices and lines, enabling self-provisioning here |
| | automatically sets the *CUCM User Primary Extension* to the QAS line pattern and ULT route partition. The available self-provisioning user profiles are those found in |
| | (default menus) **User Management > Self Provisioning > User Profile** (and can be seen in the site defaults for the site). You can change this default, if required. |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
3. Save your changes to create the subscriber.
* If you've provisioned SNR (single number reach), verify, on the **Existing Services** tab/panel, that the
**Single Number Reach** field displays the SNR profile name, which is the user name, followed by `\"-RDP\"`.
For example: `jsmith-RDP`.
* If you wish to update a subscriber or their associated services (after adding the subscriber via QAS),
this is done from the relevant service menu items.
* For self-provisioned phones to show as being associated with a subscriber, perform a
CUCM data sync after setting up a self-provisioned phone.
.. _qas-webex-teams:
Add Webex App Service using Quick Add Subscriber
...................................................
.. note::
When using QuickSubscriber to provision WebexApp services,
the SiteDefaultsDoc - **User Defaults** tab values should
be set to either:
* **Webex App - Use Organization's Domain** = True
or
* **Webex App - UC Manager Profile** =
Selecting the **Webex App** checkbox on the QAS page displays the **Webex Teams User Template**
drop-down, where you can select a **Webex Teams User Template** to apply to the user.
* Choosing a template from the drop-down overrides the default user template referenced
in the Quick Add User Group (QAG) associated with the user.
* If you don't select a **Webex Teams User Template** from the drop-down, the **Webex App User
Template** referenced in the associated QAG is applied.
If you want customized values, clone the **Webex Teams User Template**
(**Customizations > Configuration Templates**) and edit as required.
The Webex Teams User Template for CUCM Calling provides for a **Settings** group
of controls for the specification of Calling Behavior and provisioning of
Jabber devices if relevant to the calling behavior.
.. _Contact-Center-Agent-Quick-Add:
Add a Contact Center Agent using Quick Add Subscriber
..........................................................
* :ref:`UCCX-Feature-Reference`
You can use Quick Add Subscriber to create a Contact Center (UCCX) agent.
The **Contact Center Agent** check box becomes visible if:
* The associated Entitlement Profile has Contact Center enabled
* A Contact Center Server is available at the hierarchy - :ref:`contact-center-servers`
* The selected user is not already associated with an Agent
If the check box is selected:
* A **Contact Center Agent Profile** drop-down list is available to
select an agent profile.
.. note::
The **Contact Center Agent Profile** needs to be created before adding
the Contact Center Agent from the Quick Add Subscriber feature.
The agent profile will determine the team, resource group and
skills assigned to the newly created agent. See: :ref:`contact-center-agent-profiles`.
* The **Agent Extension** can be selected.
The extension will be a list of specified Lines, in other words, the administrator must specify
the Line to be created or reused before selecting the **Contact Center** check box.
* The **Agent Device Type** can be selected: either Extension Mobility or Phone:
* If Extension Mobility is selected, the **Extension Mobility** check box is automatically enabled.
* If Phone is selected, the administrator must first enable **Voice** and specify a Phone to be
created or reused before selecting the **Contact Center** check box.
An IPCC extension is automatically managed for the CUCM user associated with
the Contact Center agent.
.. _quick-add-subscriber-device-pool:
Quick Add Subscriber Device Pool
...................................
When adding a subscriber via Quick Add Subscriber (QAS), you can associate a device pool to the subscriber's newly
associated devices or services (other than the device pool provided in the Site Defaults Doc or
referenced configuration template in the Quick Add Group).
A device pool contains system, device, and location-related information, and is
mandatory when adding a subscriber using QAS.
A device pool can be referenced by:
* Site Defaults Doc (SDD)
* Reference Configuration Template (CFT) referenced in the Quick Add Subscriber
Group (QAG)
* Admin Portal (if exposed)
.. rubric:: Device pool and Site Defaults Doc
The device pool referenced in the SDD ensures that a subscriber's devices are
always associated to a device pool. If there is no device pool referenced in
either the QAG or Admin Portal drop-down (see below) the value defaults to the SDD.
.. rubric:: Device pool and Quick Add Subscriber Group (QAG)
The device pool referenced by a Configuration Template (CFT) in the QAG takes
precedence over the device pool referenced in either the SDD or the Admin Portal
drop-down (if exposed). See Quick Add Subscriber Groups for details.
.. rubric:: Device pool and Admin Portal
An administrator can expose a **Device Pool** drop-down on the QAS page on the Admin
Portal by editing or cloning the Field Display Policy.
See :ref:`expose-class-of-service-on-QAS`. The **Device Pool** drop-down allows an
administrator to overwrite the value in the SDD by selecting a custom device pool
from the drop-down list. The options available in the list are the site-level
device pools if they are available, otherwise it displays all device pools
available at customer level (NDLR aware).
.. note::
When exposing the **Device Pool** drop-down, the administrator **must** remove the
value in the **Device Pool** field of the CFT referenced in the QAG, that is, the
field must be blank. This is done to ensure that the value in the CFT does
not overwrite the custom value in the drop-down.
The CFTs and their target models for which the device pool name can be made
blank to allow the Portal to drive the device pool selection include:
* Phone templates (device/cucm/Phone)
* Jabber device templates (device/cucm/Phone)
* Remote Destination Profile templates (device/cucm/RemoteDestinationProfile)
.. _quick-add-subscriber-class-of-service:
Quick Add Subscriber Class of Service
........................................
With Quick Add Subscriber (QAS), you can associate Calling Search Space (CSS) values to a subscriber's newly associated
lines, devices, or services (other than the CSS's provided in the Site Defaults Doc or referenced
configuration template in the Quick Add Group), by selecting a Class of Service (CoS).
A Class of Service (CoS) allows you to specify a Calling Search Space (CSS)
for devices and lines. A CSS is mandatory for lines and
devices when adding a subscriber using QAS.
A CSS can be referenced by:
* Site Defaults Doc (SDD)
* Reference Configuration Template (CFT) referenced in the Quick Add Subscriber
Group (QAG)
* Admin Portal, via the Class of Service field (if exposed)
.. rubric:: Class of Service and Site Defaults Doc
The Calling Search Space values referenced in the SDD ensure that a Subscriber's
lines and devices always have a Calling Search Space associated to it. If there are
no Calling Search Space values referenced in either the QAG or via the Class of
Service field in the Admin Portal drop-down (see below) the value defaults to the SDD.
.. rubric:: Class of Service and Quick Add Subscriber Group (QAG)
The Calling Search Space values referenced by a Configuration Template (CFT) in the
QAG take precedence over the Calling Search Space values referenced in either the
SDD or the Class of Service via the Admin Portal drop-down (if exposed). See Quick
Add Subscriber Groups for details.
.. rubric:: Class of Service and Admin Portal
An administrator can expose a **Class of Service** drop-down on the QAS page on the
Admin Portal by editing or cloning the Field Display Policy.
See :ref:`expose-class-of-service-on-QAS`. The **Class of Service** drop-down allows
an administrator to overwrite the Calling Search Space values in the SDD by
selecting a custom Class of Service from the drop-down list. The Class of Service,
in turn, contains a custom Calling Search Space for lines and devices,
respectively. The options available in the list are the customer-level Class of
Service instances, as created by the relevant administrator.
.. note::
When exposing the **Class of Service** drop-down, the administrator **must** remove
the values in the Calling Search Space fields of the CFT's referenced in the QAG,
that is, the field must be blank. This ensures that the value in
the CFT does not overwrite the custom Calling Search Space value as defined in
the selected Class of Service.
The CFTs and their target models for which the Calling Search Space name can be
made blank to allow the Portal to drive the Calling Search Space values include:
* Line templates (device/cucm/Line)
* Phone templates (device/cucm/Phone)
* Jabber device templates (device/cucm/Phone)
* Remote Destination Profile templates (device/cucm/RemoteDestinationProfile)
.. _expose-class-of-service-on-QAS:
Expose Device Pools and Class of Service in Quick Add Subscriber
....................................................................
This procedure exposes the **Device Pools** field and **Class of Service (CoS)** field
on the Quick Add Subscriber (QAS) form, at a specified hierarchy.
**Pre-requisites**:
* You must be logged on as an administrator with access to Field Display Policies (FDP)
**Perform these steps**:
1. In the Admin Portal, go to (default menus) **Customizations > Field Display Policies**.
2. Filter the **Target Model Type** on **view/QuickSubscriber**.
3. Choose an option, depending on the hierarchy where the **Device Pools** or **Class of Service** fields
should be exposed in Quick Add Subscriber:
* The FDP exists at the correct hierarchy? Click on the FDP to open it.
* The FDP does not exist at the required hierarchy? Clone one of the FDPs at a hierarchy above
the required hierarchy.
4. Open the FDP to edit it, and go to the first group's **Available** list in the **Fields** block.
5. Select **device_pool** or **class_of_service**, then click the **Move** icon to
move the **device_pool** or **class_of_service** from the **Available** list to the **Selected** list.
6. Use the **Move up** and **Move down** icons to move the label to the desired position relative the the other field labels.
7. Ensure that the cloned FDP name is "default", then click **Save**.
8. If you're at the hierarchy where the cloned FDP is created or at a lower hierarchy,
go to (default menus) **Subscriber Management > Quick Add Subscriber**, where you will see the
relevant field exposed (either **Device Pools** or **Class of Service**).