HomeGuidesAPI ReferenceChangelog
Log In
Guides

Bulk Credential Upload

A walkthrough of the bulk credential upload functionalities on Dashboard.

Overview

Bulk credential upload allows you to interact with credentials by uploading a CSV file to the Dashboard.

  1. Bulk credential creation is useful for creating new credential records, allowing you to pass in any credential field information as needed.
  2. Bulk credential update is useful for making edits to your existing credentials by passing in the credentialId and relevant changes.

How to: bulk credential creation

  1. Navigate to the credentials tab and select Add credentials.

  2. Select Bulk upload credentials from a file.

  3. Download the template credentials.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.

    Note: do not populate the column credentialId for new credential creation. This field is for credential update.

    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 credential level warnings and errors. _See here for a full list of warnings and errors you may encounter.

You can download the updated_credentials.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 credentials will be created and viewable in the credentials tab of the Dashboard.

How to: bulk credential update

Bulk credential update follows the same workflow as bulk credential creation in the Dashboard and utilizes the same template: credentials.csv.

  1. In the template credentials.csv, add the credentialId for the credential you want to update to the column named credentialId.
  2. 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. See the template for a full list of fields that can be updated.
  3. Follow the same steps as above for bulk credential creation to submit the the file and address any warnings or errors as needed. All credentials will be updated and viewable in the credentials tab of the Dashboard.

File requirements

  • Supported file format: CSV only
  • Maximum file size: 1 GB
  • Maximum number of rows: 10,000

Template details: credentials.csv

  • All field lengths have maximums of 255 characters excluding credentialId, providerId, and the boolean field. credentialId has a value of 40 characters:crd_00000000-0000-0000-0000-000000000000 and providerId has a value of 40 characters:prv_00000000-0000-0000-0000-000000000000.
FieldTypeRequiredNoteCan Update?
providerIdstringTRUE*To create a credential, ONE of providerId, providerName, or website is required.

You cannot update an existing credential's provider ID.
FALSE
providerNamestringTRUE*To create a credential, ONE of providerId, providerName, or website is required.

You cannot update an existing credential's provider name.
FALSE
websitestringTRUE*To create a credential, ONE of providerId, providerName, or website is required.

You cannot update an existing credential's website.
FALSE
credentialIdstringTRUE*Required to update a credential.
*Not required to create a credential.
FALSE
usernamestringFALSERequired username and password fields vary by provider. Check the List Providers endpoint to see which fields are required for a given provider or the Provider Coverage page.TRUE
username2stringFALSETRUE
passwordstringFALSETRUE
password2stringFALSETRUE
username3stringFALSETRUE
password3stringFALSETRUE
username4stringFALSETRUE
password4stringFALSETRUE
correlationIdstringFALSEOptional field, read more about correlation IDs here.TRUE
isActivebooleanFALSEUsed to enroll (TRUE) or unenroll (FALSE) a Credential.

If you unenroll a Credential, it will unenroll ALL Accounts and Meters.

If you reenroll a Credential, it will enroll ALL Accounts, but it will not enroll any Meters.
TRUE

providerName and website matching

Overview

For creating new credential records using providerName and website, you can put a "close enough" value in either column if you do not know the providerId.

  • If providerName or website is a perfect match, we will accept the value and replace it with its associated providerId.
  • If providerName or website return only one match, we will accept the value and replace it with its associated providerId.
  • If providerName or website return only more than one potential match, we perform a fuzzy match and return a list of up to 5 suggestions with their associated providerId in the column error. You can select one of these to use in the providerId column if it is the provider you are looking for.
  • If providerName or website do not return any potential matches, we will return a message in the error column that the providerName or website does not exist. You can review the List Providers endpoint or the Provider Coverage page.

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

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 credentials 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 credentials in file. Add at least 1 credential to the CSV file
ERROR_OTHERGlobalOpen a support ticket on Zendesk to look into the unexpected error
MISSING_PROVIDER_IDENTIFIERCredentialReview CSV file and ensure one of the required fields is present.
CREDENTIAL_DOES_NOT_EXISTCredentialNo credential with the specified ID was found.
PROVIDER_DOES_NOT_EXISTCredentialNo provider with this ID, name, or website was found. Please check and try again.
INEXACT_MATCH_PROVIDER_NAMECredentialThe provider name supplied is not an exact match in our system. Review the suggestions provided in the updated_credentials.csvfile our full list available via List Providers or the Provider Coverage page.
INEXACT_MATCH_WEBSITECredentialThe website URL supplied is not an exact match in our system. Review the suggestions provided in the updated_credentials.csvfile. Our full list available via List Providers or the Provider Coverage page.
PROVIDER_NOT_SUPPORTEDCredentialThe provider specified is not currently supported at this time. Open a support ticket on Zendesk for additional questions.
INVALID_IS_ACTIVECredentialIs Active is only valid to be used in order to update an existing credential and all accounts beneath it-- not in new credential creation. Specify the credential ID to update and resubmit.
CREDENTIAL_ALREADY_EXISTSCredentialA credential with the same name already exists.
DUPLICATE_CREDENTIAL_IN_FILECredentialThis record already exists in the current file. Remove the duplicate.
MISSING_REQUIRED_FIELDCredentialReview the required fields here. Errors will relate to the username/2/3/4 and password/2/3/4 fields.
INVALID_VALUECredentialReview the field types and valid values here.
ERROR_OTHERCredentialOpen a support ticket on Zendesk to look into the unexpected error

What’s Next