Step 1: Create a CSV with new user and property details
You can provision users in a domain or update the properties of existing users using a CSV file. The first line of the CSV will have the property names and the second line onwards will have records for all users which need to be provisioned and whose properties need to be updated.
The table below gives the property name as mentioned in the Admin Panel and the corresponding property name to be used in the CSV. Download a sample CSV file.
| Property label in the Admin Panel | Property name in the CSV | Description |
|---|---|---|
| username |
The username of an email id john@acmecorp.com will be john. Note: This is a compulsory field when creating a CSV. Usernames must be unique. (This is shown as part of the Email ID of the user on the Admin Panel.) | |
| First Name | firstname | The first name of the user. |
| Last Name | lastname | The last name of the user. |
| Display Name | displayname | The display name of the user. |
| Email ID |
Email id Note: This field is not to be used in a CSV. | |
| Alias ID | mithialias |
Every user can have one or more alias ids. Mail sent to an alias id will automatically reach the user’s mailbox. Note: Alias ids should be unique. Alias ids are not counted when calculating the number of users in a domain. Mention multiple email ids with ** as a separator. |
| Alternate Email ID | alternateemailaddress | The alternate email address. Used to send OTP for the forgot pass application. |
| COS | classofservice |
The class of service of the the user. This value determines the system behavior for the user. Note: It is compulsory to specify this value when adding a new user or updating user properties. |
| Account Status | accountstatus | Account status. Using this property, you can enable or disable a user account. |
| Member Of | memberof |
The group ids to which this user belongs. If a user belongs to more than one group, the group ids have to be separated by ** in the CSV. For example, if the user belongs to the sales and allusers groups, then the csv will have sales@[domain]**allusers@[domain] as the value. |
| Enter New Password | password |
The password should adhere to the complexity and length set for the domain. Note: It is compulsory to specify this value when adding a new user |
| Archive | enablepersonalmailarchiving | Valid values to be entered in the CSV are ON or OFF. |
| Archive User ID | personalarchiveid | The Vaultastic user id. |
| Type of mail to archive | archivepersonalmailtype | Valid values are all, local and remote. |
| Personal Information like Birthdate, Gender, Spouse, Children and Anniversary | birthdate, gender, spouse, children, anniversary |
For more than one children, use the ** separator. For example, if a user has two children John and Mary, the value will be john**mary |
| Business information such as Job Title, Employee number etc. | jobtitle, employeenumber, joindate, office, department, company, companyaddress, companycity, companypincode, companystate,companycountry, companyphone, companypager, companymobile, companyfax, companywebpage, ipphone, manager | All dates to be specified in the dd/mm/yyyy format. The companymobile is the mobile number used to send OTP for the forgot password application. Enter the mobile number in the format: +{Country_Code}.{mobile number} For multiple values, use ** as the separator. |
| Quota Overflow Policy | ||
| Allocated Quota | ||
| Message Lifetime |
Here are some tips when creating the CSV files:
-
The CSV files can be created using a text editor such as Notepad or using a spreadsheet such as Libre Office or Microsoft Excel.
-
The first line of the CSV has the property names separated by commas
-
Subsequent lines have the user details to be be uploaded.
-
For each user record, ensure that
-
Each record is one line
-
Fields are separated with commas
-
Leading and trailing white-spaces from the values are removed
-
Field values are enclosed in double-quotes
-
If a field contains double-quote character, double-quote characters are doubled
-
Dates are in dd/mm/yyyy format
-
Multiple values are separated by **
-
Step 2: Add new users and update user properties
-
Log in to Admin Panel. From the left pane, select the domain > Users option. The middle pane will show the list of users present.
-
Click the Import Users icon.
-
In the Create new users / Update user properties dialog box:
-
Select Add new users from the CSV to add new users to the domain. Selecting this option will create the new users mentioned in the CSV file.
-
To update properties of users, select Update the properties of existing and new users from the CSV.
-
Select File to be imported from your machine. The format of the CSV file is given here.
-
Click Continue to proceed.
-
-
In the first pass, the application validates the CSV records.
-
The validation status is displayed in the next screen.
-
If there are warnings, you can Ignore the warnings and Update the valid properties of the users OR you can Cancel the import .
-
In the second pass, all new users are added. The status of the new user addition will be displayed on the dialog box.
-
For the third pass to start, click on the Update Properties button.
-
The system will now validate the user properties in the CSV and display the status.
-
To view the invalid properties, click on Show Invalid user properties.
-
To ignore the invalid properties and proceed, select the Ignoring invalid user properties check box and click on Update.
-
The screen will show the update status. Click Done to exit the dialog box.
-
The newly added users will be shown in the middle pane.