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