BulkUser Manager - Guide
This module allows the bulk creation, update, deletion and export of users as well as the adding and removing of users to roles. The roles that a user needs to be added to can be defined in the import file (either a CSV or an XML file), or by selecting a single role. If the roles defined in the import file do not already exist, they will be created.
Create user accounts
The following steps will allow user accounts to be created on the DotNetNuke portal that you are currently logged into:
- Select “Create User Accounts” from the main screen. Click on the “Next” button.
- Select the file containing the user accounts that you would like to create by clicking on the “Browse” button. For more details on the format of this file, please see the “File Format” section below. Once the file has been selected, click on the “Next” button.
- The next screen will display up to the first ten user accounts that have been uploaded. You will also be given the option to send an email notification to each user. See changing the email message for more details on the contents of this message. Once the required option has been selected, click on the “Next” button.
- The accounts are now created. This screen displays the results of the process, with details of how many records have been read and how many accounts have been created. The time taken for the process is also displayed.
Update user accounts
The following steps will allow user accounts to be updated on the DotNetNuke portal that you are currently logged into:
- Select “Update User Accounts” from the main screen. Click on the “Next” button.
- Select the file containing the user accounts that you would like to update by clicking on the “Browse” button. For more details on the format of this file, please see the “File Format” section below. Once the file has been selected, click on the “Next” button.
- The next screen will display up to the first ten user accounts that have been uploaded. Once you have reviewed the uploaded records, click on the “Next” button.
- The accounts are now updated. This screen displays the results of the process, with details of how many records have been read and how many accounts have been updated. The time taken for the process is also displayed.
Delete user accounts
The following steps will allow user accounts to be deleted on the DotNetNuke portal that you are currently logged into:
- Select “Delete User Accounts” from the main screen. Click on the “Next” button.
- Select the file containing the user accounts that you would like to update by clicking on the “Browse” button. For more details on the format of this file, please see the “File Format” section below. Once the file has been selected, click on the “Next” button.
- The next screen will display up to the first ten user accounts that have been uploaded. Once you have reviewed the uploaded records, click on the “Next” button.
- The accounts are now deleted. This screen displays the results of the process, with details of how many records have been read and how many accounts have been deleted. The time taken for the process is also displayed.
Export user accounts
The following steps will allow user accounts to be exported from the DotNetNuke portal that you are currently logged into:
- Select “Export User Accounts” from the main screen. Click on the “Next” button.
- At this point, you may apply a filter to limit the users exported. There are both "Simple" and "Complex" searches available. If no filtering is applied, all records will be selected. Once you have made your choice, click on the “Next” button.
- The user accounts file has now been created. This screen will show the results of the export and how long the process took. Select the file format desired for the exported user accounts and download the file. To download the file, click on the “Download File” button.
Create user accounts and add to role
This is basically the same as the “Create user account” option, except you are also able to add the user accounts to an existing role. Simple select the role and optionally, enter an expiry date for the role when these fields are presented on the screen.
Update user accounts and add to role
This is basically the same as the “Update user account” option, except you are also able to add the user accounts to an existing role. Simple select the role and optionally, enter an expiry date for the role when these fields are presented on the screen.
Add users to role
The following steps will allow user accounts to be added to a role on the DotNetNuke portal that you are currently logged into:
- Select “Add to Role Only” from the main screen. Click on the “Next” button.
- Select the file containing the user accounts that you would like to add to the role by clicking on the “Browse” button. For more details on the format of this file, please see the “File Format” section below. Once the file has been selected, click on the “Next” button.
- The next screen will display up to the first ten user accounts that have been uploaded. You are also prompted for the role that you want to add them to and the optional expiry date for the role. Once you have made your selections, click on the “Next” button.
The accounts are now added to the role. This screen displays the results of the process, with details of how many records have been read and how many accounts have been added to the role. The time taken for the process is also displayed.
Remove users from role
This is basically the same process as adding the users to the role, except that they are removed from the selected role.
Further Information
Changing the email message which is sent
The format of the email sent when an account is created can be changed by editing the fields:
- “EMAIL_USER_REGISTRATION_PUBLIC_SUBJECT”
- and
“EMAIL_USER_REGISTRATION_PUBLIC_BODY”
in the Admin | Languages | Language Editor section of DNN.
Please ensure that you have selected the correct locale in the "Available Locales" at the top of the screen before editing.
Import file format
The import file can be either a CSV or an XML file. The formats are similar and an exported XML file can be imported into an Excel spreadsheet which can then be exported to a CSV file. Exported files will adhere to the format detailed here, dependent on the version of DNN being used and the modifications that have been made to the profile fields. It is highly recommended that an export of each file type is done on the portal to determine the fields that are being utilised on your instance of DNN.
The only field that is required in either format is the username field. All other fields are optional, but it is highly recommended that as many fields as possible are populated during user creation. When creating user accounts, if a password is not supplied, a random password will be generated.
The format for the CSV file is a line for each record which contains a collection of fields. The CSV file MUST start with a line with that contains the column names. The only required field for either the CSV or XML file is the username, as all other fields will default to blank/default values. In the event of an update, fields that are not supplied will result in the existing values of the unsupplied fields retaining their value.
The fields that can be used within the CSV file are described below. Most are self explanatory. Should any field contain a comma, that field will need to be enclosed within double quotes. The same applies to any fields that contain CRLF characters. Using a product like Excel to produce the file is recommended.
Username - This is the username of the user account within DotNetNuke.
Firstname
Lastname
Email - Must be a valid format email address.
Street
Unit
City
Country
Region
Postalcode
Telephone
Cell
Fax
Website
IM
Password - If not supplied for the creation of a new account, a password will be randomly generated.
ForcePasswordReset - Can be set to the value of "True" to force password reset on logon.
Roles - Defines the roles that the user will need to be added to. ***
Timezone
PreferredLocale
Approved - Can be set to "True" or "False" as required
*** The format for the Roles field is the name of the role followed by a semicolon. If an expiry date is required for the role, the date must be in the "mm/dd/yyyy" format and is enclosed in square brackets after the role name and before the semicolon. There is no limit on the number of roles that the user can be added to. Some examples of this field are: "Role one; Role Three; Role Two;" and "Role one [9/30/2008]; Role Three [4/22/2007];". This format is valid for both the CSV and XML file types.
The format for the XML file is as follows:
<?xml version="1.0" encoding="utf-8"?>
<dataroot>
<Import>
<Item Name="UserName">UserName</Item>
<Item Name="FirstName">FirstNameValue</Item>
<Item Name="LastName">LastNameValue</Item>
<Item Name="Email">username@name.value</Item>
<Item Name="Password">somepassword</Item>
<Item Name="ForcePasswordReset">False</Item>
<Item Name="Roles">RoleTwo [1/1/2010]; </Item>
<Item Name="Approved">True</Item>
<Item Name="Unit">UnitValue</Item>
<Item Name="Street">StreetValue</Item>
<Item Name="City">CityValue</Item>
<Item Name="Region">RegionValue</Item>
<Item Name="Country">Afghanistan</Item>
<Item Name="PostalCode">postcode -p</Item>
<Item Name="Telephone">photovalue</Item>
<Item Name="Cell">cellvalue</Item>
<Item Name="Fax">faxvalue</Item>
<Item Name="Website">websitevalue</Item>
<Item Name="IM">imvalue</Item>
<Item Name="TimeZone">-480</Item>
<Item Name="PreferredLocale">en-US</Item>
</Import>
</dataroot>