(r3) BulkRegistration < TWiki

Tags: view all tags

---+ Bulk Registration

Administrators can use this topic to register (i.e. create logins and UserTopics) for a group of people quickly. 
Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata.
Then press the button on this page to perform registration for those users. 
Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required.
Note that the new users are not notified that they have an account. This is so you can prepare and verify the accounts before announcing them.
To announce them use the BulkResetPassword feature: this will assign a new random password and notify users. 

---++ Bulk Registration usage

Any fields you define in this table will end up in the User's topic. If a form (such as %TWIKIWEB%.UserForm) is attached to NewUserTemplate then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search. 

If you use the %TWIKIWEB%.UserForm then ensure that it contains all the fields you define here. Otherwise they will disappear when the user edits their home topic!

---+++ Mandatory fields
   * !WikiName 
   * !FirstName
   * !LastName 

---+++ Optional fields
   * LoginName - if not set will register with WikiName


---++ Settings
   * Define where to pick up the table of users to register
      * Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations
   * Use this to define where to log the bulk registration process. It needs
     to be a topic name in this web.
      * Set LOGTOPIC = %REGISTERTOPIC%Log
   * Set this to 1 to make the bulk registration overwrite any existing user
     topics. By default, existing user topics are left alone.
      * Set OVERWRITEHOMETOPICS = 0

---+++ Example format
The following should be inserted into your REGISTERTOPIC as a table.
<verbatim>
| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
| Test | User | you@example.com | TestUser | A | B | C |
</verbatim>

To use this:
   1 Make sure that the Custom fields appear on the %TWIKIWEB%.UserForm
   2 Copy the above table to your clipboard
   3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
   4 Click the Bulk register button below
   5 Read %LOGTOPIC%
   6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.

Notes:
   1 The first row of the table dictates the heading format and that the fieldnames must be plain, i.e. *must not contain bolded* entries.
   2 You are responsible for ensuring that the fieldnames appear in the [[%TWIKIWEB%.UserForm]]
   3 Only administrators can run this.

%IF{
  "context passwords_modifyable"
  then=""
  else="<strong>%MAKETEXT{"Sorry, the password system is currently read only, please contact [_1]" args="%WIKIWEBMASTER%"}%</strong><br />"
}%
<!--
      * Set NOTMODIFYABLE = %IF{"context passwords_modifyable" then="" else="DISABLED"}%
-->
<form name="bulkRegister" action="%SCRIPTURLPATH{"manage"}%/%REGISTERTOPIC%" method="post">
<input type="hidden" name="action" value="bulkRegister" />&nbsp;
<input %NOTMODIFYABLE% type="submit" class="twikiSubmit" value="Bulk Register these people" />
<input type="hidden" name="LogTopic" value="%LOGTOPIC%" />
<input type="hidden" name="OverwriteHomeTopics" value="%OVERWRITEHOMETOPICS%" />
</form>

---++ %REGISTERTOPIC%

%INCLUDE{%REGISTERTOPIC%}%


---++ %LOGTOPIC%

%INCLUDE{%LOGTOPIC%}%


__Related Topics:__ AdminToolsCategory

Topic revision: r3 - 2005-03-27 - TWikiContributor

Account
- Log In

~~Edit~~
~~Attach~~

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.BulkRegistration.