TWiki/BulkRegistration.mdwn

   1 # <a name="Bulk Registration"></a> Bulk Registration
   2
   3 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.
   4
   5 ## <a name="Bulk Registration usage"></a> Bulk Registration usage
   6
   7 Any fields you define in this table will end up in the User's topic. If a form (such as [[UserForm]]) is attached to [[NewUserTemplate]] then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search.
   8
   9 If you use the [[UserForm]] then ensure that it contains all the fields you define here. Otherwise they will disappear when the user edits their home topic!
  10
  11 ### <a name="Mandatory fields"></a> Mandatory fields
  12
  13 - WikiName
  14 - FirstName
  15 - LastName
  16
  17 ### <a name="Optional fields"></a> Optional fields
  18
  19 - [[LoginName]] - if not set will register with [[WikiName]]
  20
  21 ## <a name="Settings"></a> Settings
  22
  23 - Define where to pick up the table of users to register
  24   - Set REGISTERTOPIC = [[UnprocessedRegistrations]]
  25 - Use this to define where to log the bulk registration process. It needs to be a topic name in this web.
  26   - Set LOGTOPIC = %REGISTERTOPIC%Log
  27 - Set this to 1 to make the bulk registration overwrite any existing user topics. By default, existing user topics are left alone.
  28   - Set OVERWRITEHOMETOPICS = 0
  29
  30 ### <a name="Example format"></a> Example format
  31
  32 The following should be inserted into your REGISTERTOPIC as a table.
  33
  34     | FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
  35     | Test | User | you@example.com | TestUser | A | B | C |
  36
  37 To use this:
  38
  39 1. Make sure that the Custom fields appear on the [[UserForm]]
  40 2. Copy the above table to your clipboard
  41 3. Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
  42 4. Click the Bulk register button below
  43 5. Read %LOGTOPIC%
  44 6. When you are ready, use the [[BulkResetPassword]] page to assign passwords and notify the users of their new accounts.
  45
  46 Notes:
  47
  48 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.
  49 2. You are responsible for ensuring that the fieldnames appear in the [[TWiki.UserForm|TWiki/UserForm]]
  50 3. Only administrators can run this.
  51
  52 **Sorry, the password system is currently read only, please contact 0**<br />
  53
  54 <form action="http://www.dementia.org/twiki/manage/%REGISTERTOPIC%" method="post" name="bulkRegister"><input name="action" type="hidden" value="bulkRegister" />  <input %notmodifyable%="%NOTMODIFYABLE%" type="submit" value="Bulk Register these people" /> <input name="LogTopic" type="hidden" value="%LOGTOPIC%" /> <input name="OverwriteHomeTopics" type="hidden" value="%OVERWRITEHOMETOPICS%" /></form>
  55
  56 ## <a name="%REGISTERTOPIC%"></a> %REGISTERTOPIC%
  57
  58 ## <a name="%LOGTOPIC%"></a> %LOGTOPIC%
  59
  60 **_Related Topics:_** [[AdminToolsCategory]]