[Index]

Model: device/spark/User

Cisco Webex App users

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

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

Note

Automate also allows for the periodic logging and inspection of changes made to data directly in the Webex Control Hub. Contact VOSS if this functionality is to be exposed. The view/WebexAuditEvent and data/WebexAuditEvents models are used for this purpose.

Related topics

View Webex user

To view a Cisco Webex App user:

  1. Go to Webex User Services (dashboard), then:

Add Webex user via Webex User Details page

This procedure adds a new Cisco Webex user via the Webex User Details page in Automate.

Note

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

  2. Go to the Webex User Details list view.

  3. Click the Plus icon (+) to add a new record, then choose the relevant site.

  4. Configure account details and calling type on the Account Details & Calling Settings tab/panel:

    Note

    Location is read-only, synced from Control Hub.

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

    No administrator privileges Default
    Full administrator privileges

    Assigns access to all portal features, including:

    • Assign roles
    • Company policy and templates
    • Device management
    • Licenses and upgrades
    Read-only administrator privileges Assigns read-only access to content available to a full privilege admin
    Support administrator privileges Assigns access to user information and support logs
    User and Device Administrator .
    Device Administrator .

  2. If available, on the Wholesale Package tab/panel, manage settings for packages in the Webex for Wholesale service, and their status, for example, provisioned.

    This tab/panel displays only when the Webex for Wholesale service is available. See Create Webex App Service.

    Depending on the package selected, the user's assigned licenses, as available on the Webex for Wholesale service, are then also updated when the user is provisioned.

    Note

    When modifying a Webex user and UCM Calling Licensing is deleted and the work phone number is also set to empty, the number is removed from the user. Work phone number remains assigned to the user if it's not set to empty.

  3. Save your changes.

    The Cisco Webex App user is added. You can view added details in the summary list view, which also displays:

Delete a Cisco Webex App user

This procedure deletes an existing Cisco Webex App user (a synced in user, or one added via 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 Webex User Services. Choose an option to open a list view of users. See View Webex user.

  4. From the list view, select users to delete, one or more; then, click the Delete icon.

  5. Click Yes to confirm.

    Note

    When deleting a user 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 users with Cisco Webex

This section describes how to provision Cisco Webex for a user, either via the Users list view, or via Webex Quick User.

Related topics

Provision Cisco Webex via Cisco User list view

This procedure provisions a user with Cisco Webex, via the Cisco User list view.

Prerequisite:

To provision a user with Webex:

  1. In the Admin Portal, go to Cisco Users.

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

  3. On the Webex App tab/panel, at Webex App User, expand and then fill out settings:

    Note

    • The Invite Pending checkbox is read-only, and defines whether the user's Webex account is active (checkbox is flagged). When the checkbox is clear, the Webex account is not active.
    • Options in the Manager ID field and Location field depend on the Cisco Webex server to which the Cisco Webex Service is synced.

    • At Calling Behavior, choose an option, either of the following:

      • Calling in Webex App
      • Calling in Webex App (Unified CM)
      • Cisco Jabber app
      • Third-Party app

    • At Assigned Licenses, select a license. Options depend on the Cisco Webex server to which the Cisco Webex Service is synced.

    • At Roles, select relevant 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 .

  4. Save your changes.

    The user is provisioned with Cisco Webex. To verify, ensure the value in the Webex App column in the Cisco Users list view is set to Enabled.

Provision Webex user via Webex Quick User

This procedure enables Cisco Webex for a user via Cisco Quick Add User.

Prerequisite:

  1. In the Admin portal, select the relevant site.

  2. Go to Webex Quick User (view/WebexTeamsSubscriberQas).

  3. At Username, select the user to be provisioned with Cisco Webex.

  4. Select the Webex App checkbox to enable Cisco Webex for the user.

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

  6. Click Save. Cisco Webex is provisioned for the user.

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

Note

When Cisco Webex Calling (with UCM) 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

Sync with flow through for Cisco Webex App users requires pre-configuring several settings in Automate (including flow through provisioning criteria) before the initial sync from the Webex Control Hub. See: Flow Through Provisioning.

This set up 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 users - in accordance with configured Webex App user model filter criteria and user profile.

Important

For Webex Control Hub users with Webex Calling Professional licenses and a location assigned, this location won't be overwritten by any site setting configured in the 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

Cisco Webex App Users settings

This section describes configurable fields on the Cisco Webex App Users page (relation/SparkUser).

When navigating to Cisco Webex App Users, you can view a list of Cisco Webex App users in Automate (the list view). Click on a user to view or configure their settings on the user settings page, where you can view or update settings on the following tabs:

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