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.
- Bulk credential creation is useful for creating new credential records, allowing you to pass in any credential field information as needed.
- 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
-
Navigate to the credentials tab and select
Add credentials
. -
Select
Bulk upload credentials from a file
. -
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.
-
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 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
.
- In the template
credentials.csv
, add thecredentialId
for the credential you want to update to the column namedcredentialId
. - 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.
- 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
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
andproviderId
has a value of 40 characters:prv_00000000-0000-0000-0000-000000000000
.
Field | Type | Required | Note | Can Update? |
---|---|---|---|---|
providerId | string | TRUE* | To create a credential, ONE of providerId , providerName , or website is required.You cannot update an existing credential's provider ID. | FALSE |
providerName | string | TRUE* | To create a credential, ONE of providerId , providerName , or website is required.You cannot update an existing credential's provider name. | FALSE |
website | string | TRUE* | To create a credential, ONE of providerId , providerName , or website is required.You cannot update an existing credential's website. | FALSE |
credentialId | string | TRUE* | Required to update a credential. *Not required to create a credential. | FALSE |
username | string | FALSE | Required username and password fields vary by provider. Check the List Providers endpoint to see which fields are required for a given provider. New provider coverage page in the Dashboard with provider required fields coming this year! | TRUE |
username2 | string | FALSE | TRUE | |
password | string | FALSE | TRUE | |
password2 | string | FALSE | TRUE | |
username3 | string | FALSE | TRUE | |
password3 | string | FALSE | TRUE | |
username4 | string | FALSE | TRUE | |
password4 | string | FALSE | TRUE | |
correlationId | string | FALSE | Optional field, read more about correlation IDs here. | TRUE |
isActive | boolean | FALSE | Used 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. Reenroll functionality coming in October! | TRUE |
providerName
and website
matching
providerName
and website
matchingOverview
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
orwebsite
is a perfect match, we will accept the value and replace it with its associatedproviderId
. - If
providerName
orwebsite
return only one match, we will accept the value and replace it with its associatedproviderId
. - If
providerName
orwebsite
return only more than one potential match, we perform a fuzzy match and return a list of up to 5 suggestions with their associatedproviderId
in the columnerror
. You can select one of these to use in theproviderId
column if it is the provider you are looking for.- If none of the suggestions meet your needs, you can review the List Providers endpoint or check our Provider Coverage page coming in October!
- If
providerName
orwebsite
do not return any potential matches, we will return a message in theerror
column that theproviderName
orwebsite
does not exist. You can review the List Providers endpoint or check our Provider Coverage page coming in October!
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 |
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 credentials in file. Reduce number of records to 10,000 |
MISSING_REQUIRED_COLUMN | Global | Review CSV file and ensure one of the required fields is present. Frontend global error. |
NO_DATA_IN_FILE | Global | No credentials in file. Add at least 1 credential to the CSV file |
ERROR_OTHER | Global | Open a support ticket on Zendesk to look into the unexpected error |
MISSING_PROVIDER_IDENTIFIER | Credential | Review CSV file and ensure one of the required fields is present. |
CREDENTIAL_DOES_NOT_EXIST | Credential | No credential with the specified ID was found. |
PROVIDER_DOES_NOT_EXIST | Credential | No provider with this ID, name, or website was found. Please check and try again. |
INEXACT_MATCH_PROVIDER_NAME | Credential | The provider name supplied is not an exact match in our system. Review the suggestions provided in the updated_credentials.csv file our full list available via List Providers.New provider coverage page in the Dashboard coming this year! |
INEXACT_MATCH_WEBSITE | Credential | The website URL supplied is not an exact match in our system. Review the suggestions provided in the updated_credentials.csv file our full list available via List Providers .New provider coverage page in the Dashboard coming this year! |
PROVIDER_NOT_SUPPORTED | Credential | The provider specified is not currently supported at this time. Open a support ticket on Zendesk for additional questions. |
INVALID_IS_ACTIVE | Credential | Is 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_EXISTS | Credential | A credential with the same name already exists. |
DUPLICATE_CREDENTIAL_IN_FILE | Credential | This record already exists in the current file. Remove the duplicate. |
MISSING_REQUIRED_FIELD | Credential | Review the required fields here. Errors will relate to the username/2/3/4 and password/2/3/4 fields. |
INVALID_VALUE | Credential | Review the field types and valid values here. |
ERROR_OTHER | Credential | Open a support ticket on Zendesk to look into the unexpected error |
Updated 20 days ago