HomeGuidesAPI ReferenceChangelog
Log In
Guides

Bulk Meter Mapping Upload

A walkthrough of the bulk meter mapping upload functionalities on Dashboard.

Suggest Edits

Overview

Bulk meter mapping upload allows you to streamline meter-to-site mapping by uploading a CSV file to the Dashboard with pre-existing meter or expected mete associations. The benefit of this feature is that it saves you time from associating meters to sites one by one. If you know a set of meters you expect to map in advance, you can define those mappings at one time rather than having to return to the platform to check if all of your meters have been found yet.

How to: bulk meter map

  1. Navigate to the sites tab and select the sub-navigation tab named management.

  2. Select Upload meter mappings.

  3. Download the template meterMappings.csv and 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.

    See here for file requirements.

  4. If there are no issues in the file submitted, you will see a success indicator of a green check mark.

  5. Warnings and Errors

    1. 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.

    2. 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_meterMappings.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 meter mappings will be created 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: meterMappings.csv

All field lengths have maximums of 255 characters excluding siteId, meterId, providerId and the enumerated fields. siteId, meterId, and providerId have a value of 40 characters: sit_00000000-0000-0000-0000-000000000000, mtr_00000000-0000-0000-0000-000000000000, prd_00000000-0000-0000-0000-000000000000.

FieldTypeRequiredNote
siteIdstringTRUE
meterIdstringTRUE*To create a meter-to-site mapping, ONE of meterId or meterNumber is required.
meterNumberstringTRUE*To create a meter-to-site mapping, ONE of meterId or meterNumber is required.
serviceTypeenumFALSEIf you expect multiple meters with the same meterNumber, you can specify the serviceType to map only the specified meter desired. This is most common with water or sewer meters.

If you want any meter of a given meterNumber regardless of serviceType to be mapped, you can leave this blank and the first meter with this meter number we find will be mapped accordingly.
providerIdstringTRUE*To create a meter-to-site mapping, ONE of providerId, providerName, or website is required if meterId is not provided.
providerNamestringTRUE*To create a meter-to-site mapping, ONE of providerId, providerName, or website is required if meterId is not provided.
websitestringTRUE*To create a meter-to-site mapping, ONE of providerId, providerName, or website is required if meterId is not provided.

providerName and website matching

Read more about providerName and website matching here.

serviceType enumerated list

Read more about supported service types here.

  • chilled_water
  • district_heat
  • electric
  • fuel_oil
  • internet
  • irrigation
  • landline_phone
  • lighting
  • natural_gas
  • other_service_type
  • propane
  • sanitation
  • sewer
  • steam
  • telecom
  • television
  • water

Warnings

Warnings may be ignored. They are flagged as irregularities from Arcadia's perspective.

NameDescriptionClassificationRemedy
UNUSED_COLUMNSColumns in spreadsheet are unusedGlobalN/A-- confirm data is not missing or column name is as expected
EXPECTED_METER_ALREADY_EXISTSMeter number already exists and may be associated to a site already. It will now be associated to the site specified.Meter MappingN/A-- meter mapping will be updated.
METER_ALREADY_MAPPEDMeter is already associated with another site. Proceeding will update the site association.Meter MappingN/A-- meter mapping will be updated

Errors

NameClassificationRemedy
FILE_SIZE_TOO_LARGEGlobalFile is too large. The maximum file size is 1GB.
INVALID_CSVGlobalUse the template provided to ensure file is a CSV.
INVALID_ENCODINGGlobalFile has an invalid file encoding. We only support UTF-8 encoded files..
TOO_MANY_ROWSGlobalToo many records in file. Reduce number of records to 10,000.
MISSING_REQUIRED_COLUMNGlobalReview CSV file and ensure one of the required fields is present. Frontend global error.
NO_DATA_IN_FILEGlobalNo data in file. Add at least 1 record to the CSV file.
ERROR_OTHERGlobalOpen a support ticket on Zendesk to look into the unexpected error.
MISSING_REQUIRED_FIELDMeter MappingReview the required fields here. Errors will relate to siteId; meterNumber or meterId;providerId, providerName, or website.
INVALID_VALUEMeter MappingReview the field types and valid values here.
PROVIDER_DOES_NOT_EXISTMeter MappingNo provider with this ID, name, or website was found. Please check and try again.
INEXACT_MATCH_PROVIDER_NAMEMeter MappingThe provider name supplied is not an exact match in our system. Review the suggestions provided in the updated_meterMappings.csv file. Our full list available via List Providers or the Provider Coverage page.
INEXACT_MATCH_WEBSITEMeter MappingThe provider website supplied is not an exact match in our system. Review the suggestions provided in the updated_meterMappings.csv file. Our full list available via List Providers or the Provider Coverage page.
METER_ALREADY_EXPECTEDMeter MappingAn existing site is already anticipating the specified meter number. Remove it from the existing site or remove it from the CSV column.
DUPLICATE_METER_NUMBER_IN_FILEMeter MappingThis record already exists in the current file. Remove the duplicate.
DUPLICATE_METER_ID_IN_FILEMeter MappingThis record already exists in the current file. Remove the duplicate.
SITE_DOES_NOT_EXISTMeter MappingNo site with the specified ID was found.
METER_DOES_NOT_EXISTMeter MappingNo meter with the specified ID was found.
ERROR_OTHERMeter MappingOpen a support ticket on Zendesk to look into the unexpected error

Updated 2 days ago

What’s Next