[Index]
Overview
Quick offboard subscriber (QOS) offboards a Microsoft subscriber, and moves the subscriber from the site back to the customer level.
When running offboard subscriber for Microsoft you can choose from a filtered list of Quick Add Groups (QAGs) flagged for offboarding that contain configuration templates (CFTs) to define how the subscriber should be offboarded and de-provisioned. For example, via the CFTs in the QAG you can choose to:
Note
A MSOL CFT removes licenses. A CSOL CFT only removes voice services (disables enterprise voice and removes the line). The CSOL CFT clears or changes values and should contain fn.unset for any fields that need to be cleared, such as LineURI and enterpriseVoiceEnabled. See the System Microsoft Teams Online User Template Un License User CFT for an example of the minimum configuration required.
Related Topics
Setting up a Configuration Template for MS Offboard Subscriber
The configuration template (CFT) to be included in a Quick Add Group flagged to be used in offboarding may be customized via referenced variables to define how a subscriber should be offboarded and de-provisioned.
In the Quick Add Group, you choose the CFT to use and select the offboarding checkbox. The CFT is customized to run the offboarding workflow. When running Microsoft offboard you can choose a Quick Add Group flagged for offboarding, and the CFT referenced in this Quick Add Group runs the offboarding workflow.
If you don't select an offboarding Quick Add Group, the system default offboarding behavior applies.
Important
Automate 24.1-PB1 introduces Quick Add Groups that can be flagged for offboarding and associated CFTs that allow flexible and configurable offboarding.
Upgrading to Automate 24.1-PB1 will break Microsoft offboard customizations you may have included in an earlier version of Automate. Verify the state of cloned CFTs and Quick Add Groups used for offboarding as part of your upgrade:
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 Username, select the subscriber you wish to offboard.
Optionally, at Offboarding Quick Add Group, select a predefined Quick Add Group that defines how the user is to be offboarded and de-provisioned, or leave the field blank to apply the system default behavior.
Note
Quick Add Groups used for offboarding display a checkbox called Microsoft Offboarding. Quick Add Groups with the offboarding flag enabled display in a filtered list in the Offboarding Quick Add Group drop-down on the Quick Offboard Subscriber form.
If you wish to customize how and whether licenses, and/or lines, and/or or services are removed when offboarding, you can set up this behavior in a custom configuration template (CFT), and associate it to a Quick Add Group used for offboarding to define how users are to be offboarded and de-provisioned.
If you don't see the Offboarding Quick Add Group drop-down on this form, it's hidden via the field display policy (FDP), which means that the system default behavior applies when offboarding users.
The system default for offboarding is to remove the user's licenses and services.
Regardless of the options you set up to offboard a user, or whether you use the system default behavior, an offboarded user is always moved from the site back to the customer level.
Click Save.
Verify that the user is de-provisioned and offboarded as defined via the configuration template in the Quick Add Group you chose, either a customized offboarding Quick Add Group, or the system default behavior. For the system default behavior:
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).
Confirm that the user is now at the customer level.
Note
When moving a user from the site to the customer level, if that user had a Self-service role at the site, their Self-service role is retained when they move to the customer level and this role is retained if you later move that user to another site.
Important
The offboard transaction requires a sync with the Microsoft Cloud and relies on waiting for incoming new data from Microsoft. For this reason, you may expect some delay (between 30 and 60 seconds), before the user's new status (unlicensed and/or 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 Fields on Quick Offboard Subscriber
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).
Values are:
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.
This procedure exposes 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).
Note
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 dashboard (Automate Dashboards) or menu layout (Menu Layouts) to apply the field display policy, and save your changes.
Log out, then log in again as Provider admin.
Role-based access profile changes refresh so that you can view the updated menu layouts and field display policies you applied, including new custom fields.
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:
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:
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.
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
| Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| User Details | Group Assigned by FDP |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Username * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Hybrid Status Message |
|
||||||||||||||||||||||||||||||||||||||||||||||||