[Index]

Model: view/QuickSubscriber

Quick Add Subscriber

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

To add subscribers using QAS, a default user template called "voicemailusertemplate" must exist on the Unified CM. This default can be edited by editing the default CUC User Template value in the SDD.

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 input form shows a number of check boxes to enable user services such as Voicemail, Extension Mobility, Single Number Reach, WebEx, CMR, Webex Teams (Webex Teams Quick Add), etc. Selecting certain check boxes exposes additional fields.

If the Entitlement profile selected on the QAS 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 box controls 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, controls will also not be available if the site's SDD has no default value on the CUC Defaults tab for the Default CUC Subscriber Template. This default value (voicemailusertemplate) should already exist on the Unified CM and is automatically populated on an HCS system when a VoiceMail Pilot is created. A Cisco Unity Connection device must also be configured at the related NDL (Network Device List) at site level.

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

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 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 Conditions

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.

Provision the Extension Mobility Service

Procedure

  1. Choose Subscriber Management > Quick Add Subscriber, and choose a user from the Username drop-down list.
  2. Select the Extension Mobility check box.
  3. Click Save.
  4. Choose Subscriber Management > Quick Add Subscriber, and choose the same user from the Username drop-down list.
  5. Choose the Existing Services tab, and make sure that the Extension Mobility profile name appears in the Extension Mobility Profiles field.

Provision the Voicemail Service

Procedure

  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.
  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 the WebEx Service

Procedure

  1. Choose Subscriber Management > Subscribers. From the Subscribers list, click the name of the subscriber to be provisioned with WebEx service.
  2. Choose the WebEx tab.
  3. In the Web Ex User field, click +. The WebEx configuration fields appear.
  4. Enter information in the First Name, Last Name, Email, Password, and Repeat Password fields. Choose WebEx privileges in the Privilege section.
  5. Click Save.
  6. Choose Subscriber Management > Quick Add Subscriber, and choose the same user from the Username drop-down list, .
  7. Choose the Existing Services tab.
  8. Make sure that "ACTIVATED" appears in the WebEx field.

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.

Provision the Jabber or Dual Mode Device Service

Procedure

  1. Choose Subscriber Management > Quick Add Subscriber. From the Username drop-down, select a user.

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

  3. Click + next to Jabber and Dual-Mode Devices to expose the Jabber/Dual Mode Agent drop-down and Device Name field.

  4. Choose a device type from the Jabber/Dual Mode Agent drop-down. The Device Name field is automatically generated in the following format:

    <device type prefix><username><random number>, where:

    See examples in table below.

    Example Device Type and Device Name Combinations

    For this type of device Device Name (automatically generated)
    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 Format (regex): "[a-zA-Z0-9]{1,15}" For example: CIMJOHNSMI
    CTI Remote Device Format (regex): "[a-zA-Z0-9]{1,15}" For example: CTIJOHNSMI

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

  5. Click Save.

  6. Choose Subscriber Management > Quick Add Subscriber. From the Username list, choose the same user.

  7. Choose the Existing Services tab.

  8. Make sure 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.

Enable Self Provisioning

Procedure

  1. Choose Subscriber Management > Quick Add Subscriber. From the Username drop-down list, select a user.
  2. Select the Enable Self Provisioning check box. 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 Directory Number drop-down appears.
  5. Choose a line from the Directory Number drop-down.
  6. Click Save.
  7. Choose Subscriber Management > Subscribers and choose the same user from the Subscribers list view.
  8. Make sure that the Self Service and User Profile fields display the same settings as those set in Quick Add Subscriber.

Enhanced INI Filtering

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:

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

Title Description Details
User Details Group Assigned by FDP
  • Field Name: User Details
  • Type: Object
Username *
  • Field Name: User Details.username
  • Type: String
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
Device Pools
  • Field Name: User Details.device_pool
  • Type: String
User status
  • Field Name: User Details.user_status
  • Type: String
Lines
  • Field Name: lines.[n]
  • Type: Array
Directory Number
  • Field Name: User Details.lines.[n].directory_number
  • Type: String
Voice
  • Field Name: User Details.voice
  • Type: Boolean
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
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
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
  • Field Name: User Details.webex
  • Type: Boolean
Single Number Reach
  • Field Name: User Details.snr
  • Type: Boolean
SNR Mobile Number
  • Field Name: User Details.mobile_number
  • Type: String
Webex Teams Webex Teams
  • Field Name: User Details.spark
  • Type: Boolean
Webex Teams User Template Webex Teams User Template
  • Field Name: User Details.spark_template
  • 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
Is PhoneType Entitled?
  • Field Name: User Details.phonetype_entitled
  • Type: String
External Auto Trigger?
  • Field Name: User Details.external_trigger
  • Type: String
does_phonetype_support_pac
  • Field Name: User Details.does_phonetype_support_pac
  • Type: Boolean
Agent Extension
  • Field Name: User Details.contact_center_extension
  • 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
Existing Services Group Assigned by FDP
  • Field Name: Existing Services
  • Type: Object
Existing Services
  • Field Name: existing
  • Type: Object
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
WebEx
  • Field Name: Existing Services.existing.webex
  • Type: String
Single Number Reach
  • Field Name: Existing Services.existing.snr
  • Type: String
Webex Teams Webex Teams
  • Field Name: Existing Services.existing.spark
  • Type: String
Contact Center
  • Field Name: Existing Services.existing.contact_center
  • Type: String
API reference for view/QuickSubscriber