data/TWiki/BulkRegistration.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Mon, 11 Aug 2008 20:33:37 +0200
changeset 2 7bc60a767fa4
parent 1 e2915a7cbdfa
permissions -rw-r--r--
TWiki-4.2.2 Release
     1 head	1.4;
     2 access;
     3 symbols;
     4 locks; strict;
     5 comment	@# @;
     6 
     7 
     8 1.4
     9 date	2008.08.03.22.17.52;	author TWikiContributor;	state Exp;
    10 branches;
    11 next	1.3;
    12 
    13 1.3
    14 date	2008.01.22.03.21.36;	author TWikiContributor;	state Exp;
    15 branches;
    16 next	1.2;
    17 
    18 1.2
    19 date	2006.04.01.05.55.04;	author TWikiContributor;	state Exp;
    20 branches;
    21 next	1.1;
    22 
    23 1.1
    24 date	2006.02.01.12.01.16;	author TWikiContributor;	state Exp;
    25 branches;
    26 next	;
    27 
    28 
    29 desc
    30 @new-topic
    31 @
    32 
    33 
    34 1.4
    35 log
    36 @buildrelease
    37 @
    38 text
    39 @%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
    40 %META:TOPICPARENT{name="ManagingUsers"}%
    41 ---+ Bulk Registration
    42 
    43 Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch. 
    44 
    45 Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so *no verification is required.*
    46 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.
    47 To announce them use the [[BulkResetPassword]] feature: this will assign a new random password and notify users. 
    48 
    49 ---++ Bulk Registration usage
    50 Note: this is an administrator job - only admistrators can run this.
    51 
    52 If you are administrator, you will take these actions:
    53    1 (First time use) Create new bulk registration topics (see [[#Settings][Settings]] below).
    54    1 In the REGISTERTOPIC topic: create a table of new users. An example table is provided below to copy.
    55    1 Return to this topic and press the button "Bulk Register" to create the new topics.
    56    1 Read %LOGTOPIC% to verify if all has gone well.
    57    1 When you are ready, use the [[BulkResetPassword]] page to assign passwords and notify the users of their new accounts.
    58 
    59 Below are the details.
    60 
    61 ---++ Settings
    62    * Define where to pick up the table of users to register
    63       * Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations
    64    * Use this to define where to log the bulk registration process. It needs
    65      to be a topic name in this web.
    66       * Set LOGTOPIC = %REGISTERTOPIC%Log
    67    * Set this to 1 to make the bulk registration overwrite any existing user
    68      topics. By default, existing user topics are left alone.
    69       * Set OVERWRITEHOMETOPICS = 0
    70 
    71 ---++ The user table
    72 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.
    73 
    74 ---+++ Example format
    75 The following should be inserted into your %REGISTERTOPIC% as a table. This is the most simple format:
    76 <verbatim>
    77 <noautolink>
    78 %EDITTABLE{}%
    79 | FirstName | LastName | Email | WikiName |
    80 | Test | User | you@@example.com | TestUser |
    81 </noautolink>
    82 </verbatim>
    83 
    84 *Usage:*
    85    1 Copy this text to your clipboard
    86    1 Click through and paste this on %REGISTERTOPIC%. 
    87    1 Add and customize entries, save table. Note that the first row must not contain bolded entries, so don't apply any formatting.
    88    1 Return here
    89 
    90 #CustomizingUserData
    91 ---+++ Customizing user data
    92 
    93 You can write additional data to the new user topics. Do this by enhancing the user table with additional field names as table headers.
    94 
    95 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. 
    96 
    97 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!
    98 
    99 ---++++ Mandatory fields
   100    * !WikiName 
   101    * !FirstName
   102    * !LastName 
   103 
   104 ---++++ Optional fields
   105    * LoginName - if not set will register with WikiName
   106 
   107 ---++++ Customized table example
   108 Make sure that the extra fields also appear on the %TWIKIWEB%.UserForm.
   109 <verbatim>
   110 <noautolink>
   111 %EDITTABLE{}%
   112 | FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
   113 | Test | User | you@@example.com | TestUser | A | B | C |
   114 </noautolink>
   115 </verbatim>
   116 
   117 ---
   118 %IF{
   119   "context passwords_modifyable"
   120   then=""
   121   else="<strong>%MAKETEXT{"Sorry, the password system is currently read only, please contact [_1]" args="%WIKIWEBMASTER%"}%</strong><br />"
   122 }%
   123 <!--
   124       * Set NOTMODIFYABLE = %IF{"context passwords_modifyable" then="" else="DISABLED"}%
   125 -->
   126 <form name="bulkRegister" action="%SCRIPTURLPATH{"manage"}%/%REGISTERTOPIC%" method="post">
   127 <input type="hidden" name="action" value="bulkRegister" />&nbsp;
   128 <input %NOTMODIFYABLE% type="submit" class="twikiSubmit" value="Bulk Register these people" />
   129 <input type="hidden" name="LogTopic" value="%LOGTOPIC%" />
   130 <input type="hidden" name="OverwriteHomeTopics" value="%OVERWRITEHOMETOPICS%" />
   131 </form>
   132 
   133 ---++ <nop>%REGISTERTOPIC%
   134 
   135 %INCLUDE{"%REGISTERTOPIC%" warn="off"}%
   136 
   137 
   138 ---++ <nop>%LOGTOPIC%
   139 
   140 %INCLUDE{"%LOGTOPIC%" warn="off"}%
   141 
   142 
   143 __Related Topics:__ AdminToolsCategory@
   144 
   145 
   146 1.3
   147 log
   148 @buildrelease
   149 @
   150 text
   151 @d1 1
   152 a1 1
   153 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}%
   154 d5 3
   155 a7 4
   156 Administrators can use this topic to register (i.e. create logins and UserTopics) for a group of people quickly. 
   157 Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata.
   158 Then press the button on this page to perform registration for those users. 
   159 Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required.
   160 d9 1
   161 a9 1
   162 To announce them use the BulkResetPassword feature: this will assign a new random password and notify users. 
   163 d12 1
   164 d14 6
   165 a19 11
   166 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. 
   167 
   168 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!
   169 
   170 ---+++ Mandatory fields
   171    * !WikiName 
   172    * !FirstName
   173    * !LastName 
   174 
   175 ---+++ Optional fields
   176    * LoginName - if not set will register with WikiName
   177 d21 1
   178 d33 3
   179 d37 34
   180 a70 1
   181 The following should be inserted into your REGISTERTOPIC as a table.
   182 d72 2
   183 d76 1
   184 d79 1
   185 a79 13
   186 To use this:
   187    1 Make sure that the Custom fields appear on the %TWIKIWEB%.UserForm
   188    2 Copy the above table to your clipboard
   189    3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
   190    4 Click the Bulk register button below
   191    5 Read %LOGTOPIC%
   192    6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
   193 
   194 Notes:
   195    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.
   196    2 You are responsible for ensuring that the fieldnames appear in the [[%TWIKIWEB%.UserForm]]
   197    3 Only administrators can run this.
   198 
   199 d95 1
   200 a95 1
   201 ---++ %REGISTERTOPIC%
   202 d97 1
   203 a97 1
   204 %INCLUDE{%REGISTERTOPIC%}%
   205 d100 1
   206 a100 1
   207 ---++ %LOGTOPIC%
   208 d102 1
   209 a102 1
   210 %INCLUDE{%LOGTOPIC%}%
   211 d105 1
   212 a105 1
   213 __Related Topics:__ AdminToolsCategory
   214 @
   215 
   216 
   217 1.2
   218 log
   219 @buildrelease
   220 @
   221 text
   222 @d1 1
   223 a1 1
   224 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="2"}%
   225 d5 1
   226 a5 1
   227 The %MAINWEB%.TWikiAdminGroup can use %TOPIC% to register (i.e. create logins and UserTopics) for a group of people quickly. 
   228 d14 1
   229 a14 1
   230 Any fields you define in this table will end up in the User's topic. If a form (such as %MAINWEB%.UserForm) is attached to NewUserTemplate then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search. 
   231 d16 1
   232 a16 1
   233 If you use the %MAINWEB%.UserForm then ensure that it contains all the fields you define here. Otherwise they will disappear when the user edits their home topic!
   234 d19 1
   235 a19 2
   236    * WikiName 
   237    * Email
   238 d28 1
   239 d30 2
   240 d33 2
   241 a34 1
   242 
   243 d45 1
   244 a45 1
   245    1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm
   246 d54 2
   247 a55 2
   248    2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]]
   249    3 Only members of the %MAINWEB%.TWikiAdminGroup can run this.
   250 d57 8
   251 d66 2
   252 a67 1
   253 <input type="hidden" name="action" value="bulkRegister" />&nbsp;<input type="submit" class="twikiSubmit" value="Bulk Register these people" />
   254 @
   255 
   256 
   257 1.1
   258 log
   259 @buildrelease
   260 @
   261 text
   262 @d1 1
   263 a1 1
   264 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="1"}%
   265 d19 4
   266 a22 4
   267 	* WikiName 
   268 	* Email
   269 	* !FirstName
   270 	* !LastName 
   271 d25 1
   272 a25 1
   273 	* LoginName - if not set will register with WikiName
   274 d29 2
   275 a30 2
   276 		* Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations
   277 		* Set LOGTOPIC = %REGISTERTOPIC%Log
   278 d32 1
   279 a32 1
   280 		* Set OVERWRITEHOMETOPICS = 0
   281 d42 6
   282 a47 6
   283 	1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm
   284 	2 Copy the above table to your clipboard
   285 	3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
   286 	4 Click the Bulk register button below
   287 	5 Read %LOGTOPIC%
   288 	6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
   289 d50 3
   290 a52 3
   291 	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.
   292 	2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]]
   293 	3 Only members of the %MAINWEB%.TWikiAdminGroup can run this.
   294 @