This is the administrator guide for the Bulk User Import Tool. The bulk user import tool is an easy and fast way to bulk create Active Directory User accounts. The tool comes with a CSV template that you fill out and use to import accounts.
Table of Contents:
- Read First
- How to guide (step by step instructions)
- Import Logs
- CSV Template Setup
- Adding additional user fields to the CSV
- Bulk Export then import
- Help and support
- It is recommended to first run a small import to ensure the accounts are being created as expected.
- The CSV template includes 33 user attributes. This covers the most common attributes for creating new accounts. Additional attributes can be added to the template.
- You DO NOT need to add the name attribute to the CSV. This gets automatically created based off the first and last name.
How to guide (step by step instructions)
If you need help with the CSV please go to the section titled “CSV Template Setup”
Step 1: Generate the CSV template by clicking on the bulk import button
You will be prompted to save the CSV file. You can save it anywhere you want.
Step 2: Fill out the CSV
Included with your download is a sample CSV title “Bulk Creation Template-Example” You can use this CSV as a reference for filling out your CSV template. You can also click here to view an example of a filled out CSV.
If you need help with understand the CSV columns and Active Directory attributes then jump to the next section.
Step 3: Run the bulk import tool
- Now just select the CSV that you filled out
- Enable any options (optional)
- Click Run
All done. Its a good idea to click the log button to check for any import errors.
CSV Template Setup
The provided CSV template included 33 user attributes you can use. You can add or remove attributes as needed. Active Directory uses LDAP attribute names to store most account information. This means the user fields you see in Active Directory Users and Computers do not always match with the LDAP attribute name. To create accounts the LDAP field names must be used.
In this section, I’ll walk through the provided CSV template, explain what each column means and provide a screenshot.
The sAMAccountName attribute is the pre-Windows 2000 account logon name. Even though it says pre-Windows 2000 Microsoft still requires it. This is a required field.
Use this field to set the users password. The password will need to match your companies password policy. The password can be the same or different for each user. It is best practice to set a different password for each user.
Use this field to place the accounts in specific organizational units. This needs to be the distinguishedName of the organizational unit.
Use this field to place accounts into Active Directory groups. You can put users into multiple groups, just separate the groups with a comma. Use the group name.
Use this field to set the userPrincipalName and domain.
Use this attribute to set the users first name
Use this field to set the users initials
Use this field to set the users last name
Use this to set the users displayname. You can set this to whatever you want.
Use this to give the user account a description
Use this to set the users office field
Use this field to set the users Telephone number
Use this to set the users email address
Use this field to set the users web page
Use this to set the users street
Use this filed to set the users P.O Box
Used to set the City attribute
Use this attribute to set the users State
Use this attribute to set a users Zip/Postal Code
Use to set a users Country
Used to set a users profile path
Use to set a users logon script
Used to set the set the path for connecting a drive
Used to set the home telephone number
Used to set the Mobile telephone number
Used to set the IP phone
Used to set a users Job title
Used to set the department field
Used to set the company field
Use this attribute to set the employeeid.
Use this attribute to set the users employeenumber
Used to set the Manager
Use to set the proxyaddresses attribute. You can set multiple addresses, separate them with a comma.
See Active Directory LDAP Field Mappings guide for more info. This guide includes screenshots and a table view of the LDAP to Active Directory names.
When running an import please check the import log for any errors and status of the import. If the import failed the logs should give you the reason why. This also provides you a log of all successful imports, you can use the export button to export the logs to a csv file.
In the screenshot below the import did not complete, I can easily see why the import failed, because the accounts already exist.
Adding additional user fields to the CSV
You can add additional user attributes to the CSV file, you just need to know the LDAP name. You can find the LDAP name by opening the attribute editor in Active Directory Users and Computers. You could also use PowerShell to list all user account properties.
To see the attribute editor you first need to enable the advanced features in Active Directory Users and Computer
Click view from the top menu then select advanced features.
Now when you open an account you will see the attribute editor tab.
The attribute editor screen will show you all the user LDAP properties.
Now just find the attribute name and add it to the CSV. For example, I want to add information to the other Home telephone section for users.
In the attribute editor I see the name is “otherHomePhone”. I will add this to the csv.
All done. That is how you add additional attributes to the CSV file to import with new accounts.
Bulk export then import
With the user export tool you can bulk export accounts to a CSV and then bulk import the accounts. This is useful for migrating or moving users to a new domain.
Step1: Run the User export tool
Choose what you want to export, all users, all users from an organizational unit or a group.
Then click the export button to save the results to a CSV. In the example below this is all the users from the Accounting OU in my domain. Now I’ll just click export to save this to a CSV.
Now open the bulk import tool and choose the exported CSV and click run.
If you need help or have questions contact us via our contact page.