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 user topics) for a group of people in one batch.
   4
   5 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.
   6
   7 ## <a name="Bulk Registration usage"></a> Bulk Registration usage
   8
   9 Note: this is an administrator job - only admistrators can run this.
  10
  11 If you are administrator, you will take these actions:
  12
  13 1. (First time use) Create new bulk registration topics (see [[Settings|Main/WebHome#Settings]] below).
  14 2. In the REGISTERTOPIC topic: create a table of new users. An example table is provided below to copy.
  15 3. Return to this topic and press the button "Bulk Register" to create the new topics.
  16 4. Read %LOGTOPIC% to verify if all has gone well.
  17 5. When you are ready, use the [[BulkResetPassword]] page to assign passwords and notify the users of their new accounts.
  18
  19 Below are the details.
  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="The user table"></a> The user table
  31
  32 This table is a template for user data that will be written to the new user topics. If you stick to these basic fields you can just use the first example below. If you want to write more data (like phone number or country) read the section [[Customizing user data|Main/WebHome#CustomizingUserData]] as well.
  33
  34 ### <a name="Example format"></a> Example format
  35
  36 The following should be inserted into your %REGISTERTOPIC% as a table. This is the most simple format:
  37
  38     <noautolink>
  39     %EDITTABLE{}%
  40     | FirstName | LastName | Email | WikiName |
  41     | Test | User | you@example.com | TestUser |
  42     </noautolink>
  43
  44 **Usage:**
  45
  46 1. Copy this text to your clipboard
  47 2. Click through and paste this on %REGISTERTOPIC%.
  48 3. Add and customize entries, save table. Note that the first row must not contain bolded entries, so don't apply any formatting.
  49 4. Return here
  50
  51 <a name="CustomizingUserData"></a>
  52
  53 ### <a name="Customizing user data"></a> Customizing user data
  54
  55 You can write additional data to the new user topics. Do this by enhancing the user table with additional field names as table headers.
  56
  57 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.
  58
  59 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!
  60
  61 #### <a name="Mandatory fields"></a> Mandatory fields
  62
  63 - WikiName
  64 - FirstName
  65 - LastName
  66
  67 #### <a name="Optional fields"></a> Optional fields
  68
  69 - [[LoginName]] - if not set will register with [[WikiName]]
  70
  71 #### <a name="Customized table example"></a> Customized table example
  72
  73 Make sure that the extra fields also appear on the [[UserForm]].
  74
  75     <noautolink>
  76     %EDITTABLE{}%
  77     | FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
  78     | Test | User | you@example.com | TestUser | A | B | C |
  79     </noautolink>
  80
  81 ----
  82
  83 **Sorry, the password system is currently read only, please contact 0**<br />
  84
  85 <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>
  86
  87 ## <a name="%REGISTERTOPIC%"></a> %REGISTERTOPIC%
  88
  89 ## <a name="%LOGTOPIC%"></a> %LOGTOPIC%
  90
  91 **_Related Topics:_** [[AdminToolsCategory]]