User Directories

You can create any number of custom user directories, each of which is used to hold different types of users. Each directory can hold any number of users, each of which must have a unique username to identify them from other users.

Creating a User Directory

To create a user directory, click the Create User Directory link in the left column, or the Create Directory tab at the top of the right column.

First you must enter a title by which to identify the users. For example, if you're creating a user directory to hold web site members, call the directory "Members".

You can choose whether a user account is instantly activated or must be approved by an administrator. If the account must be approved then the user status is set to Inactive.

Additionally, you can choose whether or not to send a welcome email to newly created users. You can choose the email subject and template to use for this email.

Note

If users must be manually approved then the welcome email is sent to the user only once their account is approved (that is, when it is set to active).

It is also possible to define a list of custom fields for all users in the directory. When you create a new user (or when a new user registers) the fields specified here must be filled-out.

Tip

If you select the Control Panel only option when creating a custom field, the field will not be shown to users when they use the front-end registration form, but it will be when creating or editing users via the Control Panel.

To save the new user directory, click the Save Directory button. Once the directory is saved you will be taken to a listing of all users in the directory. Initially this will have no users in it.

Editing a User Directory

To edit a user directory, click the Edit Directory tab when viewing the directory you want to edit. You will then be shown the same form as when creating a directory.

Make any changes as required then click Save Directory to save your changes.

Deleting a User Directory

To delete a user directory, click the Delete Directory tab when viewing the directory you want to delete. You will be prompted to confirm that you want to delete the directory.

Click the Yes, delete this directory button to delete the directory.

Caution

When you delete a user directory all users within the directory are also deleted and cannot be recovered.

Importing Users

To import many users into a directory at once you can do so using a CSV (comma-separated values) file. The first column of the file must list the user fields as they are specified in the user directory settings.

To use the importer, click the Import Users tab when viewing a user directory. You can choose to either auto-generate usernames and passwords or you can specify them in the file by using columns called Username and Password respectively. If you only have access to the MD5 hash of the user's password, the importer will auto-detect that value if you include it in the password column.

Once you upload the file and it has been processed (which may take a few minutes, depending on the size of the file), you will be shown a summary of what occurred. This includes number of users created or a summary of errors that occurred.

Exporting Users

To export the users in a user directory as a CSV (comma-separated values) file, click the Export Users tab when viewing a directory.

You will then be prompted to choose which users you would like to export based on their user status.

Click the Export Users button to start downloading the CSV file.