diff -r 000000000000 -r 414e01d06fd5 data/TWiki/BulkRegistration.txt,v --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/data/TWiki/BulkRegistration.txt,v Sat Jan 26 15:50:53 2008 +0100 @@ -0,0 +1,196 @@ +head 1.3; +access; +symbols; +locks; strict; +comment @# @; + + +1.3 +date 2008.01.22.03.21.36; author TWikiContributor; state Exp; +branches; +next 1.2; + +1.2 +date 2006.04.01.05.55.04; author TWikiContributor; state Exp; +branches; +next 1.1; + +1.1 +date 2006.02.01.12.01.16; author TWikiContributor; state Exp; +branches; +next ; + + +desc +@new-topic +@ + + +1.3 +log +@buildrelease +@ +text +@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="3"}% +%META:TOPICPARENT{name="ManagingUsers"}% +---+ Bulk Registration + +Administrators can use this topic to register (i.e. create logins and UserTopics) for a group of people quickly. +Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata. +Then press the button on this page to perform registration for those users. +Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required. +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. +To announce them use the BulkResetPassword feature: this will assign a new random password and notify users. + +---++ Bulk Registration usage + +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. + +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! + +---+++ Mandatory fields + * !WikiName + * !FirstName + * !LastName + +---+++ Optional fields + * LoginName - if not set will register with WikiName + + +---++ Settings + * Define where to pick up the table of users to register + * Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations + * Use this to define where to log the bulk registration process. It needs + to be a topic name in this web. + * Set LOGTOPIC = %REGISTERTOPIC%Log + * Set this to 1 to make the bulk registration overwrite any existing user + topics. By default, existing user topics are left alone. + * Set OVERWRITEHOMETOPICS = 0 + +---+++ Example format +The following should be inserted into your REGISTERTOPIC as a table. + +| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike | +| Test | User | you@@example.com | TestUser | A | B | C | + + +To use this: + 1 Make sure that the Custom fields appear on the %TWIKIWEB%.UserForm + 2 Copy the above table to your clipboard + 3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here. + 4 Click the Bulk register button below + 5 Read %LOGTOPIC% + 6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts. + +Notes: + 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. + 2 You are responsible for ensuring that the fieldnames appear in the [[%TWIKIWEB%.UserForm]] + 3 Only administrators can run this. + +%IF{ + "context passwords_modifyable" + then="" + else="%MAKETEXT{"Sorry, the password system is currently read only, please contact [_1]" args="%WIKIWEBMASTER%"}%
" +}% + +
+  + + + +
+ +---++ %REGISTERTOPIC% + +%INCLUDE{%REGISTERTOPIC%}% + + +---++ %LOGTOPIC% + +%INCLUDE{%LOGTOPIC%}% + + +__Related Topics:__ AdminToolsCategory +@ + + +1.2 +log +@buildrelease +@ +text +@d1 1 +a1 1 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="2"}% +d5 1 +a5 1 +The %MAINWEB%.TWikiAdminGroup can use %TOPIC% to register (i.e. create logins and UserTopics) for a group of people quickly. +d14 1 +a14 1 +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. +d16 1 +a16 1 +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! +d19 1 +a19 2 + * WikiName + * Email +d28 1 +d30 2 +d33 2 +a34 1 + +d45 1 +a45 1 + 1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm +d54 2 +a55 2 + 2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]] + 3 Only members of the %MAINWEB%.TWikiAdminGroup can run this. +d57 8 +d66 2 +a67 1 +  +@ + + +1.1 +log +@buildrelease +@ +text +@d1 1 +a1 1 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="1"}% +d19 4 +a22 4 + * WikiName + * Email + * !FirstName + * !LastName +d25 1 +a25 1 + * LoginName - if not set will register with WikiName +d29 2 +a30 2 + * Set REGISTERTOPIC = %MAINWEB%.UnprocessedRegistrations + * Set LOGTOPIC = %REGISTERTOPIC%Log +d32 1 +a32 1 + * Set OVERWRITEHOMETOPICS = 0 +d42 6 +a47 6 + 1 Make sure that the Custom fields appear on the %MAINWEB%.UserForm + 2 Copy the above table to your clipboard + 3 Click through and paste this on %REGISTERTOPIC%, save the topic and return here. + 4 Click the Bulk register button below + 5 Read %LOGTOPIC% + 6 When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts. +d50 3 +a52 3 + 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. + 2 You are responsible for ensuring that the fieldnames appear in the [[%MAINWEB%.UserForm]] + 3 Only members of the %MAINWEB%.TWikiAdminGroup can run this. +@