.. _site_data_export:

Site Data Export
----------------


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

Layout:


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

+------------------------+-----------------------------------------------------------------------+--------+------+
| ELEMENT                | DESCRIPTION AND SOURCE FIELD                                          | DATA   | VER. |
|                        |                                                                       | TYPE   |      |
+========================+=======================================================================+========+======+
| 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                                                              |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| customer_address1      | Address string 1 for the                                              | string | v1   |
|                        | customer                                                              |        |      |
|                        |                                                                       |        |      |
|                        | device/hcmf/Customer.contactAddress1                                  |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| customer_address2      | Address string 2 for the                                              | string | v1   |
|                        | customer                                                              |        |      |
|                        |                                                                       |        |      |
|                        | device/hcmf/Customer.contactAddress2                                  |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| customer_address3      | Address string 3 for the                                              | string | v1   |
|                        | customer                                                              |        |      |
|                        |                                                                       |        |      |
|                        |                                                                       |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| location_address1      | Address string 1 for the                                              | string | v1   |
|                        | site                                                                  |        |      |
|                        |                                                                       |        |      |
|                        | data/BaseSiteDAT.Address1                                             |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| location_address2      | Address string 2 for the                                              | string | v1   |
|                        | site                                                                  |        |      |
|                        |                                                                       |        |      |
|                        | data/BaseSiteDAT.Address2                                             |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| location_address3      | Address string 3 for the                                              | string | v1   |
|                        | site                                                                  |        |      |
|                        |                                                                       |        |      |
|                        | data/BaseSiteDAT.Address3                                             |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
|                        | External emergency                                                    |        |      |
| emergency_number       | callback number assigned                                              | string | v1   |
|                        | to the site                                                           |        |      |
|                        |                                                                       |        |      |
|                        | data/DpSite.emerNumber                                                |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| ndl                    | The NDL name that the site                                            | string | v1   |
|                        | uses                                                                  |        |      |
|                        |                                                                       |        |      |
|                        | data/Ndl.ndl.name                                                     |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
|                        | Digit dialled to prefix                                               |        |      |
| inter_site_prefix      | intersite calls (if the                                               | string | v1   |
|                        | dial plan is setup that                                               |        |      |
|                        | way)                                                                  |        |      |
|                        |                                                                       |        |      |
|                        | data/DpCustomer.isp                                                   |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
|                        | Digit dialled to make                                                 |        |      |
| external_access_prefix | external calls (if the                                                | string | v1   |
|                        | dial plan is setup that                                               |        |      |
|                        | way)                                                                  |        |      |
|                        |                                                                       |        |      |
|                        | data/DpSite.ext                                                       |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
|                        | Dial Plan site code                                                   |        |      |
| site_code              | assigned to the site (if                                              | string | v1   |
|                        | the dial plan is setup                                                |        |      |
|                        | that way)                                                             |        |      |
|                        |                                                                       |        |      |
|                        | data/DpSite.slc                                                       |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
|                        | External published                                                    |        |      |
| published_number       | callback number assigned                                              | string | v1   |
|                        | to the site                                                           |        |      |
|                        |                                                                       |        |      |
|                        | data/DpSite.pubNumber                                                 |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| country_code           | Country code identifying                                              | string | v1   |
|                        | the site                                                              |        |      |
|                        |                                                                       |        |      |
|                        | data/Countries.international_dial_code                                |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+

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

+------------------------+-----------------------------------------------------------------------+--------+------+
| ELEMENT                | DESCRIPTION AND SOURCE FIELD                                          | DATA   | VER. |
|                        |                                                                       | TYPE   |      |
+========================+=======================================================================+========+======+
| external_id            | An externally defined ID                                              | string | v2   |
|                        | for the site                                                          |        |      |
|                        |                                                                       |        |      |
|                        | device/hcmf/CustomerLocation.externalID                               |        |      |
|                        |                                                                       |        |      |
|                        | OR                                                                    |        |      |
|                        |                                                                       |        |      |
|                        | data/GS_LinkedSiteData_DAT.externalID                                 |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+
| extended_name          | An expanded name for the                                              | string | v2   |
|                        | site                                                                  |        |      |
|                        |                                                                       |        |      |
|                        | device/hcmf/CustomerLocation.extendedName                             |        |      |
|                        |                                                                       |        |      |
|                        | OR                                                                    |        |      |
|                        |                                                                       |        |      |
|                        | data/GS_LinkedSiteData_DAT.extendedName                               |        |      |
+------------------------+-----------------------------------------------------------------------+--------+------+


* ELEMENT: voice_bandwidth

  * DESCRIPTION: voice bandwidth allocation for the site
  * SOURCE FIELD: device/cucm/Location.betweenLocations.betweenLocation.audioBandwidth
  * DATA TYPE: string
  * VERSION: v1

* ELEMENT: video_bandwidth

  * DESCRIPTION: video bandwidth allocation for the site
  * SOURCE FIELD: device/cucm/Location.betweenLocations.betweenLocation.videoBandwidth
  * DATA TYPE: string
  * VERSION: v1


Example:

(* marked fields are new in version 2)

::

   
   [                                                                   
      {                                                                
       *  "provider_name": "CS-P",                                     
       *  "reseller_name": "CS-NB",                                    
           "customer_name": "Varidion",                                
          "division_name": "",                                         
          "location_name": "Varidion-Reading",                         
          "hierarchy": "sys.hcs.CS-P.CS-NB.Varidion.Varidion-Reading", 
          "customer_address1": "Varidion New York (Head Office)",      
          "customer_address2": "L23, 33 Central Square",               
          "customer_address3": "Dallas,TX, USA",                       
          "ndl": "GS-R3-VDN-CL1-NDL",                                  
          "inter_site_prefix": "",                                     
          "site_code": "",                                             
          "video_bandwith": "",                                        
          "emergency_number": "",                                      
          "voice_bandwith": "",                                        
          "country_code": "44",                                        
          "external_access_prefix": "",                                
          "location_address1": "Varidion Reading",                     
          "location_address3": "Reading, Berkshire",                   
          "location_address2": "Atlantic House, Imperial Way",         
          "published_number": "",                                      
        * "external_id": "ABCXYZ",                                     
        * "extended_name": "UK IT"                                     
       }                                                               
   ]