TWiki/BulkRegistration.mdwn

   1 # <a name="Bulk Registration"></a> Bulk Registration
   2
   3 The [[TWikiAdminGroup]] can use %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 - Email
  15 - FirstName
  16 - LastName
  17
  18 ### <a name="Optional fields"></a> Optional fields
  19
  20 - [[LoginName]] - if not set will register with [[WikiName]]
  21
  22 ## <a name="Settings"></a> Settings
  23
  24 - - Set REGISTERTOPIC = [[UnprocessedRegistrations]]
  25   - Set LOGTOPIC = %REGISTERTOPIC%Log
  26
  27 - - Set OVERWRITEHOMETOPICS = 0
  28
  29 ### <a name="Example format"></a> Example format
  30
  31 The following should be inserted into your REGISTERTOPIC as a table.
  32
  33     | FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
  34     | Test | User | you@example.com | TestUser | A | B | C |
  35
  36 To use this:
  37
  38 1. Make sure that the Custom fields appear on the [[UserForm]]
  39 2. Copy the above table to your clipboard
  40 3. Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
  41 4. Click the Bulk register button below
  42 5. Read %LOGTOPIC%
  43 6. When you are ready, use the [[BulkResetPassword]] page to assign passwords and notify the users of their new accounts.
  44
  45 Notes:
  46
  47 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.
  48 2. You are responsible for ensuring that the fieldnames appear in the [[Main.UserForm|Main/UserForm]]
  49 3. Only members of the [[TWikiAdminGroup]] can run this.
  50
  51 <form action="http://www.dementia.org/twiki/manage/%REGISTERTOPIC%" method="post" name="bulkRegister"><input name="action" type="hidden" value="bulkRegister" /> <input type="submit" value="Bulk Register these people" /> <input name="LogTopic" type="hidden" value="%LOGTOPIC%" /> <input name="OverwriteHomeTopics" type="hidden" value="%OVERWRITEHOMETOPICS%" /></form>
  52
  53 ## <a name="%REGISTERTOPIC%"></a> %REGISTERTOPIC%
  54
  55 ## <a name="%LOGTOPIC%"></a> %LOGTOPIC%
  56
  57 **_Related Topics:_** [[AdminToolsCategory]]