[Index]

Model: view/QuickSubscriber

Quick Add Subscriber

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Quick Add Subscriber (QAS) provides a single page where you can:

QAS supports many user types, including:

If the Default Self-service Language is set on the SDD, users will be assigned the corresponding Self-service language.

A Quick Add Group (QAG) is a collection of templates that configure the subscriber features, and is mandatory when adding a QAS.

Note

For self-provisioned phones to show as being associated with a subscriber, perform a Cisco Unified Communications Manager Data Sync after setting up a self-provisioned phone.

Any modifications of the added subscriber and associated services are done from the respective service menu items.

The Quick Add Subscriber form allows you to enable user services, such as voicemail, extension mobility, single number reach, and conferencing (meetings) and collaboration (messaging) services (such as Webex Teams). See also, Webex Teams Quick Add. The QAS page only displays services that are included in the entitlement profile you select on this page. For example, if the entitlement profile does not include 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).

For the Voicemail service:

While the Admin Portal hides controls if services are not available, API and Bulk Load operations have Provisioning Workflow checks 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.

If no Unified CM has been configured at the hierarchy that the Subscriber belongs, then Quick Add Subscriber bulk load transactions and API calls will show a warning message: No Call Manager has been configured.

Webex Teams Quick Add

Selecting the Webex Teams 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.

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 Behaviour and provisioning of Jabber devices if relevant to the calling behaviour.

Quick Add Subscriber

Quick Add Subscriber provides a single page where you can:

Quick Add Subscriber supports many user types, including:

If the Default Self-service Language is set on the SDD, Users will be assigned the corresponding Self-service language.

Quick Add Group is a collection of templates that configure the subscriber features. Quick Add Group is required to use Quick Add Subscriber.

Note

To add subscribers using Quick Add Subscriber, a default user template called "voicemailtemplate" must exist on the Unified CM. It is possible, through Dial Plan management, to change this default by editing the Default CUC User Template value in the Site Defaults reference.

For self-provisioned phones to show as being associated with a Subscriber, perform a Cisco Unified Communications Manager Data Sync after setting up a self-provisioned phone.

Any modifications of the added subscriber and associated services are done from the respective service menu items.

The input form on the user interface shows a number of check boxes to enable user services such as Voicemail, WebEx, Single Number Reach, Webex Teams (Webex Teams Quick Add), etc. If the Entitlement profile selected on the Quick Add Subscriber form does not include a particular service, then the check boxes for that service is not available. For example, if the selected Entitlement profile for the Subscriber does not include Voice services, then the check boxes for Voice, Jabber, and Self Service ID will not show on the form. The choice of Entitlement profile will filter the available options in the Phone Type drop-down to show only the enabled devices in the Entitlement profile.

For the Voicemail service:

While the GUI hides controls if services are not available, API and Bulk Load operations have Provisioning Workflow checks for the presence of the Default CUC User Template in the Site Defaults Doc and a configured WebEx Server in the NDL before the selected services can be added.

If no Unified CM has been configured at the hierarchy that the Subscriber belongs, then Quick Add Subscriber bulk load transactions and API calls will show a warning message: No Call Manager has been configured.

Webex Teams Quick Add

If you select the Webex Teams check box, the Webex Teams User Template drop-down is exposed. From this, you can select the Webex Teams User Template to use for the user. This selection overrides the default user template referenced in the Quick Add User Group associated to the user. If a Webex Teams User Template is not selected from the drop-down, selection falls back to the Webex Teams User Template referenced in the associated Quick Add User Group. If you want customized values, clone the Webex Teams User Template (Customizations > Configuration Templates) and edit as required.

Quick Add Subscriber

Full HTML Help

CISCO

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 Shared Lines.

Supported User Types

QAS for CUCM users supports several user types, including:

Note

If the default Self-service Language is set on the site default docs (SDD), users are assigned the corresponding Self-service language.

Related Topics

Global Settings in the Core Feature Guide.

Introduction to Entitlement in the Core Feature Guide

Configure Quick Add Subscriber

To create or configure users, to enable users with services, or to associate users with devices, configure the following items on the system:

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.

  1. Configure dial plans
Provider deployment only. Configure a dial plan at both the customer and site hierarchies.
  1. 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.
  1. 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:

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).

Before you start

To add a user in QAS

  1. In the Admin Portal, go to (default menus) Subscriber Management > Quick Add Subscriber.

  2. On the User Details tab, configure the following:

    Note

    • Devices and services associated with the user display on the Existing Services tab on the QAS form. The visibility of fields associated with existing services in QAS is enabled and disabled at the customer level via the Global Settings. Disabling a service in the Global Settings hides the field associated with the service on the QAS form. To enable and display the service in QAS, enable it in the Global Settings (Enabled Services tab).
    • LDAP-synced or LDAP-integrated at CUCM user fields are read-only.
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.
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. Ensure you do not add any spaces or special characters to the number. 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.
  1. Save your changes. The subscriber is created.

  2. If you've provisioned SNR (single number reach), select the Existing Services tab, then verify that the Single Number Reach field displays the SNR profile name, which is the user name, followed by "-RDP". For example: jsmith-RDP.

    Note

    • If you need 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.

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:

or

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.

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.

Add a Contact Center Agent using Quick Add Subscriber

You can use Quick Add Subscriber to create a Contact Center (UCCX) agent.

The Contact Center Agent check box becomes visible if:

If the check box is selected:

An IPCC extension is automatically managed for the CUCM user associated with the Contact Center agent.

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:

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.

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.

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 Expose Device Pools and Class of Service in Quick Add Subscriber. 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:

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:

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.

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.

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 Expose Device Pools and Class of Service in Quick Add Subscriber. 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:

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:

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:
  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).

Quick Add Subscriber Device Pool

A Device Pool contains system, device, and location-related information, and is mandatory when adding a Subscriber using Quick Add Subscriber. A Device Pool can be referenced by:

Site Defaults Doc

The Device Pool referenced in the SDD makes sure 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 GUI drop-down (see below) the value defaults to the SDD.

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 GUI drop-down (if exposed). See Quick Add Subscriber Group for details.

Admin GUI

An Administrator can expose a Device Pool drop-down on the QAS page on the Admin GUI by editing or cloning the Field Display Policy. See Expose Device Pools and Class of Service in Quick Add Subscriber. 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 make sure 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 GUI to drive the Device Pool selection include:

Quick Add Subscriber Device Pool

A Device Pool contains system, device, and location-related information, and is mandatory when adding a Subscriber using Quick Add Subscriber. A Device Pool can be referenced by:

Site Defaults Doc

The Device Pool referenced in the SDD makes sure 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.

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.

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 Expose Device Pools and Class of Service in Quick Add Subscriber. 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 make sure 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:

Quick Add Subscriber Conditions (provider deployment)

For details to provision services to users, follow these instructions:

When creating users with the Quick Add Subscriber function, consider these conditions:

Contact Center Agent Quick Add

refer to UCCX Feature Reference

The Quick Add Subscriber feature supports the easy creation of an UCCX agent.

The Contact Center Agent check box becomes visible if:

If the check box is selected:

An IPCC extension is automatically managed for the Unified CM user associated with the Contact Center Agent.

Related Topics

Introduction to Entitlement in the Core Feature Guide

Provision the Extension Mobility Service

Full HTML Help

Overview

In VOSS Automate, enabling extension mobility via Quick Add Subscriber (QAS) creates a device profile for the user on CallManager (the call processing component of CUCM).

A CUCM user device profile may be considered a dummy phone with lines. When the user logs in to a physical phone associated with the CallManager and enters their username and pin, CallManager applies their device profile to the phone (with their line, settings, and extension number), effectively assigning ownership of the phone to the user for the period they're logged in.

Provided a user is logged in to a physical phone via their device profile username and pin, they're always reachable via the extension number assigned to their device profile, regardless of the physical device they're using. The user's extension number is associated with their device profile and not to a physical device and is thus always 'mobile'.

Related Topics

Introduction to EMCC in the Core Feature Guide

Configuration Templates in the Core Feature Guide

Extension Mobility Profiles in the Core Feature Guide

EMCC and Multi-Cluster CallManager

A large organization (set up at the VOSS Automate Customer hierarchy) may have multiple CallManager clusters (separate CallManager servers in a multi-cluster setup). For example, a CallManager cluster located in London (providing phones and services to the London office), and a CallManager cluster located in New York (providing phones and services to the New York office). In this scenario, CallManager allows inter-cluster calls between these locations; each CallManager has a different IP address, and each has different data (the phones, users, and services, for either London or New York, in this case).

A CUCM administrator configures cross-cluster via the CUCM Extension Mobility Cross Cluster (EMCC) feature settings on CUCM, and in VOSS Automate (via Customer Management > EMCC).

Once configured on CUCM, EMCC may be enabled per user in CUCM, and a EMCC calling search space (CSS) is chosen for the user device profile.

Note

In VOSS Automate, EMCC groups define the clusters and countries to be used together for extension mobility. When saving an EMCC group, VOSS Automate creates the relevant route partitions, device pools, and the CSS related to the countries selected for the EMCC group.

A user enabled for EMCC can use their extension at another location that is part of the cluster. For example, a user can log in to a desk phone in London in the morning, travel to New York, and log in to a desk phone at the New York office when they arrive. Regardless of their physical location, the user remains reachable via the same extension number, provided they're logged in to a physical phone in a connected cluster, using their home cluster device profile username and pin.

Quick Add Subscriber and Configuration Templates

QAS references a selected QAG, which contains a number of configuration templates that define values for various settings. For example, the CUCM user template, or the extension mobility template (which defines the user device profile settings). For example, you can assign to the QAG, a CUCM user template that has Enable Extension Mobility Cross Cluster set to True, so that all subscribers added via QAS with this QAG are automatically enabled for EMCC.

Device Profiles and Extension Mobility Profiles

A CallManager device profile is called an extension mobility profile in VOSS Automate. Device profiles are configured in VOSS Automate via device profile configuration templates. EMCC CSS may be automatically assigned via device profile configuration template.

Assigning Extension Mobility via QAS

  1. Go to Subscriber Management > Quick Add Subscriber, and choose a user from the Username drop-down list.

  2. Select Extension Mobility.

  3. To enable EMCC, select EMCC.

    Note

    The EMCC checkbox displays only if you've selected the Extension Mobility checkbox.

  4. Click Save.

  5. Verify that the extension mobility profile name appears in the Extension Mobility Profiles field on the Existing Services tab.

Note

Extension mobility can also be enabled and inspected via the Subscriber Management list view (click on the subscriber and check the settings on the following tabs: User, Extension Mobility).

Provision the Voicemail Service

Full HTML Help

  1. Choose Subscriber Management > Subscribers. From the Subscribers list, click on the name of the subscriber to be provisioned with voicemail.

  2. Choose the Voicemail tab.

  3. In the Voicemail Account field, click +. The Voicemail Line drop-down appears.

  4. Choose a line from the Voicemail Line drop-down and click OK.

    For details on the workflow, see Voicemail.

  5. Choose Subscriber Management > Quick Add Subscriber, and choose the same user from the Username drop-down list.

  6. Choose the Existing Services tab.

  7. Make sure that the voicemail line appears in the Voicemail Extension field.

Provision Webex Service

Full HTML Help

This procedure enables a subscriber for the Webex service.

  1. In the Admin Portal, go to (default menus) Subscriber Management > Subscribers.
  2. From the Subscribers list, click the name of the subscriber to be provisioned with WebEx service.
  3. Select the WebEx tab.
  4. In the WebEx User field, click the Plus icon (+) to display the Webex configuration fields.
  5. Fill out the following details: First Name, Last Name, Email, Password
  6. In the Privilege section, select relevant Webex privileges.
  7. Click OK.
  8. Go to (default menus) Subscriber Management > Quick Add Subscriber, and choose the same user from the Username drop-down.
  9. Select the Existing Services tab, and ensure that "ACTIVATED" appears in the WebEx field.

Related Topics

Provision the Jabber or Dual Mode Device Service

Full HTML Help

This procedure provisions a subscriber with the Jabber or dual mode device service, using Quick Add Subscriber (QAS).

  1. Go to (default menus) Subscriber Management > Quick Add Subscriber.

  2. From the Username drop-down, choose a user.

  3. Select the Jabber/Dual-Mode Device check box. The Jabber and Dual-Mode Devices field appears.

  4. Click the Plus icon (+) at Jabber and Dual-Mode Devices to expose the Jabber/Dual Mode Agent drop-down and Device Name field.

  5. At Jabber/Dual Mode Agent, choose a device type. The Device Name field is automatically generated as follows:

    1. If no device name exists in the format <device type prefix><username>, then in this format:

      <device type prefix><username>

    2. If device name exists in the format <device type prefix><username> or <device type prefix><username><number>, then in the format:

      <device type prefix><username><random number>

      where <random number> is generated and unique.

    See examples in table below.

    Example Device Type and Device Name Combinations

    For this type of device

    Device Name (automatically generated)

    Format (regex): "[a-zA-Z0-9]{1,15}"

    Android (Cisco Dual Mode for Android) For example: BOTJOHND003938
    CSF (Cisco Unified Client Services Framework) For example: CSFROBWOR77891
    iPad (Cisco Jabber for Tablet) For example: TABRQUENT18947
    iPhone (Cisco Dual Mode for iPhone) For example: TCTPDEVILLI156
    Carrier Integrated Mobile For example: CIMJOHNSMI
    CTI Remote Device For example: CTIJOHNSMI

    For the following Agents, also select the Mobile Identity checkbox to enable Mobile Identity if required:

  6. Click Save.

  7. Go to Subscriber Management > Quick Add Subscriber.

  8. From the Username list, choose the same user.

  9. On the Existing Services tab, ensure that the Phones field displays the Jabber device.

For each device type, a Configuration Template that is associated with the Subscriber's Quick Add Group is used to provision the device. For defaults, see: Quick Add Subscriber Group Default Model.

Note

If a CSF Jabber device type is selected, all lines are associated to the CSF Jabber device by default.

Provision the Single Number Reach Service

Procedure

  1. Choose Subscriber Management > Quick Add Subscriber, and choose the user for whom you want to provision Single Number Reach from the Username drop-down list.

  2. Choose the Single Number Reach tab. The SNR Mobile Number field appears.

  3. In the SNR Mobile Number field, optionally enter the mobile number. Do not add any spaces or special characters to the number.

    The SNR Mobile Number can be the same as the user's Mobile Number shown in User Management > Users.

  4. Click Save.

  5. Choose Subscriber Management > Quick Add Subscriber, and choose the same user from the Username drop-down list.

  6. Choose the Existing Services tab.

  7. Make sure that the Single Number Reach displays the Single Number Reach profile name.

    The Single Number Reach profile name is the user name followed by "-RDP". For example: jsmith-RDP.

Enable Self Provisioning

Full HTML Help

This procedure enables self-provisioning for a subscriber using Quick Add Subscriber (QAS).

  1. Go to (default menus) Subscriber Management > Quick Add Subscriber. From the Username drop-down list, select a user.
  2. Select the Enable Self Provisioning checkbox. The Self Provisioning User Profile drop-down appears.
  3. From the Self Provisioning User Profile drop-down, choose a Self Provisioning User Profile. These were previously created under User Management > Self Provisioning > User Profile.
  4. In the Lines field, click the Plus icon (+) to display the Directory Number drop-down.
  5. Choose a line from the Directory Number drop-down.
  6. Click Save.
  7. Go to Subscriber Management > Subscribers and choose the same user from the Subscribers list view.
  8. Verify that the Self Service and User Profile fields display the same settings as those set in Quick Add Subscriber.

Enhanced INI Filtering

Full HTML Help

If the Enhanced INI Filtering feature is enabled, administrators have access to the Inventory Filter dropdown list menu for lines on the following forms:

The filter would typically be used to show a filtered, shorter dropdown list of directory numbers.

Note

If the Internal Number Inventory (INI) feature is not enabled, Enhanced INI Filtering will not be applied and all the list of numbers are obtained from the device.

The following options are available in the Inventory Filter list:

Quick Add Subscriber Class of Service

A Class of Service (CoS) allows the user to specify a Calling Search Space (CSS) for devices and lines, respectively. A CSS, in turn, is mandatory for lines and devices when adding a Subscriber using Quick Add Subscriber. A Calling Search Space can be referenced by:

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 GUI drop-down (see below) the value defaults to the SDD.

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 GUI drop-down (if exposed). See Quick Add Subscriber Group for details.

Admin GUI

An Administrator can expose a Class of Service drop-down on the QAS page on the Admin GUI by editing or cloning the Field Display Policy. See Expose Device Pools and Class of Service in Quick Add Subscriber. 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 is done to make sure 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 GUI to drive the Calling Search Space values include:

Quick Add Subscriber Class of Service

A Class of Service (CoS) allows the user to specify a Calling Search Space (CSS) for devices and lines, respectively. A CSS, in turn, is mandatory for lines and devices when adding a Subscriber using Quick Add Subscriber. A Calling Search Space can be referenced by:

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.

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.

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 Expose Device Pools and Class of Service in Quick Add Subscriber. 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 is done to make sure 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:

Expose Device Pools and Class of Service in Quick Add Subscriber

Administrators with access to Field Display Policies (FDP) can expose the Device Pools field and Class of Service (CoS) field on the Quick Add Subscriber (QAS) interface at a specific hierarchy.

  1. As an administrator with access to Field Display Policies (FDP), choose Customizations > Field Display Policies.
  2. Filter the Target Model Type on view/QuickSubscriber.
  3. Depending on which hierarchy or hierarchies the Device Pools or Class of Service field should be exposed in QAS:
    1. If the FDP exists at the correct hierarchy, open it.
    2. If the FDP does not exist at the required hierarchy, clone one of the available FDP's on a higher hierarchy to the required hierarchy (use Actions > Clone).
  4. Open the FDP and go to the first group's Available list in the Fields block. Select device_pool or class_of_service.
  5. Click on the Select button to move the device_pool or class_of_service label from the Available list to the Selected list.
  6. Use the Move up and Move down buttons to move the label to the desired position relative the the other field labels.
  7. Ensure that the cloned FDP name is "default", and click Save.

If an administrator is at the hierarchy where the cloned FDP is created or at a lower hierarchy, and then navigates to Subscriber Management > Quick Add Subscriber, a drop-down field with the title: Device Pools or Class of Service is exposed.

Expose Device Pools and Class of Service in Quick Add Subscriber

Administrators with access to Field Display Policies (FDP) can expose the Device Pools field and Class of Service (CoS) field on the Quick Add Subscriber (QAS) interface at a specific hierarchy.

  1. As an administrator with access to Field Display Policies (FDP), choose Customizations > Field Display Policies.
  2. Filter the Target Model Type on view/QuickSubscriber.
  3. Depending on which hierarchy or hierarchies the Device Pools or Class of Service field should be exposed in QAS:
    1. If the FDP exists at the correct hierarchy, open it.
    2. If the FDP does not exist at the required hierarchy, clone one of the available FDP's on a higher hierarchy to the required hierarchy (use Actions > Clone).
  4. Open the FDP and go to the first group's Available list in the Fields block. Select device_pool or class_of_service.
  5. Click on the Select button to move the device_pool or class_of_service label from the Available list to the Selected list.
  6. Use the Move up and Move down buttons to move the label to the desired position relative the the other field labels.
  7. Ensure that the cloned FDP name is "default", and click Save.

If an administrator is at the hierarchy where the cloned FDP is created or at a lower hierarchy, and then navigates to Subscriber Management > Quick Add Subscriber, a drop-down field with the title: Device Pools or Class of Service is exposed.

Model Details: view/QuickSubscriber

Title Description Details
User Details Group Assigned by FDP
  • Field Name: User Details
  • Type: Object
Username *
  • Field Name: User Details.username
  • Type: String
Include users at higher hierarchy Includes users above site level when searching
  • Field Name: User Details.lookUpForUser
  • Type: Boolean
Fail Transaction if user not found used with API to prevent creation of local users where LDAP is in use
  • Field Name: User Details.failIfNotFound
  • Type: Boolean
First Name
  • Field Name: User Details.firstname
  • Type: String
Last Name *
  • Field Name: User Details.lastname
  • Type: String
Email Address
  • Field Name: User Details.email
  • Type: String
  • Pattern: ^([^.@]+)(\.[^.@]+)*@([^.@]+\.)+([^.@]+)$
  • Format: email
Send welcome email Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'
  • Field Name: User Details.send_email
  • Type: Boolean
Password The corresponding CUCM, CUC and WebEx user password will be set with this password
  • Field Name: User Details.password
  • Type: String
  • Is Password: True
PIN The corresponding CUCM and CUC user PIN will be set with this PIN
  • Field Name: User Details.pin
  • Type: String
  • Is Password: True
  • MaxLength: 24
  • Pattern: ^[0-9]*$
Entitlement Profile
  • Field Name: User Details.entitlement_profile
  • Type: String
Quick Add Group *
  • Field Name: User Details.qagroup_name
  • Type: String
  • Target: data/QuickAddGroups
  • Target attr: group_name
  • Format: uri
User status
  • Field Name: User Details.user_status
  • Type: String
Use next available line Use the next available line from the inventory.
  • Field Name: User Details.automatic_line
  • Type: Boolean
Lines
  • Field Name: lines.[n]
  • Type: Array
Inventory Filter Default: default
  • Field Name: User Details.lines.[n].line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers (Site Only)", "Show Unused Numbers", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Directory Number
  • Field Name: User Details.lines.[n].directory_number
  • Type: String
Voice
  • Field Name: User Details.voice
  • Type: Boolean
External Auto Trigger?
  • Field Name: User Details.external_trigger
  • Type: String
Is PhoneType Entitled?
  • Field Name: User Details.phonetype_entitled
  • Type: String
Phone Type
  • Field Name: User Details.phone_type
  • Type: String
Phone Protocol
  • Field Name: User Details.phone_protocol
  • Type: String
Phone Button Template
  • Field Name: User Details.button_template
  • Type: String
Phone Security Profile
  • Field Name: User Details.security_profile
  • Type: String
does_phonetype_support_pac
  • Field Name: User Details.does_phonetype_support_pac
  • Type: Boolean
Use Activation Code Onboarding Enabling this checbox will instruct this workflow to add one phone only, using the Activation-Code based registration method. The code will be automatically generated. When selected, the Phone name field also gets hidden because the phone name will be automatically generated when this onboarding method is used.
  • Field Name: User Details.enable_activation_code
  • Type: Boolean
Allow MRA Mode
  • Field Name: User Details.allowMraMode
  • Type: Boolean
MRA Service Domain
  • Field Name: User Details.mraServiceDomain
  • Type: String
Phones
  • Field Name: phones.[n]
  • Type: Array
Phone Name Name of phone to provision for e.g. SEPABCDEFABCDEF
  • Field Name: User Details.phones.[n].phone_name
  • Type: String
  • Target: device/cucm/Phone
  • Target attr: name
  • Format: uri
Extension Mobility
  • Field Name: User Details.mobility
  • Type: Boolean
Voicemail
  • Field Name: User Details.voicemail
  • Type: Boolean
Webex Meetings Webex Meetings
  • Field Name: User Details.webex
  • Type: Boolean
Pexip Conferencing Pexip Conferencing
  • Field Name: User Details.pexip
  • Type: Boolean
Single Number Reach
  • Field Name: User Details.snr
  • Type: Boolean
SNR Mobile Number
  • Field Name: User Details.mobile_number
  • Type: String
Webex App Webex App
  • Field Name: User Details.spark
  • Type: Boolean
Webex App User Template Webex App User Template
  • Field Name: User Details.spark_template
  • Type: String
Contact Center Agent
  • Field Name: User Details.contact_center
  • Type: Boolean
Agent Profile
  • Field Name: User Details.contact_center_profile
  • Type: String
Agent Device Type Default: Phone
  • Field Name: User Details.contact_center_device_type
  • Type: String
  • Default: Phone
  • Choices: ["Phone", "Extension Mobility"]
Agent Device
  • Field Name: User Details.contact_center_device
  • Type: String
Agent Extension
  • Field Name: User Details.contact_center_extension
  • Type: String
Jabber / Dual-Mode Device When adding a Jabber device also specify a line to be associated. The first line specified will be used for any Jabber device added here.
  • Field Name: User Details.jabber
  • Type: Boolean
Jabber and Dual-Mode Devices
  • Field Name: jabber_devices.[n]
  • Type: Array
Jabber / Dual-Mode Agent
  • Field Name: User Details.jabber_devices.[n].jabber_agent
  • Type: String
  • Choices: ["Android", "CSF", "iPad", "iPhone", "Carrier Integrated Mobile", "CTI Remote Device"]
Device Name
  • Field Name: User Details.jabber_devices.[n].device_name
  • Type: String
Mobile Identity
  • Field Name: User Details.jabber_devices.[n].mobile_identity
  • Type: Boolean
Destination
  • Field Name: User Details.jabber_devices.[n].mobile_identity_destination
  • Type: String
Enable Self Provisioning
  • Field Name: User Details.self_service_id
  • Type: Boolean
Self Provisioning User Profile
  • Field Name: User Details.self_provisioning_profile
  • Type: String
Existing Services Group Assigned by FDP
  • Field Name: Existing Services
  • Type: Object
Existing Services
  • Field Name: existing
  • Type: Object
Primary Extension
  • Field Name: Existing Services.existing.primary_extension
  • Type: String
Phones
  • Field Name: Existing Services.existing.phones
  • Type: String
Extension Mobility Profiles
  • Field Name: Existing Services.existing.ext_mobilities
  • Type: String
Voicemail Extension
  • Field Name: Existing Services.existing.voicemail
  • Type: String
Conferencing
  • Field Name: Existing Services.existing.webex
  • Type: String
Single Number Reach
  • Field Name: Existing Services.existing.snr
  • Type: String
Webex App Webex App
  • Field Name: Existing Services.existing.spark
  • Type: String
Contact Center
  • Field Name: Existing Services.existing.contact_center
  • Type: String