CSV file guidelines

IMPORTANT:

  • CSV Format : Spaces must be qualified with "" in order to be accepted
  • When using a CSV file for exclusions, all exclusions must be in the import file. Exclusions configured in the job JSON will be ignored
  • Account Map & Group Map must be created separately; cannot be combined in one file

Important CSV Template Information

If you receive an error when importing a CSV file, the file does not meet the expected format. Compare your file to the sample files provided, and edit the file before attempting to import it again.  

DownloadNetwork File Share (NFS) Account Map Sample CSV

  • The domain must be escaped with additional backslash when creating the account map
  • Example:
    • user DataHub\JoeSmith would need to be DataHub\\JoeSmith
  • If the map doesn’t contain an email address in the source_name or destination_name field, it must contain a name in the corresponding id field (source_id or destination_id) in order for DataHub to properly map the user. The example map below illustrates how to use the id field when an email address is not provided as a name.

NFS Account Map | .csv with example values

source_id,source_username,source_name,source_caption,destination_id,destination_username,destination_name,destination_caption
"DataHub\\JoeSmith","","","Joe Smith","","","jsmith@company.com","Joe Smith"
"DataHub\\JaneDoe","","","Jane Doe","","","jdoe@company.com","Jane Doe"

Download - Account Map Sample CSV

Account Map | .csv with example values

source_id,source_username,source_name,source_caption,destination_id,destination_username,destination_name,destination_caption
"","","user00000@DataHub.com","user 00000","","","user00000@test.com","user 00000"
"","","user00001@DataHub.com","user 00001","","","user00001@test.com","user 00001"
"","","user00002@DataHub.com","user 00002","","","user00002@test.com","user 00002"
"","","user00003@DataHub.com","user 00003","","","user00003@test.com","user 00003"
"","","user00004@DataHub.com","user 00004","","","user00004@test.com","user 00004"
"","","user00005@DataHub.com","user 00005","","","user00005@test.com","user 00005"

If the map doesn’t contain an email address in the source_name or destination_name field, it must contain a name in the corresponding id field (source_id or destination_id) in order for DataHub to properly map the user. The example map below illustrates how to use the id field when an email address is not provided as a name.

Account Map | .csv with example without email

source_id,source_username,source_name,source_caption,destination_id,destination_username,destination_name,destination_caption
"user00000","","","user00000","","","user00000@test.com","user00000"
"user00001","","","user00001","","","user00001@test.com","user00001"
"user00002","","","user00002","","","user00002@test.com","user00002"
"user00003","","","user00003","","","user00003@test.com","user00003"
"user00004","","","user00004","","","user00004@test.com","user00004"
"user00005","","","user00005","","","user00005@test.com","user00005"

Download | Account Map Exclusions Sample CSV

Account Map | .csv with example values

id,username,name,caption
"","user00000","user00000@DataHub.com",""
"","user00001","user00001@DataHub.com",""

If the map doesn’t contain an email address in the name field, it must contain a name in the id field in order for DataHub to properly map the user. The example map below illustrates how to use the id field when an email address is not provided as a name.

Account Map | .csv with example without email

id,username,name,caption
"user00000","user00000","",""
"user00001","user00001","",""

Download - Group Map Sample CSV

If the map doesn’t contain an email address in the source_name or destination_name field, it must contain a name in the corresponding id field (source_id or destination_id) in order for DataHub to properly map the user. The example map below illustrates how to use the id field when an email address is not provided as a name.

Group Map | .csv with example values

source_id,source_username,source_name,source_caption,group_source,destination_id,destination_username,destination_name,destination_caption,group_destination
"Box_Group1","Box_Group1","","","","","Box_Group1","Box_Group1@domain.onmicrosoft.com"
"Box_Group3","Box_Group2","","","","","Box_Group2","Box_Group2@domain.onmicrosoft.com"
"Box_Group1","Box_Group3","","","","","Box_Group3","Box_Group3@domain.onmicrosoft.com"

Download - Group Map Exclusions Sample CSV

Group Map | .csv with example values

id,username,name,caption,location
"123456789,"",Group 1,"",source
"","",Group 2,"",destination

The tips below can be helpful in creating a CSV file from scratch, but if you're using the UI, you could create one exclusion entry into your mapping manually, then download the exclusions file to have a real world example to work with.

Related Links