[Index]

Model: device/spark/User

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

Model Details: device/spark/User

Title Description Details
Id
  • Field Name: id
  • Type: String
First Name
  • Field Name: firstName
  • Type: String
Last Name
  • Field Name: lastName
  • Type: String
Email Address *
  • Field Name: email
  • Type: String
Webex Calling - Professional
  • Field Name: calling_pro
  • Type: Boolean
Webex Contact Center
  • Field Name: contact_center
  • Type: Boolean
Work Phone Work number for the person. e.g. +1 408 526 7209. This is only settable for a person with a Webex Calling license.
  • Field Name: workNumber
  • Type: String
Extension Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.
  • Field Name: extension
  • Type: String
Mobile Phone Mobile number for the person. e.g. +1 408 526 7209.
  • Field Name: mobileNumber
  • Type: String
Alternative Phone 1 First alternative number for the person. e.g. +1 408 526 7209.
  • Field Name: alternativeOneNumber
  • Type: String
Alternative Phone 2 Second alternative number for the person. e.g. +1 408 526 7209.
  • Field Name: alternativeTwoNumber
  • Type: String
SIP Addresses The users sip addresses.
  • Field Name: sipAddresses.[n]
  • Type: Array
Type The type of SIP address.
  • Field Name: sipAddresses.[n].type
  • Type: String
Number The SIP address
  • Field Name: sipAddresses.[n].value
  • Type: String
Primary
  • Field Name: sipAddresses.[n].primary
  • Type: Boolean
Addresses The users addresses.
  • Field Name: addresses.[n]
  • Type: Array
Type The type of address.
  • Field Name: addresses.[n].type
  • Type: String
Country The user's country. Example value: US
  • Field Name: addresses.[n].country
  • Type: String
Locality The user's locality, often city. Example value: Milpitas
  • Field Name: addresses.[n].locality
  • Type: String
Region The user's region, often state. Example value: California
  • Field Name: addresses.[n].region
  • Type: String
Street Address The user's street. Example value: 1099 Bird Ave.
  • Field Name: addresses.[n].streetAddress
  • Type: String
Postal Code The user's postal or zip code. Example value: 99212
  • Field Name: addresses.[n].postalCode
  • Type: String
Display Name *
  • Field Name: displayName
  • Type: String
Nickname
  • Field Name: nickName
  • Type: String
Department
  • Field Name: department
  • Type: String
Manager
  • Field Name: manager
  • Type: String
Manager ID
  • Field Name: managerId
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • Format: uri
Title
  • Field Name: title
  • Type: String
Time Zone
  • Field Name: timezone
  • Type: String
Location
  • Field Name: locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Date Created
  • Field Name: created
  • Type: String
  • Format: date-time
Status
  • Field Name: status
  • Type: String
User Type Default: person
  • Field Name: type
  • Type: String
  • Default: person
  • Choices: ["Person", "Bot", "App User (Guest User)"]
Invite Pending
  • Field Name: invitePending
  • Type: Boolean
Login Enabled
  • Field Name: loginEnabled
  • Type: Boolean
Field to pass selected number from QAS workflow
  • Field Name: line
  • Type: String
Roles
  • Field Name: roles
  • Type: Object
No administrator privileges Default: true
  • Field Name: roles.none
  • Type: Boolean
  • Default: true
Full administrator privileges - User Management - Company Policy & Templates - Analytics & Reports - Support Metrics & Notifications - Licenses & Upgrades - Assign Roles
  • Field Name: roles.full
  • Type: Boolean
Read-only administrator privileges Read-only view of the portal. No changes will be accepted.
  • Field Name: roles.readonly
  • Type: Boolean
Support Administrator - Analytics & Reports - Support Metrics & Notifications
  • Field Name: roles.support
  • Type: Boolean
User and Device Administrator - User Management - Device Management - Licenses & Upgrades
  • Field Name: roles.user_device
  • Type: Boolean
Device Administrator - Device Management
  • Field Name: roles.device
  • Type: Boolean
Assigned Licenses
  • Field Name: licenses.[n]
  • Type: Array
License Select the license to assign to this user.
  • Field Name: licenses.[n].license
  • Type: String
  • Target: device/spark/License
  • Target attr: unique_name
  • Format: uri
Settings
  • Field Name: settings
  • Type: Object
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how a user makes calls in Webex App.
  • Field Name: settings.calling.calling_behaviour
  • Type: String
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app", "Third-Party app"]
Use Organization's Domain Enabling this will use the Webex App organization domain for Calling in Webex App (Unified CM)
  • Field Name: settings.calling.use_org_domain
  • Type: Boolean
UC Manager Profile
  • Field Name: settings.calling.calling_behaviour_uc_manager_profile
  • Type: String
  • Target: device/spark/CallingProfile
  • Target attr: name
  • Format: uri
Create iPhone Device Default: true
  • Field Name: settings.calling.SparkiPhoneDevice
  • Type: Boolean
  • Default: true
Create Android Device Default: true
  • Field Name: settings.calling.SparkAndroidDevice
  • Type: Boolean
  • Default: true
Create Tablet Device Default: true
  • Field Name: settings.calling.SparkTabletDevice
  • Type: Boolean
  • Default: true
Create CSF Device Default: true
  • Field Name: settings.calling.SparkCSFDevice
  • Type: Boolean
  • Default: true