Bulk Site Upload
A walkthrough of the bulk site upload functionalities on Dashboard.
Overview
Bulk site upload allows you to interact with sites by uploading a CSV file to the Dashboard.
- Bulk site creation is useful for creating new sites, allowing you to pass in any site field information as needed.
- Bulk site update is useful for making edits to your existing sites by passing in the
siteIdand relevant changes.
How to: bulk site creation
-
Navigate to the Sites tab and select
Create sites. -
Select
Bulk upload from a file. -
Download the template
sites.csvand add your data to sheet. Once ready, drag and drop your file to the modal. See here for full list of columns in the template.Note: do not populate the column
siteIdfor new site creation. This field is for site update.See here for file requirements.
-
If there are no issues in the file submitted, you will see a success indicator of a green check mark.
-
Warnings and Errors
-
If there are issues with the file, these will be treated as a global warnings and errors. Examples of global errors are file size limitations or encoding errors. See here for a full list of warnings and errors you may encounter.
-
If there are issues with the data you submitted, these will be treated as site level warnings and errors. _See here for a full list of warnings and errors you may encounter.
-
You can download the updated_sites.csv file which will now contain 2 additional columns: warnings and errors. These columns will contain recommendations to resolve the warnings and issues in each row.
Warnings may be ignored. These will not block you from submitting the data, but are flagged as irregularities from our side.
Errors may not be ignored. These are issues that must be fixed before we can accept the data.
Once all the errors have been resolved (warnings are optional), you can resubmit this same file with the two additional columns to resubmit the data. We will ignore the two additional columns so you do not need to remove them. Repeat this step as many times as necessary.
If there are still warnings, you will see an alert, but you can ignore these by selecting Skip. All sites will be created and viewable in the Sites tab of the Dashboard.
How to: bulk site update
Bulk site update follows the same workflow as bulk site creation in the Dashboard and utilizes the same template: sites.csv.
- In the template
sites.csv, add thesiteIdfor the site you want to update to the column namedsiteId. - On the same row, update any column with the desired new value. Any fields without a value will not be updated and remain as is.
- Follow the same steps as above for bulk site creation to submit the the file and address any warnings or errors as needed. All sites will be updated and viewable in the Sites tab of the Dashboard.
File requirements
- Supported file format: CSV only
- Maximum file size: 1 GB
- Maximum number of rows: 10,000
Template details: sites.csv
sites.csv- All field lengths have maximums of 255 characters excluding
siteIdand the enumerated fields.siteIdhas a value of 40 characters:sit_00000000-0000-0000-0000-000000000000.
| Field | Type | Required | Note |
|---|---|---|---|
siteName | string | TRUE* | Must be unique to your organization. *Not required if siteId is present for an update |
city | string | FALSE | |
country | string | FALSE | Use ISO 3166 country codes. |
postalCode | string | FALSE | |
region | string | FALSE | |
siteCode | string | FALSE | |
siteNumber | string | FALSE | |
subRegion | string | FALSE | |
state | string | FALSE | |
streetLine1 | string | FALSE | |
streetLine2 | string | FALSE | |
siteId | string | TRUE* | Required to update a site. *Not required to create a new site. Auto-generated value. |
area | integer | FALSE | Must be a positive value. |
numberOfStories | integer | FALSE | Must be a positive value. |
yearBuilt | integer | FALSE | Must be a positive value within 10 years of current year. |
hvacHeatType | enum (string) | FALSE | See enum list here. |
hvacCoolType | enum (string) | FALSE | See enum list here . |
hvacVentType | enum (string) | FALSE | See enum list here . |
heatingFuel | enum (string) | FALSE | See enum list here . |
buildingType | enum (string) | FALSE | See enum list here . |
buildingTypeGroup | enum (string) | FALSE | See enum list here . |
Deprecated fields
facilityType
facilityTypefacilityType has been deprecated in favor of buildingType. This field will not show up in the sites.csv template, but can be added as a column and accepted via the bulk upload if required for a legacy integration.
recipient
recipientrecipient has been deprecated from the primary list of fields for a site. This field will not show up in the sites.csv template, but can be added as a column and accepted via the bulk upload if required for a legacy integration.
meterIds
meterIdsmeterIds has been deprecated from the create and update site flows. New site-to-meter mapping flows in the Dashboard coming in Q4 2024!
Warnings
Warnings may be ignored. They are flagged as irregularities from Arcadia's perspective.
| Name | Description | Classification | Remedy |
|---|---|---|---|
UNUSED_COLUMNS | Columns in spreadsheet are unused | Global | N/A-- confirm data is not missing or column name is as expected |
DUPLICATE_ADDRESS | Two sites with the same address | Site | N/A-- we recommend defining each site as a location with a unique address. |
Errors
| Name | Classification | Remedy |
|---|---|---|
FILE_SIZE_TOO_LARGE | Global | File is too large. The maximum file size is 1GB. |
INVALID_CSV | Global | Use the template provided to ensure file is a CSV |
INVALID_ENCODING | Global | File has an invalid file encoding. We only support UTF-8 encoded files. |
TOO_MANY_ROWS | Global | Too many sites in File. Reduce number of records to 10,000 |
MISSING_REQUIRED_COLUMN | Global | Review CSV file and ensure column name is present. Frontend global error. |
NO_DATA_IN_FILE | Global | No sites in file. Add at least 1 site to the CSV file |
ERROR_OTHER | Global | Open a support ticket on Zendesk to look into the unexpected error |
SITE_DOES_NOT_EXIST | Site | No site with the specified ID was found. |
SITE_ALREADY_EXISTS | Site | A site with the same name already exists. Choose a different site name. |
MISSING_REQUIRED_FIELD | Site | Review the required fields here. |
INVALID_VALUE | Site | Review the field types and valid values here. |
DUPLICATE_SITENAME_IN_FILE | Site | Two or more sites in the file have the same site name. Remove duplicates. |
Updated 1 day ago