data/TWiki/BulkRegistration.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 head	1.3;
     2 access;
     3 symbols;
     4 locks; strict;
     5 comment	@# @;
     6 
     7 
     8 1.3
     9 date	2008.01.22.03.21.36;	author TWikiContributor;	state Exp;
    10 branches;
    11 next	1.2;
    12 
    13 1.2
    14 date	2006.04.01.05.55.04;	author TWikiContributor;	state Exp;
    15 branches;
    16 next	1.1;
    17 
    18 1.1
    19 date	2006.02.01.12.01.16;	author TWikiContributor;	state Exp;
    20 branches;
    21 next	;
    22 
    23 
    24 desc
    25 @new-topic
    26 @
    27 
    28 
    29 1.3
    30 log
    31 @buildrelease
    32 @
    33 text
    34 @%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}%
    35 %META:TOPICPARENT{name="ManagingUsers"}%
    36 ---+ Bulk Registration
    37 
    38 Administrators can use this topic to register (i.e. create logins and UserTopics) for a group of people quickly. 
    39 Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata.
    40 Then press the button on this page to perform registration for those users. 
    41 Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required.
    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.
    43 To announce them use the BulkResetPassword feature: this will assign a new random password and notify users. 
    44 
    45 ---++ Bulk Registration usage
    46 
    47 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. 
    48 
    49 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!
    50 
    51 ---+++ Mandatory fields
    52    * !WikiName 
    53    * !FirstName
    54    * !LastName 
    55 
    56 ---+++ Optional fields
    57    * LoginName - if not set will register with WikiName
    58 
    59 
    60 ---++ Settings
    61    * Define where to pick up the table of users to register
    62       * Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations
    63    * Use this to define where to log the bulk registration process. It needs
    64      to be a topic name in this web.
    65       * Set LOGTOPIC = %REGISTERTOPIC%Log
    66    * Set this to 1 to make the bulk registration overwrite any existing user
    67      topics. By default, existing user topics are left alone.
    68       * Set OVERWRITEHOMETOPICS = 0
    69 
    70 ---+++ Example format
    71 The following should be inserted into your REGISTERTOPIC as a table.
    72 <verbatim>
    73 | FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
    74 | Test | User | you@@example.com | TestUser | A | B | C |
    75 </verbatim>
    76 
    77 To use this:
    78    1 Make sure that the Custom fields appear on the %TWIKIWEB%.UserForm
    79    2 Copy the above table to your clipboard
    80    3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
    81    4 Click the Bulk register button below
    82    5 Read %LOGTOPIC%
    83    6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
    84 
    85 Notes:
    86    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.
    87    2 You are responsible for ensuring that the fieldnames appear in the [[%TWIKIWEB%.UserForm]]
    88    3 Only administrators can run this.
    89 
    90 %IF{
    91   "context passwords_modifyable"
    92   then=""
    93   else="<strong>%MAKETEXT{"Sorry, the password system is currently read only, please contact [_1]" args="%WIKIWEBMASTER%"}%</strong><br />"
    94 }%
    95 <!--
    96       * Set NOTMODIFYABLE = %IF{"context passwords_modifyable" then="" else="DISABLED"}%
    97 -->
    98 <form name="bulkRegister" action="%SCRIPTURLPATH{"manage"}%/%REGISTERTOPIC%" method="post">
    99 <input type="hidden" name="action" value="bulkRegister" />&nbsp;
   100 <input %NOTMODIFYABLE% type="submit" class="twikiSubmit" value="Bulk Register these people" />
   101 <input type="hidden" name="LogTopic" value="%LOGTOPIC%" />
   102 <input type="hidden" name="OverwriteHomeTopics" value="%OVERWRITEHOMETOPICS%" />
   103 </form>
   104 
   105 ---++ %REGISTERTOPIC%
   106 
   107 %INCLUDE{%REGISTERTOPIC%}%
   108 
   109 
   110 ---++ %LOGTOPIC%
   111 
   112 %INCLUDE{%LOGTOPIC%}%
   113 
   114 
   115 __Related Topics:__ AdminToolsCategory
   116 @
   117 
   118 
   119 1.2
   120 log
   121 @buildrelease
   122 @
   123 text
   124 @d1 1
   125 a1 1
   126 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="2"}%
   127 d5 1
   128 a5 1
   129 The %MAINWEB%.TWikiAdminGroup can use %TOPIC% to register (i.e. create logins and UserTopics) for a group of people quickly. 
   130 d14 1
   131 a14 1
   132 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. 
   133 d16 1
   134 a16 1
   135 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!
   136 d19 1
   137 a19 2
   138    * WikiName 
   139    * Email
   140 d28 1
   141 d30 2
   142 d33 2
   143 a34 1
   144 
   145 d45 1
   146 a45 1
   147    1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm
   148 d54 2
   149 a55 2
   150    2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]]
   151    3 Only members of the %MAINWEB%.TWikiAdminGroup can run this.
   152 d57 8
   153 d66 2
   154 a67 1
   155 <input type="hidden" name="action" value="bulkRegister" />&nbsp;<input type="submit" class="twikiSubmit" value="Bulk Register these people" />
   156 @
   157 
   158 
   159 1.1
   160 log
   161 @buildrelease
   162 @
   163 text
   164 @d1 1
   165 a1 1
   166 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="1"}%
   167 d19 4
   168 a22 4
   169 	* WikiName 
   170 	* Email
   171 	* !FirstName
   172 	* !LastName 
   173 d25 1
   174 a25 1
   175 	* LoginName - if not set will register with WikiName
   176 d29 2
   177 a30 2
   178 		* Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations
   179 		* Set LOGTOPIC = %REGISTERTOPIC%Log
   180 d32 1
   181 a32 1
   182 		* Set OVERWRITEHOMETOPICS = 0
   183 d42 6
   184 a47 6
   185 	1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm
   186 	2 Copy the above table to your clipboard
   187 	3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
   188 	4 Click the Bulk register button below
   189 	5 Read %LOGTOPIC%
   190 	6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.
   191 d50 3
   192 a52 3
   193 	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.
   194 	2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]]
   195 	3 Only members of the %MAINWEB%.TWikiAdminGroup can run this.
   196 @