.. _subscriber_data_export:

Subscriber Data Export
----------------------

.. _21.1|VOSS-847:
.. _21.1|VOSS-790:
.. _20.1.1|VOSS-722:
.. _21.2|EKB-10599:
.. _21.3-PB1|EKB-12687:

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

Layout:

.. tabularcolumns:: |p{3cm}|p{9cm}|p{2cm}|p{1.5cm}|


+---------------------+-------------------------------------------------------+-----------+---------+
| ELEMENT             | DESCRIPTION AND SOURCE FIELD                          | DATA TYPE | VERSION |
+=====================+=======================================================+===========+=========+
| provider_name       | Name of the Provider                                  | string    | v2      |
+---------------------+-------------------------------------------------------+-----------+---------+
| reseller_name       | Name of the Reseller                                  | string    | v2      |
+---------------------+-------------------------------------------------------+-----------+---------+
| customer_name       | name of the customer                                  | string    | v1      |
+---------------------+-------------------------------------------------------+-----------+---------+
| division_name       | Intermediate Node (e.g                                | string    | v1      |
|                     | Division or other node)                               |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| location_name       | Site Name                                             | string    | v1      |
+---------------------+-------------------------------------------------------+-----------+---------+
|                     | The full hierarchy path                               |           |         |
| hierarchy           | for the item being                                    | string    | v1      |
|                     | exported                                              |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| username            | username of the user                                  | string    | v1      |
|                     |                                                       |           |         |
|                     | device/cucm/User.userid                               |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| first_name          | First name of the user                                | string    | v1      |
|                     |                                                       |           |         |
|                     | device/cucm/User.firstName                            |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| middle_name         | Middle name of the user                               | string    | v3      |
|                     |                                                       |           |         |
|                     | device/cucm/User.middleName                           |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| last_name           | Last name of the user                                 | string    | v1      |
|                     |                                                       |           |         |
|                     | device/cucm/User.lastName                             |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| email               | email address of the user                             | string    | v1      |
|                     |                                                       |           |         |
|                     | device/cucm/User.mailid                               |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+


.. tabularcolumns:: |p{3cm}|p{9cm}|p{2cm}|p{1.5cm}|

+---------------------+-------------------------------------------------------+-----------+---------+
| ELEMENT             | DESCRIPTION AND SOURCE FIELD                          | DATA TYPE | VERSION |
+=====================+=======================================================+===========+=========+
|                     | the profile assigned to                               |           |         |
| entitlement_profile | the user that defines the                             | string    | v1      |
|                     | features they are enabled                             |           |         |
|                     | to have configured                                    |           |         |
|                     |                                                       |           |         |
|                     | *release 19.3.4*                                      |           |         |
|                     |                                                       |           |         |
|                     | data/HcsUserProvisioningStatusDAT.entitlement_profile |           |         |
|                     |                                                       |           |         |
|                     | *release >= 21.1*                                     |           |         |
|                     |                                                       |           |         |
|                     | data/User.entitlement_profile                         |           |         |
|                     |                                                       |           |         |
|                     | or                                                    |           |         |
|                     |                                                       |           |         |
|                     | data/HcsUserProvisioningStatusDAT.entitlement_profile |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
|                     | The role assigned to the                              |           |         |
| role                | user - defines privileges                             | string    | v1      |
|                     | in the portal                                         |           |         |
|                     |                                                       |           |         |
|                     | data/User.role                                        |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
|                     | The security profile                                  |           |         |
|                     | assigned to the user -                                |           |         |
| credential_policy   | defined credential and                                | string    | v1      |
|                     | other security rules for                              |           |         |
|                     | portal access                                         |           |         |
|                     |                                                       |           |         |
|                     | data/User.account_information.credential_policy       |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| snr                 | Does the user have the SNR                            | boolean   | v1      |
|                     | service configured                                    |           |         |
|                     |                                                       |           |         |
|                     | device/cucm/RemoteDestinationProfile.userId           |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| voicemail           | Does the user have a                                  | boolean   | v1      |
|                     | voicemail box configured                              |           |         |
|                     |                                                       |           |         |
|                     | device/cuc/User.Alias                                 |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+
| title               | Subscriber's title                                    | string    | v2      |
|                     |                                                       |           |         |
|                     | *release 19.3.4*                                      |           |         |
|                     |                                                       |           |         |
|                     | data/NormalizedUser.title                             |           |         |
|                     |                                                       |           |         |
|                     | *>= release 21.1*                                     |           |         |
|                     |                                                       |           |         |
|                     | data/User.title                                       |           |         |
|                     |                                                       |           |         |
|                     | or                                                    |           |         |
|                     |                                                       |           |         |
|                     | data/NormalizedUser.title                             |           |         |
+---------------------+-------------------------------------------------------+-----------+---------+

.. tabularcolumns:: |p{3cm}|p{9cm}|p{2cm}|p{1.5cm}|


+------------------+---------------------------------------------+-----------+---------+
| ELEMENT          | DESCRIPTION AND SOURCE FIELD                | DATA TYPE | VERSION |
+==================+=============================================+===========+=========+
| department       | Subscriber's department                     | string    | v2      |
|                  |                                             |           |         |
|                  | device/cucm/User.department                 |           |         |
+------------------+---------------------------------------------+-----------+---------+
|                  | Subscriber's telephone                      |           |         |
| telephone_number | number as configured in                     | string    | v2      |
|                  | the CUCM user record                        |           |         |
|                  |                                             |           |         |
|                  | device/cucm/User.telephoneNumber            |           |         |
+------------------+---------------------------------------------+-----------+---------+
| pager_number     | Subscriber's pager number                   | string    | v3      |
|                  |                                             |           |         |
|                  | device/cucm/User.pagerNumber                |           |         |
+------------------+---------------------------------------------+-----------+---------+
| imp_enabled      | User enabled for Unified CM IM and Presence | boolean   | v4      |
|                  |                                             |           |         |
|                  | device/cucm/User.imAndPresenceEnable        |           |         |
+------------------+---------------------------------------------+-----------+---------+



Example

(Fields marked ``*`` are new in version 2, fields marked ``**`` are new in version 3, and fields marked ``***`` are for v4)

::
  
   [                                                            
      {                                                         
      *   "provider_name": "CS-P",                              
      *   "reseller_name": "CS-NB",                             
          "customer_name": "AAAGlobal",                         
          "division_name": "",                                  
          "location_name": "AAA-Boston",                        
          "hierarchy": "sys.hcs.CS-P.CS-NB.AAAGlobal.AAA-Boston",
          "username": "ba_user4",                               
          "first_name": "Dean",                                 
      **  "middle_name": "John",                                 
          "last_name": "Daniels",                               
          "voicemail": false,                                   
          "entitlement_profile": "AAAGlobal-Foundation-EP",     
          "snr": false,                                         
          "credential_policy": "HcsCredentialPolicy",           
          "role": "AAA-BostonSelfService",                      
          "email": "email@theinternet.com",
      *   "title": "Dr.",
      *   "department": "R&D",
      *   "telephone_number": "0215252020",
      **  "pager_number": "5551234545",
     ***  "imp_enabled": False
       }                                                        
   ]