Model: view/MicrosoftSubscriberQos

Quick Offboard Subscriber

Overview

Quick offboard subscriber (QOS) offboards a Microsoft subscriber by removing their Microsoft license, which removes all currently assigned services.

Note

If the Quick Offboard Subscriber configuration template (for target model view/MicrosoftSubscriberQas) includes a Quick Add Group entry associated with the configuration template for the MS Groups Remove Template, referenced MS group licenses associated with the user are also removed. See: Microsoft Licenses

Offboard a Microsoft Subscriber

This procedure is for Microsoft-only users. When choosing a hybrid user with Cisco-Microsoft services, you'll need to work with this user via the Hybrid multi vendor actions. The Hybrid Status Message field displays the user's hybrid status. See Cisco-Microsoft Hybrid Subscribers

To offboard a Microsoft subscriber:

Log in to the Admin Portal.
Go to MS Subscriber Management > Quick Offboard Subscriber.
Choose the relevant site.
At the Username drop-down, select the subscriber you wish to offboard.
Click Save.
Verify that the subscriber's license and all their services are now removed:
- Go to (default menus) Microsoft Subscriber Management > Subscribers, and confirm that the value in the Is Licensed column of the list view is false.
- Click on the subscriber to open their management page, and verify that they have no services assigned (for example, their MS Teams user status should be *User not provisioned for MS Teams).
  
  System Message: WARNING/2 (<string>, line 43); backlink
  
  Inline emphasis start-string without end-string.
Important

Since the offboard transaction requires a sync with the Microsoft Cloud and relies on waiting for incoming new data from Microsoft, you may expect some delay (between 30 and 60 seconds), before the user's new status (unlicensed, and services removed) displays in Automate. For example, the user may still appear as licensed in Automate, and values such as PhoneSystem may still display as an assigned service in the Automate cache, even though the user is unlicensed and services are removed.

Custom String and Custom Boolean Fields

The Quick Offboard Subscriber form allows for the exposure of up to ten custom string fields and up to 10 custom boolean fields to the field display policy you apply to the Quick Offboard Subscriber form (view/MicrosoftSubscriberQos).

The values are called

Custom String 1 (customString1) to Custom String 10 (customString10)
Custom Boolean 1 (customBoolean1) to Custom Boolean 10 (customBoolean10)

This provides flexibility to add additional details for a subscriber, if required to set specific values that for can example trigger workflows during off-boarding.

To expose custom fields for view/MicrosoftSubscriberQos:

Log in to VOSS Automate as Provider admin or higher.
Create or update the Customers data model field display policy:
- Go to (default menus) Customization > Field Display Policies, and locate the entry for target model type view/MicrosoftSubscriberQos.
- Click on the default field display policy (FDP) for the model (the FDP named default).
- Clone (copy) the default FDP for the model, and give the clone a new name.
  
  Note
  
  You cannot modify default FDPs that ship with the system. This allows you to refer to or revert to a system default at any time, if required.
- Modify the new FDP (the clone).
  
  (You can add a new group of fields containing only the new custom fields, or add fields to existing field groups. )
- Save your changes.
Update the landing page (Landing Pages) or menu layout (Menu Layouts) to apply the field display policy.
- Save your changes.
Log out, then log in again as Provider admin.

This allows the role-based access profile changes to refresh so that you can view the updated menu layouts and field display policies you applied, including new custom fields.

Subscribers

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

Onboarding a Microsoft user involves importing users and related data to the customer level from the Microsoft Cloud service, and then moving users to the correct sites as fully provisioned subscribers.

Automated workflows configure imported objects once changes are synced in, and apply the required configuration, policies, and licenses. This means administrators won't need to continually monitor the sync, or to perform additional steps to complete the process.

Once synced in (at the customer or site level), administrators can manage Microsoft users and subscribers via a single interface and login, from within the VOSS-4-UC Admin Portal. To maintain data integrity, to manage licenses, and to automate number auditing for synced in users, regular, targeted backend syncs poll for changes made at the device model layer.

Onboard Microsoft Users

VOSS-4-UC provides two onboarding options for Microsoft users:

Sync users to customer level, and then to sites

VOSS-4-UC Configuration and Sync

This option starts with an initial import of dial plans, policies, licenses, and Microsoft users, to the customer level (sync all to the tenant).

Then you will need to set up the configuration and user move criteria before moving users to the sites (set up model filter criteria, site defaults, quick add groups, subscriber profiles, and number inventory).

Finally, you have two options to move users to the sites as fully provisioned subscribers:

Run the overbuild to move multiple users to your sites at once.
Add single users via Quick Add Subscriber (QAS)

When moving users to site, the VOSS-4-UC automated workflow applies the required configuration, services, lines, policies, and licenses.

Sync users directly to sites

Sync with Flow Through

In this option, you run the initial sync together with flow through provisioning. In this case, you start by setting up the configuration and user move criteria before running the initial sync. That is, to set up the model filter criteria, site defaults, quick add groups, and subscriber profiles.

In addition, you will need to:

Configure flow through provisioning criteria
Enable flow through in the Global Settings

Once changes are synced in from the Microsoft Cloud, VOSS-4-UC automated workflows move the tenant dial plan, policies, and licenses to the customer level, and moves users directly to the appropriate sites as fully provisioned subscribers.

To access the flowcharts, view the topic via Documentation and Resources at: https://voss.portalshape.com

Offboard a User

This procedure offboards a user.

Log in to the Admin Portal.
Go to MS Subscriber Management > Subscribers.
Click on the relevant subscriber.
On the MS Licenses tab, delete the licenses.

Related Topics

Microsoft Overview in the Core Feature Guide

VOSS-4-UC Configuration and Sync in the Core Feature Guide

Sync with Flow Through in the Core Feature Guide

Model Details: view/MicrosoftSubscriberQos

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title		Description	Details
User Details		Group Assigned by FDP	Field Name: User Details Type: Object
	Username *		Field Name: User Details.username Type: String
	Hybrid Status Message		Field Name: User Details.mvs_hybrid_status_message Type: String