data/TWiki/BulkRegistration.txt,v
changeset 1 e2915a7cbdfa
parent 0 414e01d06fd5
     1.1 --- a/data/TWiki/BulkRegistration.txt,v	Sat Jan 26 15:50:53 2008 +0100
     1.2 +++ b/data/TWiki/BulkRegistration.txt,v	Mon Aug 11 20:30:19 2008 +0200
     1.3 @@ -1,10 +1,15 @@
     1.4 -head	1.3;
     1.5 +head	1.4;
     1.6  access;
     1.7  symbols;
     1.8  locks; strict;
     1.9  comment	@# @;
    1.10  
    1.11  
    1.12 +1.4
    1.13 +date	2008.08.03.22.17.52;	author TWikiContributor;	state Exp;
    1.14 +branches;
    1.15 +next	1.3;
    1.16 +
    1.17  1.3
    1.18  date	2008.01.22.03.21.36;	author TWikiContributor;	state Exp;
    1.19  branches;
    1.20 @@ -26,36 +31,32 @@
    1.21  @
    1.22  
    1.23  
    1.24 -1.3
    1.25 +1.4
    1.26  log
    1.27  @buildrelease
    1.28  @
    1.29  text
    1.30 -@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}%
    1.31 +@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
    1.32  %META:TOPICPARENT{name="ManagingUsers"}%
    1.33  ---+ Bulk Registration
    1.34  
    1.35 -Administrators can use this topic to register (i.e. create logins and UserTopics) for a group of people quickly. 
    1.36 -Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata.
    1.37 -Then press the button on this page to perform registration for those users. 
    1.38 -Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required.
    1.39 +Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch. 
    1.40 +
    1.41 +Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so *no verification is required.*
    1.42  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.
    1.43 -To announce them use the BulkResetPassword feature: this will assign a new random password and notify users. 
    1.44 +To announce them use the [[BulkResetPassword]] feature: this will assign a new random password and notify users. 
    1.45  
    1.46  ---++ Bulk Registration usage
    1.47 -
    1.48 -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. 
    1.49 -
    1.50 -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!
    1.51 +Note: this is an administrator job - only admistrators can run this.
    1.52  
    1.53 ----+++ Mandatory fields
    1.54 -   * !WikiName 
    1.55 -   * !FirstName
    1.56 -   * !LastName 
    1.57 +If you are administrator, you will take these actions:
    1.58 +   1 (First time use) Create new bulk registration topics (see [[#Settings][Settings]] below).
    1.59 +   1 In the REGISTERTOPIC topic: create a table of new users. An example table is provided below to copy.
    1.60 +   1 Return to this topic and press the button "Bulk Register" to create the new topics.
    1.61 +   1 Read %LOGTOPIC% to verify if all has gone well.
    1.62 +   1 When you are ready, use the [[BulkResetPassword]] page to assign passwords and notify the users of their new accounts.
    1.63  
    1.64 ----+++ Optional fields
    1.65 -   * LoginName - if not set will register with WikiName
    1.66 -
    1.67 +Below are the details.
    1.68  
    1.69  ---++ Settings
    1.70     * Define where to pick up the table of users to register
    1.71 @@ -67,26 +68,53 @@
    1.72       topics. By default, existing user topics are left alone.
    1.73        * Set OVERWRITEHOMETOPICS = 0
    1.74  
    1.75 +---++ The user table
    1.76 +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 [[#CustomizingUserData][Customizing user data]] as well.
    1.77 +
    1.78  ---+++ Example format
    1.79 -The following should be inserted into your REGISTERTOPIC as a table.
    1.80 +The following should be inserted into your %REGISTERTOPIC% as a table. This is the most simple format:
    1.81  <verbatim>
    1.82 -| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
    1.83 -| Test | User | you@@example.com | TestUser | A | B | C |
    1.84 +<noautolink>
    1.85 +%EDITTABLE{}%
    1.86 +| FirstName | LastName | Email | WikiName |
    1.87 +| Test | User | you@@example.com | TestUser |
    1.88 +</noautolink>
    1.89  </verbatim>
    1.90  
    1.91 -To use this:
    1.92 -   1 Make sure that the Custom fields appear on the %TWIKIWEB%.UserForm
    1.93 -   2 Copy the above table to your clipboard
    1.94 -   3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
    1.95 -   4 Click the Bulk register button below
    1.96 -   5 Read %LOGTOPIC%
    1.97 -   6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
    1.98 +*Usage:*
    1.99 +   1 Copy this text to your clipboard
   1.100 +   1 Click through and paste this on %REGISTERTOPIC%. 
   1.101 +   1 Add and customize entries, save table. Note that the first row must not contain bolded entries, so don't apply any formatting.
   1.102 +   1 Return here
   1.103 +
   1.104 +#CustomizingUserData
   1.105 +---+++ Customizing user data
   1.106 +
   1.107 +You can write additional data to the new user topics. Do this by enhancing the user table with additional field names as table headers.
   1.108 +
   1.109 +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. 
   1.110 +
   1.111 +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!
   1.112  
   1.113 -Notes:
   1.114 -   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.
   1.115 -   2 You are responsible for ensuring that the fieldnames appear in the [[%TWIKIWEB%.UserForm]]
   1.116 -   3 Only administrators can run this.
   1.117 +---++++ Mandatory fields
   1.118 +   * !WikiName 
   1.119 +   * !FirstName
   1.120 +   * !LastName 
   1.121 +
   1.122 +---++++ Optional fields
   1.123 +   * LoginName - if not set will register with WikiName
   1.124  
   1.125 +---++++ Customized table example
   1.126 +Make sure that the extra fields also appear on the %TWIKIWEB%.UserForm.
   1.127 +<verbatim>
   1.128 +<noautolink>
   1.129 +%EDITTABLE{}%
   1.130 +| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
   1.131 +| Test | User | you@@example.com | TestUser | A | B | C |
   1.132 +</noautolink>
   1.133 +</verbatim>
   1.134 +
   1.135 +---
   1.136  %IF{
   1.137    "context passwords_modifyable"
   1.138    then=""
   1.139 @@ -102,16 +130,86 @@
   1.140  <input type="hidden" name="OverwriteHomeTopics" value="%OVERWRITEHOMETOPICS%" />
   1.141  </form>
   1.142  
   1.143 ----++ %REGISTERTOPIC%
   1.144 +---++ <nop>%REGISTERTOPIC%
   1.145 +
   1.146 +%INCLUDE{"%REGISTERTOPIC%" warn="off"}%
   1.147 +
   1.148  
   1.149 -%INCLUDE{%REGISTERTOPIC%}%
   1.150 +---++ <nop>%LOGTOPIC%
   1.151 +
   1.152 +%INCLUDE{"%LOGTOPIC%" warn="off"}%
   1.153 +
   1.154 +
   1.155 +__Related Topics:__ AdminToolsCategory@
   1.156  
   1.157  
   1.158 +1.3
   1.159 +log
   1.160 +@buildrelease
   1.161 +@
   1.162 +text
   1.163 +@d1 1
   1.164 +a1 1
   1.165 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}%
   1.166 +d5 3
   1.167 +a7 4
   1.168 +Administrators can use this topic to register (i.e. create logins and UserTopics) for a group of people quickly. 
   1.169 +Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata.
   1.170 +Then press the button on this page to perform registration for those users. 
   1.171 +Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required.
   1.172 +d9 1
   1.173 +a9 1
   1.174 +To announce them use the BulkResetPassword feature: this will assign a new random password and notify users. 
   1.175 +d12 1
   1.176 +d14 6
   1.177 +a19 11
   1.178 +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. 
   1.179 +
   1.180 +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!
   1.181 +
   1.182 +---+++ Mandatory fields
   1.183 +   * !WikiName 
   1.184 +   * !FirstName
   1.185 +   * !LastName 
   1.186 +
   1.187 +---+++ Optional fields
   1.188 +   * LoginName - if not set will register with WikiName
   1.189 +d21 1
   1.190 +d33 3
   1.191 +d37 34
   1.192 +a70 1
   1.193 +The following should be inserted into your REGISTERTOPIC as a table.
   1.194 +d72 2
   1.195 +d76 1
   1.196 +d79 1
   1.197 +a79 13
   1.198 +To use this:
   1.199 +   1 Make sure that the Custom fields appear on the %TWIKIWEB%.UserForm
   1.200 +   2 Copy the above table to your clipboard
   1.201 +   3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
   1.202 +   4 Click the Bulk register button below
   1.203 +   5 Read %LOGTOPIC%
   1.204 +   6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
   1.205 +
   1.206 +Notes:
   1.207 +   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.
   1.208 +   2 You are responsible for ensuring that the fieldnames appear in the [[%TWIKIWEB%.UserForm]]
   1.209 +   3 Only administrators can run this.
   1.210 +
   1.211 +d95 1
   1.212 +a95 1
   1.213 +---++ %REGISTERTOPIC%
   1.214 +d97 1
   1.215 +a97 1
   1.216 +%INCLUDE{%REGISTERTOPIC%}%
   1.217 +d100 1
   1.218 +a100 1
   1.219  ---++ %LOGTOPIC%
   1.220 -
   1.221 +d102 1
   1.222 +a102 1
   1.223  %INCLUDE{%LOGTOPIC%}%
   1.224 -
   1.225 -
   1.226 +d105 1
   1.227 +a105 1
   1.228  __Related Topics:__ AdminToolsCategory
   1.229  @
   1.230