Before starting an upload, make sure you have read the information available in the Introduction to TDI and Importing data with TDI articles and followed the guidance provided.
Mandatory file:
Optional file:
Prerequisites:
None required. However, if you intend to assign multiple users to a single group, the Group entity must be uploaded before uploading the files in this entity. In this case, treat the optional group.csv file below as a mandatory file.
Important Note: Fields bolded and marked with an asterisk (*) are mandatory.
Filename: user.csv
|
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
|
id* |
Unique system ID for the entity. This ID is used anytime you would like to make updates or changes to the user in TDI or when using TDI to associate additional details to the user. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot have blank spaces. Otherwise, no character restrictions. |
|
name* |
The user’s full name. |
- |
Required. |
No character restrictions. |
|
title |
The job or working title of the user. |
- |
- |
No character restrictions. |
|
permission* |
The permission level assigned to the user. |
Super Admin Contributor Editor Owner Admin Viewer Financial Admin Operator Custom role |
If you are uploading any non-admin users, you must also add each user to a group using the group.csv optional file for the user entity. Note: Custom roles must be created in your Turvo tenant before they can be used in TDI. |
Enter the corresponding role from the previous column. |
|
status.code |
The status of the user account. |
Active: 2450 Suspended: 2451 Deleted: 2452 |
Upon initial upload, users should typically be added in Active status. |
Use the appropriate four-digit code in the Values/Codes column to indicate the appropriate user account status. |
|
timezone* |
The user’s timezone. This impacts how times are displayed in Turvo. |
- |
Required. |
Format: Country/City_Name Examples: America/New_York America/Chicago America/Los_Angeles |
|
userEmail* |
The user’s email address. This is used as their username in Turvo. |
- |
Required to create a new user. A signup email will be sent to this address. Additional email addresses for the user can be configured in the optional communication_channel.csv upload file. |
Standard email format. |
Filename: communication_channel.csv
|
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
|
id* |
The unique system ID used by TDI for the communication method being added to a user account. This ID must be used if the communication method is ever updated using TDI. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot have blank spaces. Otherwise, no character restrictions. |
|
contextId* |
The ID for the user the communication method is associated with. |
User IDs are found in the ID column of the user.csv file. |
Required. |
Must match the user ID exactly. |
|
email.type |
The type of email address. |
Home email: 1095 Work email: 1097 Other email: 1098 |
Required if adding an email address. |
Enter the corresponding four-digit code listed in the Values/Codes column. |
|
|
An additional email address (other than the primary email established in user.csv) for the User. |
- |
- |
Standard email format. |
|
phone.type |
The type of phone number (work, home, etc.) |
Work phone: 1015 Fax: 1016 Other phone: 1018 Mobile phone: 1019 Home phone: 1080 |
- |
Enter corresponding code. Required if entering phone. |
|
phone |
The user’s phone number. |
- |
- |
Integers only - No dashes or parentheses. Example: 3135551500 |
|
phone. extension |
The phone number's extension. |
- |
- |
Integers only. |
|
phone.country |
The phone number's country of origin. |
Find and enter the two-letter country code found in the Country Code chart. |
- |
Examples: US CA |
|
address.type |
The type of physical address associated with the user. |
Home address: 1181 Work address: 1182 Other address: 1183 |
Required if an address is added. |
Entering corresponding four-digit code listed in the Values/Codes column. |
|
address.line1 |
The first line of the user's address. |
- |
- |
No character restrictions. |
|
address.line2 |
The second line of the user's address (if applicable). |
- |
- |
No character restrictions. |
|
address.city |
The user address's city. |
- |
- |
No character restrictions. |
|
address.state |
The name or abbreviation of the user address's state/province. |
- |
- |
No character restrictions. |
|
address.zip |
The zip code or postal code of the user address. |
- |
Must be a valid zip code. |
No character restrictions. Examples: 72748, 72748-9067, M5V 3T4
|
|
address.country |
The name of the user address's country. |
- |
Required if an address is added. |
Enter the name of the country, not the country code. Examples: “United States” or “Canada”. |
|
IsPrimary |
Indicates whether the address identified in the address.type through address.country columns is the primary address for the User. |
True/False |
Only one address is allowed as the primary. |
Enter True if primary and False if not primary. |
|
IsPrimaryEmail |
Indicates whether the email address identified in the email.type through email.country columns is the primary email address for the User. |
True/False |
Only one email address is allowed as the primary. By default, the email address provided in user.csv will be marked as the primary. |
Enter True if primary and False if not primary. |
|
IsPrimaryPhone |
Indicates whether the phone number identified in the phone.type through phone.country columns is the primary phone number for the User. |
True/False |
Only one phone number is allowed as the primary. |
Enter True if primary and False if not primary. |
Filename: group.csv
Note: If you intend to assign multiple users to a single group, this file will be required. To ensure it functions properly, you will need to upload the following files in this order:
- The group.csv file in the Group entity
- The user.csv file in the User entity
- This file.
If you do not intend to assign multiple users to a single group, this file is optional. Each user will be assigned to a unique group.
|
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
|
id* |
The unique system ID for the row in the upload sheet where the user is assigned to a group. This is not the group ID itself. This ID is used anytime you would like to make updates or changes to a user's groups in TDI. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot contain spaces. Otherwise, no character restrictions. |
|
contextId* |
The ID for the user who is being added to the group. |
Find and enter the reference ID for the user in the ID column of the user.csv upload sheet. |
Required. |
Must match the user ID exactly. |
|
groupId* |
The ID for the group the user is being added to. |
Find the group’s reference ID in the ID column of the group.csv upload sheet. |
Required. |
Must match the group ID exactly. |
|
permission |
This is the permission level that the user should have within this group. |
Contributor Editor Owner Admin Viewer Financial Admin Operator Custom role |
Note: Custom roles must be created in your Turvo tenant before they can be used in TDI. |
Enter the name of the desired permission level as listed in the Values/Codes column. |
<%= heading %>