

To download Community files linked to the documentation site, make sure you're logged in with your valid Relativity Community credentials.
Click the Community file link.
Enter your credentials on the Community login screen that appears.
The file will download to the bottom left corner of your screen.
The file will download automatically to the bottom left corner of your screen when you click the link.
If you encounter a "URL No Longer Exists" error after clicking a Community link, it might signal a single sign-on error related to the SAML Assertion Validator. Reach out to your IT department for assistance.
The Relativity User Import Application allows you to efficiently manage multiple users: import them from CSV files, including their Relativity settings, and export lists of them with their settings for backup or transfer.
You can find all versions of this solution on the Community via this User Import Application search string You must be logged in to the Community for that string to return results.
The Relativity User Import Application includes the following components:
Passwords and Authentication:
Passwords are not imported or exported. Imported users with default password providers must use the "Forgot your password?" link to create a new password.
Only Default Password Provider and Default Integration Authentication Provider are supported. Other authentication types won't be imported or exported.
System Administrators can restrict password resets for imported users by setting the "CanChangePassword" column to "FALSE" in the import file.
Login Methods:
Unsupported login methods (e.g., Default RSA Provider) are not imported or exported. Users with unsupported methods will be imported without login methods and must use the "Forgot your password?" workflow to create a new password.
Partial Imports and Errors:
Partial imports indicate a user creation step failed. Validate the user's information and login methods, update as needed, or remove and retry the import.
Worker queue records are removed as job errors are recorded. The total imported/exported records may not be accurate until job completion.
Other Considerations:
Relativity Admin and Service Account cannot be imported.
Install the application in only one workspace.
Import files require header rows with populated values.
Relativity blocks imports of existing users.
Missing destination groups for imported users will cause errors. Create groups before importing.
Duplicate group names: Users are imported into the first duplicate group.
All users are added to the "Everyone" group, even if the group column is blank in the import file.
Empty "Trusted IP" fields for users invalidate the "Outside Trusted IPs" setting for two-factor authentication.
Uninstalling the application:
Disables manually created agents due to removed tables.
Deletes database tables, queue records, and existing jobs.
Custom Components and Support:
Custom components may not perform or behave identically to native Relativity features.
Solutions are thoroughly tested but are not considered core features and have a different level of support than the Relativity platform.
To deploy and configure the solution, you must first add it to the Application Library as a Relativity application. You can then install and configure the solution in a workspace.
To add the application to the Application Library:
After you add the application to the Application Library, you’re ready to install and configure it in a workspace by performing these basic tasks:
To install the Relativity application in the workspace:
You can create and run an export utility job from the Export Utility Job tab in the workspace where you installed the application. Within that workspace, create and run an export utility job by completing the following workflow:
After you click Submit, Relativity agents begin processing your export utility job. The Progress section populates with the following information:
Click Cancel to stop the job from running.
Once the agents finish the export, Relativity populates the Export File field on the export utility job with a CSV file that contains a list of users and their Relativity settings for the object type you specified. Click the file name to download your export file.
You can view export errors on the Export Utility Job Errors tab. Errors are also linked to your export utility job.
You can run an import utility job from the Import Utility Job tab. To run an import utility job, complete the following workflow:
Note: Validating the import file does not automatically submit it. You must click Submit after validating the file to import users.
Once you click Save, the Status section populates with the following information:
After you click Submit, Relativity runs your import job. Click Cancel to stop the job from running.
Progress
Click Cancel to stop the job from running.
You can view export errors on the Import Utility Job Errors tab. Errors are also linked to your import utility job.
Note: Errors that report a user being partially imported indicate that the user was created, but the application was unable to update one of the user’s properties. We recommend deleting the reported user and attempting the import again.
Test |
Test scenario |
Operation time (hh:mm:ss) |
---|---|---|
Export |
1 manager agent, 1 worker agent 1000 users |
00:08:37 |
Export |
1 manager agent 5 worker agent 1000 users |
00:03:13 |
Validation |
1 manager agent, 1 worker agent 1000 users |
00:20:48 |
Validation |
1 manager agent 5 worker agent 1000 users |
00:07:34 |
Validation and Import |
1 manager agent, 1 worker agent 1000 users |
01:16:55 |
Validation and Import |
1 manager agent 5 worker agent 1000 users |
00:50:16 |
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!