Export Jobs: Catalog Interface
Table of Contents
Once you have set up your export jobs in the platform (see Export Jobs: Setup), each job invocation will create a data file/stream. The service supports Four types of data: Catalog, Measurements, Pulse Meter Measurements, and Pan42 Measurements. This guide will discuss what to expect in the Catalog export job type.
Meta Data - Catalog
The Catalog interface describes the structure of the monitored account. An account can have multiple sites, where each site can have multiple zones, multiple zones can have multiple panels and panels can have multiple devices. This data refers to the physical location and division of devices over the account's assets. In addition, the electrical hierarchy of the devices is also represented in the Catalog.
| Name | Description |
|---|---|
| id | A unique identifier of an entity in the software. The ID can be either a site or device ID. In V1.1 the ID could be an account also |
| name | The entity’s name as assigned at installation time. |
| type | The entity type; this can be either “Site” or “Device”. |
| parent_id | The current entity parent ID in the hierarchy tree. |
| panel_id | A unique identifier of the physical panel in the software, in which the device is located. Note that a single zone can contain multiple panels. |
| panel_name | The panel’s name as assigned at installation time. For example, "Panel 54-A". |
| zone_id | A unique identifier of the physical zone in the software in which the device is located. Note that a single site can contain multiple zones. |
| zone_name | The zone’s name as assigned at installation time. For example, "Accounting department". |
| site_id | A unique identifier of the physical site in the software, in which the device is located. |
| site_name | The site’s name as assigned at installation time. For example, “New York site". |
| device_category | The type of device according to its group main functionality. |
| device_type | The type of device according to its main functionality. |
| electrical_type | The device number of phases and deployed sensors. |
| description | The entity’s description as assigned at installation time. |
CSV Catalog Example
Below are examples of the two versions available for the Catalog export job option: