[Index]

Model: view/QuickSubscriber

Cisco Quick User

Full HTML Help

CISCO

Tip

Use the Action search to navigate Automate

Overview

Cisco Quick User provides a single page where you can add a Cisco UCM user with a line, a voicemail, and a Webex account, and provision the user with services such as voice, extension mobility, single number reach (SNR), and conferencing and collaboration services.

Important

Cisco Quick User is a simple, generic method for provisioning users 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 Automate's advanced user management functionality (Cisco Advanced User), or bulk loaders. For example, you could use Cisco Quick User to add users with only the first line on phones, then use advanced user management to add the second line to the phone.

For details around how Quick Add User handles the application of a Line configuration template associated with a selected Quick Add Group (QAG) when adding or updating a user, see Shared Lines.

Supported User Types

Quick Add User for UCM 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 Cisco Quick User

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

  • Cisco Unified Communications Manager (UCM) server

    Adding a UCM server allows the following:

    • Syncing of manually provisioned users or LDAP-integrated users in UCM to Automate
    • Syncing in of users phones, directory numbers, extension mobility profiles in UCM to Automate
    • Creation of users (push users to UCM)
    • Pushing of users' associated phones, directory numbers, and extension mobility profiles, to UCM.
  • LDAP server

    Required only if you want to configure LDAP-synced users in Automate, else, optional.

  • Cisco Unity Connection (CUC) server

    Required only if you want to add CUC voicemail users that are configured in 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 Automate (via the Voicemail page). This step is required to create a "Default CUC User Template" (via the Site Defaults page for CUC. The template is required to create CUC voicemail users.
  1. Configure Webex service
Configure a Webex Server in Automate to deploy any Webex users provisioned through Quick Add User. Set a password for Webex users in the Site Defaults.

Add a user via Cisco Quick User

This procedure adds a UCM user via Cisco Quick User.

Prerequisites:

Add user via Quick Add User

  1. In the Admin Portal, go to Cisco Quick Add User.

    Note

    • You can switch between a tab or panel layout on this form.
    • 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, and CTIRD remote destination. Existing services are associated with services enabled/disabled at the customer level via the Global Settings.
  2. Configure user details on the User Details tab/panel:

    Note

    LDAP-synced or LDAP-integrated at UCM user fields are read-only.

  3. Save your changes. The user is added.

Related Topics

Enable services in Cisco Quick User

When adding a user via Cisco Quick User, you can enable user services, such as voicemail, extension mobility, single number reach, conferencing (meetings), and collaboration (messaging) services (such as Webex App).

The Quick Add User 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 Cisco Quick User to add a user without an entitlement profile. For example, entitlement profiles may not exist on the deployment, or they may not be associated with the user. In this case, a phone type, for example, may still be associated with the user 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 UCM (call manager) must be configured at the user's hierarchy. If this does not exist, the Quick Add User bulk load transactions and API calls display the following warning: No Call Manager has been configured

Add Webex App service using Quick Add User

Note

When using Quick Add User to provision WebexApp services, the SiteDefaultsDoc - User Defaults tab values should be set to either:

or

Selecting the Webex App checkbox on the Quick Add User 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 UCM 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 User

You can use Quick Add User 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 UCM user associated with the Contact Center agent.

Quick Add User device pool

When adding a user via Cisco Quick User, you can associate a device pool to the user'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 user using Cisco Quick User.

A device pool can be referenced by:

Device pool and Site Defaults Doc

The device pool referenced in the SDD ensures that a user'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 Group

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 Groups for details.

Device pool and Admin Portal

An administrator can expose a Device Pool drop-down on the Quick Add User page on the Admin Portal by editing or cloning the Field Display Policy. See Expose Device Pools and Class of Service in Quick Add User. 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:

Cisco Quick User Class of Service

With Cisco Quick User you can associate Calling Search Space (CSS) values to a user'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 user using Quick Add User.

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 user'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 Quick Add Group 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 Group

The Calling Search Space values referenced by a Configuration Template (CFT) in the Quick Add Group 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 Groups for details.

Class of Service and Admin Portal

An administrator can expose a Class of Service drop-down on the Quick Add User page on the Admin Portal by editing or cloning the Field Display Policy. See Expose Device Pools and Class of Service in Quick Add User. 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 Cisco Quick User

This procedure exposes the Device Pools field and Class of Service (CoS) field on the Cisco Quick User form, at a specified hierarchy.

Pre-requisites:

Perform these steps:

  1. In the Admin Portal, go to 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 Cisco Quick User:
  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 Cisco Quick User, where you will see the relevant field exposed (either Device Pools or Class of Service).

Provision the extension mobility service

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

In 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 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 Automate (via the EMCC page).

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 Automate, EMCC groups define the clusters and countries to be used together for extension mobility. When saving an EMCC group, 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 Automate. Device profiles are configured in 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 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:

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.

Cisco Webex App Users

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

You can add Webex App users into Automate in various ways:

Related topics

View Cisco Webex App user

To view a Cisco Webex App user:

  1. Open the Webex App user's settings. Two options:

  2. On the Webex App user's detail page, view their account details and calling type, and their roles and addresses.

    If the user is associated with a phone (device) you can click the link adjacent to the device to go to relation/WebexDevice to view and manage the device settings.

    Note

    Multiple Jabber devices can be added to a Webex User as long as the user does not have an existing device of the same device type.

Add Cisco Webex App user via Cisco Webex App menu

This procedure adds a new Cisco Webex user via the default Cisco Webex App menu in Automate.

Note

In this case:

  1. Log in to the Admin Portal as a Provider, Reseller, Customer, or Site administrator.

  2. Go to the Users page.

  3. View existing Cisco Webex App users (including users with Webex Wholesale packages - synced, or added in Automate).

  4. Click Add.

  5. Choose the hierarchy where you want to add the Cisco Webex user.

  6. Fill out fields on the Account Details & Calling Settings tab/panel:


  1. On the Roles tab/panel, select relevant roles:

    No administrator privileges Default
    Full administrator privileges

    Access to all portal features, including:

    • Assign roles
    • Company policy and templates
    • Device management
    • Licenses and upgrades
    Read-only administrator privileges Read-only access to content available to a full privilege admin
    Support administrator privileges Access to user information and support logs
    User and Device Administrator .
    Device Administrator .
  2. The Wholesale Package tab/panel is shown only if the Webex for Wholesale service is available - see: Create Webex App Service. Available packages in the service and their status (e.g. provisioned) are shown and can be managed here.

    In accordance with the package selection, the user's Assigned Licenses - as available on the Webex for Wholesale service - are then also updated when the user is provisioned.

    Note that when modifying a Webex user and UCM Calling Licensing is deleted and the Work Phone number is also set to empty, then the number is removed from the user. In the case where the Work Phone number is not set to empty, it remains assigned to the user.

  3. Click Save to add the Cisco Webex App user.

    Note

    You can view the details for the Cisco Webex App user you added in the summary list view, which also displays:

    • On-Prem UCM Calling Service (True/False) - Defines whether calling services are on-premise or cloud. The On-Prem UCM Calling license is removed if the Cisco Webex Calling (with CUCM) is removed from the user.
    • Calling Behavior (determines license use) - options are:
      • Calling in Webex App - Allows calling via the Webex app using native Webex calling
      • Calling in Webex App (Unified CM) - Allows calling via the Webex app using a registration to CUCM
      • Cisco Jabber App - Allows calling using a Cisco Jabber client registered to CUCM
      • Third Party App - Allows calling using a third party app registered to CUCM
    • Use Organization's Domain (True/False) - When enabled, the Cisco Webex organization domain is used for calling in Cisco Webex (Unified CM)
    • UC Manager Profile - May be used to identify the required CUCM cluster when a calling behavior using CUCM is selected. If the default CUCM domain is selected, this is not required.
    • User Type - "Person", "Bot" or "App User (Guest User)".
    • Status - the current Cisco Webex App user status: for example: active/inactive, in a call/meeting/presenting, and so on. If unknown, then displayed as: "The user status could not be determined".

Delete a Cisco Webex App user

This procedure deletes an existing Cisco Webex App user (synced, or added via VOSS Automate).

  1. Log in to the Admin Portal as a Provider, Reseller, Customer, or Site administrator.

  2. Set the hierarchy to the Customer or Site level.

  3. Go to the Users page.

  4. Choose the Webex users you wish to delete (one or more).

  5. Click Delete.

  6. Click Yes to confirm.

    Note

    When deleting a subscriber with Cisco Webex App, the internal number inventory (INI) is updated as the number status is changed to Available, and the description, if any, is removed.

Provisioning subscribers with Cisco Webex

This section describes how to provision Cisco Webex for a subscriber, either via the Subscriber list view, or via Quick Add Subscriber (QAS).

Related Topics

Provision Cisco Webex via Subscriber list view

This procedure provisions a subscriber with Cisco Webex, via the Subscriber list view.

Prerequisite:

To provision a subscriber with Webex:

  1. In the Admin Portal, go to Subscribers.

  2. From the Subscribers list, click on a subscriber you wish to provision with Cisco Webex.

  3. On the subscriber configuration screen, select the Webex App panel (or if selected as display option, the tab).

  4. In the Webex App User field, expand the Webex App User configuration fields.

    Note

    The following Invite Pending checkbox is read-only, indicating the user's status (whether their Webex account is active).

    Options in the Manager ID and Location fields depend on the Cisco Webex Server to which the Cisco Webex Service is synced.

    The Calling Behavior field can be "Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app" or "Third-Party app".

  5. In the Assigned License section, the available licenses depend on the Cisco Webex Server to which the Cisco Webex Service is synced.

  6. In the Roles section, select the relevant check boxes to configure the required roles:

    No administrator privileges .
    Full administrator privileges

    Access to all of Portal features, including:

    • Assign roles
    • Company policy and templates
    • Device management licenses and upgrades
    Read-only administrator privileges View only access to privileges available to a full administrator.
    Support Administrator Access to user information and support logs.
    User and Device Administrator .
    Device Administrator .
  7. Click OK. Cisco Webex is provisioned for the subscriber.

    To verify, ensure the Webex App column in the Subscribers list view displays the text, Enabled.

Provision Cisco Webex via Quick Add Subscriber

This procedure enables Cisco Webex for a subscriber via Quick Add Subscriber (QAS).

Prerequisite:

  1. Go to Quick Add Subscriber.

  2. From the Username drop-down list, choose the name of the subscriber to be provisioned with Cisco Webex.

  3. Select the Webex App checkbox to enable Cisco Webex for the subscriber.

  4. From the Webex Teams User Template drop-down list, choose the template you want to assign to the user.

  5. Click Save. Cisco Webex is provisioned for the subscriber.

    To verify that Cisco Webex is enabled for the subscriber, ensure the Webex App column in the Subscribers list view displays the text, Enabled.

Note

When Cisco Webex Calling (with CUCM) is removed from a Webex User, the 'On-Prem UCM Calling' license is removed from the Webex User.

Sync Webex App users with flow through provisioning

When using sync with flow through provisioning for Cisco Webex users, you need to configure several settings in Automate (including flow through provisioning criteria) before the initial sync from the Webex Control Hub. See: Flow Through Provisioning.

This allows Automate to apply the correct configuration, licenses, and services to imported users, and to move users to sites.

Once you run the sync, users are imported, provisioned, licensed, and moved to the correct synced in sites, as subscribers - in accordance with configured Webex App user model filter criteria and subscriber profile.

Important

Webex Control Hub users who have been assigned Webex Calling Professional licenses and have a Location assigned, this location will not be overwritten by any site setting configured in the VOSS Automate user move component (Model Filter Criteria) of Flow Through Provisioning.

The flowchart sets out the sync with flow through of Cisco Webex users and services.

To access the flowcharts, view the topic via the release documentation at: https://documentation.voss-solutions.com/automate.html

Related Topics

Flow Through Provisioning in the Core Feature Guide

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

Full HTML Help

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

Tip

Use the Action search to navigate Automate

  1. Go to Quick Add Subscriber, then, from the Username drop-down, 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 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 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:

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
Inventory Filter
  • Field Name: User Details.automatic_line_filter
  • Type: String
Lines
  • Field Name: lines.[n]
  • Type: Array
Inventory Filter
  • Field Name: User Details.lines.[n].line_filter
  • Type: String
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