Vault Loader allows you to perform bulk actions on users in your Vault.
Note: You can also use Vault Loader to create and update users with the User and Person objects. To learn about creating and updating User object records, see Vault Loader: Create, Update, & Delete Object Records. To learn about managing users with the User object, see Managing the User and Person Objects.
How to Load Users
Before loading users, prepare the CSV input file containing user field names and values.
To create, update, or upsert users:
- In the left panel of the Loader tab, click Load.
- For the CSV File, click Choose and select the CSV input file.
- In the Object Type drop-down, scroll to the Users & Groups section and select Users.
- In the Action Type drop-down, select Create, Update, or Upsert.
- Click Start Load.
Before processing the request, Vault validates the selected CSV file. If the file is valid, Vault begins processing the request. When finished, you’ll receive a Vault notification and email with request details and CSV output files.
Preparing CSV Input Files
The fields you include in your CSV will depend on your action: Create, Update, or Upsert. If you aren’t sure where to start, you can use the Extract option in Vault Loader to see what the CSV should look like.
Create Users
When creating new users, the following fields are required in all Vaults:
user_name__vuser_first_name__vuser_last_name__vuser_email__vuser_timezone__vuser_locale__vuser_language__vsecurity_policy_id__vvault_membership(sometimes required; see details)app_licensing(sometimes required; see details)
See example input.
Update Users
When updating users, you must specify the user id field. Vault uses IDs to locate the existing users that you want to update. See example input.
Upsert Users
The Upsert action is a combination of create and update. When using this action, you create one input CSV with all the fields required to create new users. For existing users, you must specify the user id, but you can leave other fields blank if the values should not change.
File Validation
Before beginning the Vault Loader job to create or update legacy users, Vault checks that the selected CSV file meets certain criteria:
- Is not empty
- Does not contain empty columns
- Includes a valid header row (Invalid header rows are those with no columns that match to metadata for the records you’re loading.)
If your file is not valid, Vault displays a notification, stops the process, and allows you to select a new CSV file. If some of the header columns do not match metadata for your Vault, the notification will allow you to stop the load or ignore those columns and proceed.
Vault Membership Assignments
User accounts exist at the domain level. For multi-Vault domains, this means that user details for a user (Thomas Chung, for example) are shared across all Vaults he can access.
If you are using the Update action to assign existing users to an additional Vault, you need to include vault_membership in your CSV. You must be a Domain Admin and Vault Owner to use this functionality. If users already exist at the domain level, Vault Owners can use Vault Loader to create users by using the User object.
The vault_membership field accepts multiple values in a specific format:
{Vault ID}:{User Status/active__v}:{Security Profile}:{License Type}
The only required value is Vault ID. If you leave the other values blank, Vault creates the user with default settings. To understand default settings, consider these two examples. Each produces the same result:
3003:true:document_user__v:full__v- Assigns to Vault 3003.
3003- Same as above.
The next two examples also produce the same result:
3003:true:system_admin__v:full__v- Assigned to Vault 3003 with
system_admin__vsecurity profile. 3003::system_admin__v- Same as above.
When assigning existing users to new Vaults, you do not need to include membership information for Vaults to which they already belong.
New Vault users only receive welcome emails if they are assigned to a Vault via the vault_membership field. For example, a new domain user who does not have any assigned Vaults will not receive a welcome email.
Assigning Users to Multiple Vaults
The next two examples add users to multiple Vaults in a domain.
3003,4004,5005- Assigns to Vaults 3003, 4004, and 5005 with default settings.
3003:false:read_only_user__v:read_only__v,4004,5005- Assigns to Vault 3003 as Inactive (
active:false), with Read Only User security profile and Read Only license type. Assigns to Vaults 4004 and 5005 with default settings.
Deactivating Users
The following example changes an existing user’s Vault membership status to Inactive when used with the Update action.
3003:false- Updates membership for Vault 3003 to Inactive.
Creating Users in Multi-Application Vaults
Users on a multi-application Vault (RIM, Clinical Operations, etc.) need to be assigned to specific applications and need a license type assignment for each. To set these values, use the app_licensing field. The app_licensing field accepts multiple values in a specific format:
{vault_id}|{application_name}:{active__v}:{license_type__v}
Possible values for {application_name} are:
rimSubsArch_vrimSubs_vrimReg_vrimSubsPublishing_vqualityQms_vqualityQdocs_vqOneQdocs_vqOneQms_vqualityTraining_vsafety_vsafetyDocs_vsafetyManagement_v
Assigning Users to Multiple Applications
To assign a user to multiple applications, separate the applications with a pipe. The following example adds a user to multiple applications within a Vault.
3003|rimReg_v:true:full__v|rimSubs_v:true:full__v- Assigns the user to the RIM Registrations and Rim Submissions applications in Vault 3003. The user is active and has the Full license type for both applications.
Assigning Users to Applications in Multiple Vaults
To assign a user to applications in multiple Vaults, separate the Vaults with a semicolon. The following example adds a user to multiple applications in multiple Vaults.
3003|rimReg_v:true:full__v|rimSubs_v:true:full__v,4112|rimSubs_v:true:full__v- Adds an active user to both RIM Registrations and RIM Submissions in Vault ID 3003, and to the RIM Submissions application in Vault ID 4112, all with the Full license type.
Suppressing Welcome Emails
When creating new users via Vault Loader, you can prevent Vault from sending welcome emails to a user by setting the user_needs_to_change_password__v setting to false. This does not work for users with SSO security profiles, but you can work around this limitation by creating the users with a basic security profile and updating them to the SSO security profile with an update action through Vault Loader. This prevents Vault from sending welcome emails until you run the update action.