[Index]

Model: view/QuickSubscriberForMsTeamsMultiVendor

Quick Subscriber

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

This procedure displays and updates a Microsoft user, and moves the user to the correct site, with all configuration and licensing applied.

Note

Quick Subscriber simplifies onboarding with the use of Quick Add Groups (QAGs). QAGs are service and policy assignment templates that allow you to pre-configure how calling rights, policies, and services are assigned to users based on their user role.

When updating a user via Quick Subscriber, you select the relevant QAG, and the automated workflows in VOSS Automate handles the required cloud sync and licensing. The workflow also removes the need for an administrator to check the licensing, or to flag the required policies and settings individually, and then to wait for the cloud to sync in.

Prerequisites:

Perform these steps:

  1. Log in to the Admin Portal as a Provider admin, at the Customer level.

  2. Go to (default menu) MS Subscriber Management > Quick Subscriber.

  3. Choose the relevant site.

  4. On the Quick Subscriber page:

  5. Go to MS Subscriber Management > Subscriber Staging to view the user in the staging queue.

    Note

    The user is placed in the staging queue (with all configuration applied) while waiting for the cloud to sync in. Once the licensed user appears in the Microsoft Teams portal, a second, targeted sync is triggered, which searches only for staged users (not all users from the tenant). Once the sync completes, the user becomes a fully provisioned subscriber, and the number is flagged as used. The subscriber receives a welcome email (if you've chosen this option, and you have a SMTP server configured).

    Users can only be staged if the following setting in the site defaults is enabled (accessed via, default menus, Site Management > Defaults, on the MS Teams tab): Manage Licenses and Allow User Staging

    Starting with VOSS Automate v21.3-PB1, you can, with immediate effect, un-stage a user waiting in the staging queue. This executes a direct sync to the Microsoft cloud to determine whether the user has appeared in MS Teams after their licensing update.

  6. Verify that the subscriber is configured and licensed:

Related Topics

Microsoft Subscribers in the Core Feature Guide

Microsoft User Move Configuration in the Core Feature Guide

Flow Through Provisioning in the Core Feature Guide

Subscriber Staging (Microsoft Users) in the Core Feature Guide

Microsoft Licenses in the Core Feature Guide

NB! This 'QuickSubscriberForMsTeamsMultiVendor' view model will (eventually) be deprecated. Please re-integrate / start using 'HybridMultiVendorVIEW' instead.

Multi Vendor Quick Add Subscriber provides a single page where you can:

User Provisioning

  1. Select a User from the username dropdown. This will show a list of users that have already been synced to VOSS Automate via LDAP. This could either be via Top Down or Bottom up syncing. For provisioning to be successful the device.cucm.UserIdentity field should match the UPN of the user in O365(MsolUser). If the user already has cisco services these will be displayed in the "User Status & Existing Services" section
  2. A Directory Number can be selected. If Cisco services exists the users 1st line will be displayed.
  3. The required Service Type should be selected. For more information see the Service Type descriptions.
  4. If displayed the Entitlement Profile can be changed. If the Entitlement Profile is configured in the Service Type this field will be hidden.
  5. A Quick Add Group can be selected to configure settings on the Teams user based on data.LyncQuickAddGroups-Teams. Otherwise Values will use the Microsoft Site Defaults

Service Types

Teams Licences

The MVS_QaS Workflow will check that the O365 user has an assigned license that has Entprise Voice capabalities. If a valid license is not found the workflow will fail. Alternatively it's possible for VOSS Automate to assign a valid license to the User. After assigning the license it may take some time for the change to appear on the Tenant, this is due to propogation delay in the Microsoft Cloud. The user will be marked as "Microsoft Update Pending", VOSS Automate will periodically check for this user in the Teams Tenant, once the User has appeared VOSS Automate will complete the configuration steps

Model Details: view/QuickSubscriberForMsTeamsMultiVendor

Title Description Details
Username * VOSS Automate username as per data.User
  • Field Name: username
  • Type: String
Include users at higher hierarchy Includes users above site level when searching
  • Field Name: 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: failIfNotFound
  • Type: Boolean
Entitlement Profile If Entitlement Profiles are used on the platform they can be selected or changed here. If the Entitlement profile is configured within a Service Type this field will be hidden.The field will initially display the default Entitlement Profile
  • Field Name: entitlement_profile
  • Type: String
First Name
  • Field Name: firstname
  • Type: String
Last Name
  • Field Name: lastname
  • Type: String
Email Address
  • Field Name: email
  • Type: String
  • Pattern: ^([^.@]+)(\.[^.@]+)*@([^.@]+\.)+([^.@]+)$
  • Format: email
Password The corresponding CUCM, CUC and WebEx user password will be set with this password
  • Field Name: password
  • Type: String
  • Is Password: True
PIN The corresponding CUCM and CUC user PIN will be set with this PIN
  • Field Name: pin
  • Type: String
  • Is Password: True
Manager
  • Field Name: manager
  • Type: String
Department
  • Field Name: department
  • Type: String
Telephone Number
  • Field Name: telephoneNumber
  • Type: String
Title
  • Field Name: title
  • Type: String
Home Number
  • Field Name: homeNumber
  • Type: String
User's Mobile Number
  • Field Name: mobileNumber
  • Type: String
Directory URI
  • Field Name: directoryUri
  • Type: String
Quick Add Group * Can be used to configure settings on the Teams user based on data.LyncQuickAddGroups-Teams. Otherwise Values will use the Microsoft Site Defaults
  • Field Name: qagroup_name
  • Type: String
  • Target: data/QuickAddGroups
  • Target attr: group_name
  • Format: uri
Class of Service Select the Class of Service to apply to the Teams Client. This controls what call types are dialable within the country dialplan (International, Premium, Service,....). The Class of Service behaviour maps directly equivalent CoS in CUCM.
  • Field Name: class_of_service
  • Type: String
User Status & Existing Services
  • Field Name: existing
  • Type: Object
User Type
  • Field Name: existing.UserType
  • Type: String
CUCM User LDAP Directory Name
  • Field Name: existing.cucm_user_ldapDirectoryName
  • Type: String
CUCM User Identity / AD UserPrincipalName
  • Field Name: existing.cucm_user_identity
  • Type: String
Phones
  • Field Name: existing.phones
  • Type: String
Extension Mobility Profiles
  • Field Name: existing.ext_mobilities
  • Type: String
Voicemail Extension
  • Field Name: existing.voicemail
  • Type: String
WebEx
  • Field Name: existing.webex
  • Type: String
Single Number Reach
  • Field Name: existing.snr
  • Type: String
Webex Teams
  • Field Name: existing.spark
  • Type: String
Contact Center
  • Field Name: existing.contact_center
  • Type: String
Teams Licenses
  • Field Name: teams_licenses.[n]
  • Type: Array
Name
  • Field Name: existing.teams_licenses.[n].Name
  • Type: String
AccountSkuId
  • Field Name: existing.teams_licenses.[n].AccountSkuId
  • Type: String
Licence for MS Teams Telephony Available
  • Field Name: existing.teamsTelephonyAllowed
  • Type: Boolean
MS Teams Telephony License
  • Field Name: existing.teamsTelephonyLicense
  • Type: String
Teams Line URI
  • Field Name: existing.teams_line_uri
  • Type: String
MS Teams UserPrincipalName
  • Field Name: existing.teams_msol_upn
  • Type: String
User status
  • Field Name: user_status
  • Type: String
Service Type * Select the required Service Type for the user. The Service Type defines the collection of settings that will be applied to Teams and CUCM to achieve different behaviours. Appropriate Service Types will be shown based on whether the selected line has an associated E164 number.
  • Field Name: MultiVendorServiceType
  • Type: String
Directory Number Select line and associated E164 to configure in Teams.Value will default to users first line in CUCM. If line does not have an associated E164, a dummy E164 number will be generated.
  • Field Name: line1DN
  • Type: String
E164 Number
  • Field Name: line1E164
  • Type: String
Microsoft Teams
  • Field Name: ms_teams
  • Type: Boolean
Usage Location Location used for Microsoft Licensing
  • Field Name: usage_location
  • Type: String
LDAP User
  • Field Name: ldap_user
  • Type: String
Data User
  • Field Name: data_user
  • Type: String
CUCM User
  • Field Name: cucm_user
  • Type: String
MSOL User
  • Field Name: msol_user
  • Type: String
CS Online User
  • Field Name: csonline_user
  • Type: String
CUCM User LDAP Directory Name
  • Field Name: cucm_user_ldapDirectoryName
  • Type: String
Use Entitlement from Service Definition
  • Field Name: forceEp
  • Type: String
Use QAG from Service Definition
  • Field Name: forceQag
  • Type: String
Use MS Teams from Service Definition
  • Field Name: forceMsTeams
  • Type: String
Display Line 1 CoS
  • Field Name: displayLine1CoS
  • Type: Boolean
Is CUCM User Present Default: false
  • Field Name: isCucmUserPresent
  • Type: Boolean
  • Default: false
custom_string_1
  • Field Name: custom_string_1
  • Type: String
custom_string_2
  • Field Name: custom_string_2
  • Type: String
custom_string_3
  • Field Name: custom_string_3
  • Type: String
custom_string_4
  • Field Name: custom_string_4
  • Type: String
custom_string_5
  • Field Name: custom_string_5
  • Type: String
custom_string_6
  • Field Name: custom_string_6
  • Type: String
custom_string_7
  • Field Name: custom_string_7
  • Type: String
custom_string_8
  • Field Name: custom_string_8
  • Type: String
custom_string_9
  • Field Name: custom_string_9
  • Type: String
custom_string_10
  • Field Name: custom_string_10
  • Type: String
custom_boolean_1
  • Field Name: custom_boolean_1
  • Type: Boolean
custom_boolean_2
  • Field Name: custom_boolean_2
  • Type: Boolean
custom_boolean_3
  • Field Name: custom_boolean_3
  • Type: Boolean
custom_boolean_4
  • Field Name: custom_boolean_4
  • Type: Boolean
custom_boolean_5
  • Field Name: custom_boolean_5
  • Type: Boolean
custom_boolean_6
  • Field Name: custom_boolean_6
  • Type: Boolean
custom_boolean_7
  • Field Name: custom_boolean_7
  • Type: Boolean
custom_boolean_8
  • Field Name: custom_boolean_8
  • Type: Boolean
custom_boolean_9
  • Field Name: custom_boolean_9
  • Type: Boolean
custom_boolean_10
  • Field Name: custom_boolean_10
  • Type: Boolean