If you have a large number of users to create or edit in Litmos, you will want to use our bulk import option. This will enable you to upload a Comma Separated Value (CSV) file containing up to 5000 users, and automatically send out a login email to each one if needed.
To get started, click on the “People” tab in Litmos, select "Options" and then select the “Import people in bulk” option.
Building your CSV import file
For the CSV import file template, click the “use this template to get started” link. To edit the CSV file, we recommend using text editor like Notepad or a spreadsheet tool like Excel or Google Sheets.
There are many fields that can be uploaded for each user. The fields 'Username', 'First Name' and 'Last Name' are mandatory and the rest are optional.
**When Team Leaders/Team Admins Perform an Import: **The Team1 Column is mandatory for Team Leaders/Team Admins performing an import since team leaders/team admins can only import to their team(s). Without a team, the import will fail for team leaders/team admins.
Note: When you construct your CSV file be sure to add each new user on a new line.
Note: For a list of Language codes, see the article, Languages - This is a list of possible culture values.
Once the CSV file has been constructed, upload the file by selecting it and clicking “Next”. If the field names are listed in the first row of the file then check the “The first row of my file contains column titles” box so the import ignores the first row.
Import people directly into teams
The optional Team1, Team2, Team3, Team4 and Team5 columns make it possible to import people directly into teams.
- First, create the Teams in Litmos.
- Second, retrieve each team's unique import Team Code from within each team's Settings subtab. To retrieve the Team codes in bulk, run a Teams Quick Report and download to CSV. The download version will display the Team Code for each team
- Third, enter this code into one of the Team1-Team5 columns of your CSV file.
Assign People to Courses
The optional Course1, Course2, and Course3 columns make it possible to assign multiple courses to a person.
- Create the Course in Litmos.
- Retrieve each course's unique import course code from each course's settings tab. (This also can be found in the Course Quick report)
- Enter this code into one of the Course1 - Course3 columns of your CSV file.
Importing Advanced User Custom Fields
Advanced user custom fields can be included in the People Bulk Import if the User Custom Fields Litmos feature is enabled. In this case, additional help information will appear on the import people page in the system, including an ability to view the advanced custom field details.
There are important aspects of advanced custom fields that must be taken into consideration before attempting to import data for advanced user custom fields:
- The value for an advanced user custom field must comply with the chosen field type, or the import will fail for users without valid field values. Please check your Litmos site's default date format and the available dropdown values. An invalid data type or format will result in user import failure. Note: Dropdown type field values are case sensitive.
- If an advanced user custom field provides a default value, and a user in Litmos does not have a value for that field on the user record, the default value will be applied if the field is mapped during the import.
- If an advanced user custom field is set to be mandatory, then a value must be imported for each user. A missing value for a mandatory field will result in a user import failure.
Matching the Data with the Litmos Import Fields
The final step is to map the columns in the CSV file with the correct fields in the application to ensure that user records are created and updated properly.
If you want to assign a team/course/learning path then please add their unique code in the file from the admin Team/course/learning settings sub-tab
Once the fields have been mapped, proceed to select the email options for the bulk import.
Send login emails to new users - Selecting this option will send a welcome message with a login link to all new users and users that have never logged into the system.
Send course assignment emails - Selecting this option will send course assignment emails to all users who were assigned to a course(s). If a user is already assigned to a course that was included in the import, the user will not receive the course assignment email.
Send learning path assignment emails - Selecting this option will send learning path assignment emails to all users who were assigned to learning path(s) in the import. If a user is already assigned to a learning path that was included in the import, the user will not receive the learning path assignment email.
Send team assignment emails - Selecting this option will send team assignment emails to all users who were assigned to a team in the import. If a user is already assigned to the a team that was included in the import, the user will not receive the team assignment email.
Skip First Login - If the "Skip First Login" box is checked, users will skip the welcome page and will not be prompted to verify profile information or enter a new password upon login.
Reviewing the Status of the Import
A list of your recent bulk user imports and the status of each bulk user import is displayed on the right side of the People page. You can also download results which is a CSV file that contains the import status of each of your included user records in the import file.
NOTE: When importing a CSV containing special characters, such as Chinese, Koran, or Hebrew, reference this article to minimize possible import errors.
For Bulk Deactivation of users.
In the CSV import file, keep all the columns intact and update the Active column to have a FALSE value for the required users.
NOTE: You need to map the following minimum fields to bulk Deactivate users in Litmos:
- First Name
- Last Name
For Bulk Reactivation of users.
In the CSV import file, keep all the columns intact and update the Active column to have a TRUE value for the required users.
NOTE: You need to map the following minimum fields to bulk Reactivate users in Litmos:
- First Name
- Last Name