.. _ms_teams_data_export:

MS Teams Data Export
-----------------------

.. _21.1|VOSS-847:
.. _21.3-PB1|VOSS-1072|EKB-12699:
.. _21.3-PB1|VOSS-1072|EKB-12700:
.. _21.4-PB1|EKB-14929:
.. _21.4-PB1|EKB-14921:   

Filename:  ``<YYYY-MM-DD_HHMM>_ms_teams.json.gz``

Layout:


.. tabularcolumns:: |p{3cm}|p{10.5cm}|p{1cm}|p{1cm}|

+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| ELEMENT              | DESCRIPTION AND SOURCE FIELD                                                                       | DATA TYPE | VERSION |
+======================+====================================================================================================+===========+=========+
| ms_teams_username    | UserPrincipalName                                                                                  | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.UserPrincipalName                                                |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| alias                | user alias                                                                                         | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.Alias                                                            |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| username             | VOSS Username of the user tied to this MS Teams service instance.                                  | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | For release 21.3 and later, the ``data/User.username`` field mapping is:                           |           |         |
|                      |                                                                                                    |           |         |
|                      | ``data/User.username_ms_teams`` =                                                                  |           |         |
|                      |                                                                                                    |           |         |
|                      | ``device/msteamsonline/CsOnlineUser.UserPrincipalName``                                            |           |         |
|                      |                                                                                                    |           |         |
|                      | If this field is blank, it means there is not a corresponding ``data/User`` for this CsOnlineUser. |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| entitlement_profile  | Entitlement profile of the user                                                                    | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | data.User.entitlement_profile of matching data/User                                                |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| department           | User department                                                                                    | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.Department                                                       |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| account_enabled      | AccountEnabled                                                                                     | boolean   | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.AccountEnabled                                                   |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| enterprise_voice     | EnterpriseVoiceEnabled (not used)                                                                  | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.EnterpriseVoiceEnabled                                           |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| feature_types        | FeatureTypes, e.g. Teams, Phone System, etc                                                        | array     | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.FeatureTypes                                                     |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| line                 | OnPremLineURI                                                                                      | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.LineURI                                                          |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| line_type            | LineURIType, e.g. OperatorConnect, DirectRouting, CallingPlan                                      | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CCsOnlineUser.LineURIType                                                     |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| voice_routing_policy | OnlineVoiceRoutingPolicy                                                                           | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.OnlineVoiceRoutingPolicy                                         |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| tenant_dialplan      | TenantDialPlan                                                                                     | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.TenantDialPlan                                                   |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| voicemail_policy     | HostedVoicemailPolicy                                                                              | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.HostedVoicemailPolicy                                            |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+
| teams_upgrade_mode   | TeamsUpgradeEffectiveMode                                                                          | string    | v4      |
|                      |                                                                                                    |           |         |
|                      | device/msteamsonline/CsOnlineUser.TeamsUpgradeEffectiveMode                                        |           |         |
+----------------------+----------------------------------------------------------------------------------------------------+-----------+---------+

.. note::

   From release 21.4-PB1 onwards, the ``first_name`` and ``last_name`` fields have been removed
   as they are no longer used.


Example

::


   [
   {
     "username": "user_2", 
     "entitlement_profile": "MsTeamsUser",
     "hierarchy": "sys.02676185F05F.Prov1.Resel1.Cust1", 
     "ms_teams_username": "user_2@emailaccount.com", 
     "voicemail_policy": "BusinessVoice", 
     "teams_upgrade_mode":"TeamsOnly",
     "voice_routing_policy": "Global", 
     "alias": "user_2", 
     "account_enabled": True, 
     "tenant_dialplan": "", 
     "department": "R&D", 
     "reseller_name": "Resel1", 
     "provider_name": "Prov1", 
     "line": "18694400002", 
     "line_type": "OperatorConnect", 
     "feature_type": ["Teams"],
     "customer_name": "Cust1"
   },
   {
     "username": "user_3",
     "entitlement_profile": "MsTeamsUser",
     "hierarchy": "sys.02676185F05F.Prov1.Resel1.Cust1", 
     "ms_teams_username": "user_3@emailaccount.com", 
     "voicemail_policy": "BusinessVoice", 
     "teams_upgrade_mode":"TeamsOnly",
     "voice_routing_policy": "Global", 
     "alias": "user_3", 
     "account_enabled": True, 
     "tenant_dialplan": "", 
     "department": "R&D", 
     "reseller_name": "Resel1", 
     "provider_name": "Prov1", 
     "line": "18694400002", 
     "line_type": "OperatorConnect", 
     "feature_type": ["Teams"],
     "customer_name": "Cust1"
   },
   {
     "username": "user_1",
     "entitlement_profile": "MsTeamsUser",
     "hierarchy": "sys.02676185F05F.Prov1.Resel1.Cust1", 
     "ms_teams_username": "user_1@emailaccount.com", 
     "voicemail_policy": "BusinessVoice", 
     "teams_upgrade_mode":"TeamsOnly",
     "voice_routing_policy": "Global", 
     "alias": "user_1", 
     "account_enabled": True, 
     "tenant_dialplan": "", 
     "department": "R&D", 
     "reseller_name": "Resel1", 
     "provider_name": "Prov1", 
     "line": "18694400002", 
     "line_type": "OperatorConnect", 
     "feature_type": ["Teams"],
     "customer_name": "Cust1"
   }
   ]

