data/TWiki/BulkRegistration.txt,v
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/BulkRegistration.txt,v	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,196 @@
     1.4 +head	1.3;
     1.5 +access;
     1.6 +symbols;
     1.7 +locks; strict;
     1.8 +comment	@# @;
     1.9 +
    1.10 +
    1.11 +1.3
    1.12 +date	2008.01.22.03.21.36;	author TWikiContributor;	state Exp;
    1.13 +branches;
    1.14 +next	1.2;
    1.15 +
    1.16 +1.2
    1.17 +date	2006.04.01.05.55.04;	author TWikiContributor;	state Exp;
    1.18 +branches;
    1.19 +next	1.1;
    1.20 +
    1.21 +1.1
    1.22 +date	2006.02.01.12.01.16;	author TWikiContributor;	state Exp;
    1.23 +branches;
    1.24 +next	;
    1.25 +
    1.26 +
    1.27 +desc
    1.28 +@new-topic
    1.29 +@
    1.30 +
    1.31 +
    1.32 +1.3
    1.33 +log
    1.34 +@buildrelease
    1.35 +@
    1.36 +text
    1.37 +@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}%
    1.38 +%META:TOPICPARENT{name="ManagingUsers"}%
    1.39 +---+ Bulk Registration
    1.40 +
    1.41 +Administrators can use this topic to register (i.e. create logins and UserTopics) for a group of people quickly. 
    1.42 +Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata.
    1.43 +Then press the button on this page to perform registration for those users. 
    1.44 +Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required.
    1.45 +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.46 +To announce them use the BulkResetPassword feature: this will assign a new random password and notify users. 
    1.47 +
    1.48 +---++ Bulk Registration usage
    1.49 +
    1.50 +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.51 +
    1.52 +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.53 +
    1.54 +---+++ Mandatory fields
    1.55 +   * !WikiName 
    1.56 +   * !FirstName
    1.57 +   * !LastName 
    1.58 +
    1.59 +---+++ Optional fields
    1.60 +   * LoginName - if not set will register with WikiName
    1.61 +
    1.62 +
    1.63 +---++ Settings
    1.64 +   * Define where to pick up the table of users to register
    1.65 +      * Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations
    1.66 +   * Use this to define where to log the bulk registration process. It needs
    1.67 +     to be a topic name in this web.
    1.68 +      * Set LOGTOPIC = %REGISTERTOPIC%Log
    1.69 +   * Set this to 1 to make the bulk registration overwrite any existing user
    1.70 +     topics. By default, existing user topics are left alone.
    1.71 +      * Set OVERWRITEHOMETOPICS = 0
    1.72 +
    1.73 +---+++ Example format
    1.74 +The following should be inserted into your REGISTERTOPIC as a table.
    1.75 +<verbatim>
    1.76 +| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
    1.77 +| Test | User | you@@example.com | TestUser | A | B | C |
    1.78 +</verbatim>
    1.79 +
    1.80 +To use this:
    1.81 +   1 Make sure that the Custom fields appear on the %TWIKIWEB%.UserForm
    1.82 +   2 Copy the above table to your clipboard
    1.83 +   3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
    1.84 +   4 Click the Bulk register button below
    1.85 +   5 Read %LOGTOPIC%
    1.86 +   6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
    1.87 +
    1.88 +Notes:
    1.89 +   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.90 +   2 You are responsible for ensuring that the fieldnames appear in the [[%TWIKIWEB%.UserForm]]
    1.91 +   3 Only administrators can run this.
    1.92 +
    1.93 +%IF{
    1.94 +  "context passwords_modifyable"
    1.95 +  then=""
    1.96 +  else="<strong>%MAKETEXT{"Sorry, the password system is currently read only, please contact [_1]" args="%WIKIWEBMASTER%"}%</strong><br />"
    1.97 +}%
    1.98 +<!--
    1.99 +      * Set NOTMODIFYABLE = %IF{"context passwords_modifyable" then="" else="DISABLED"}%
   1.100 +-->
   1.101 +<form name="bulkRegister" action="%SCRIPTURLPATH{"manage"}%/%REGISTERTOPIC%" method="post">
   1.102 +<input type="hidden" name="action" value="bulkRegister" />&nbsp;
   1.103 +<input %NOTMODIFYABLE% type="submit" class="twikiSubmit" value="Bulk Register these people" />
   1.104 +<input type="hidden" name="LogTopic" value="%LOGTOPIC%" />
   1.105 +<input type="hidden" name="OverwriteHomeTopics" value="%OVERWRITEHOMETOPICS%" />
   1.106 +</form>
   1.107 +
   1.108 +---++ %REGISTERTOPIC%
   1.109 +
   1.110 +%INCLUDE{%REGISTERTOPIC%}%
   1.111 +
   1.112 +
   1.113 +---++ %LOGTOPIC%
   1.114 +
   1.115 +%INCLUDE{%LOGTOPIC%}%
   1.116 +
   1.117 +
   1.118 +__Related Topics:__ AdminToolsCategory
   1.119 +@
   1.120 +
   1.121 +
   1.122 +1.2
   1.123 +log
   1.124 +@buildrelease
   1.125 +@
   1.126 +text
   1.127 +@d1 1
   1.128 +a1 1
   1.129 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="2"}%
   1.130 +d5 1
   1.131 +a5 1
   1.132 +The %MAINWEB%.TWikiAdminGroup can use %TOPIC% to register (i.e. create logins and UserTopics) for a group of people quickly. 
   1.133 +d14 1
   1.134 +a14 1
   1.135 +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. 
   1.136 +d16 1
   1.137 +a16 1
   1.138 +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!
   1.139 +d19 1
   1.140 +a19 2
   1.141 +   * WikiName 
   1.142 +   * Email
   1.143 +d28 1
   1.144 +d30 2
   1.145 +d33 2
   1.146 +a34 1
   1.147 +
   1.148 +d45 1
   1.149 +a45 1
   1.150 +   1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm
   1.151 +d54 2
   1.152 +a55 2
   1.153 +   2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]]
   1.154 +   3 Only members of the %MAINWEB%.TWikiAdminGroup can run this.
   1.155 +d57 8
   1.156 +d66 2
   1.157 +a67 1
   1.158 +<input type="hidden" name="action" value="bulkRegister" />&nbsp;<input type="submit" class="twikiSubmit" value="Bulk Register these people" />
   1.159 +@
   1.160 +
   1.161 +
   1.162 +1.1
   1.163 +log
   1.164 +@buildrelease
   1.165 +@
   1.166 +text
   1.167 +@d1 1
   1.168 +a1 1
   1.169 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="1"}%
   1.170 +d19 4
   1.171 +a22 4
   1.172 +	* WikiName 
   1.173 +	* Email
   1.174 +	* !FirstName
   1.175 +	* !LastName 
   1.176 +d25 1
   1.177 +a25 1
   1.178 +	* LoginName - if not set will register with WikiName
   1.179 +d29 2
   1.180 +a30 2
   1.181 +		* Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations
   1.182 +		* Set LOGTOPIC = %REGISTERTOPIC%Log
   1.183 +d32 1
   1.184 +a32 1
   1.185 +		* Set OVERWRITEHOMETOPICS = 0
   1.186 +d42 6
   1.187 +a47 6
   1.188 +	1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm
   1.189 +	2 Copy the above table to your clipboard
   1.190 +	3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
   1.191 +	4 Click the Bulk register button below
   1.192 +	5 Read %LOGTOPIC%
   1.193 +	6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
   1.194 +d50 3
   1.195 +a52 3
   1.196 +	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.197 +	2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]]
   1.198 +	3 Only members of the %MAINWEB%.TWikiAdminGroup can run this.
   1.199 +@