Bulk User Upload Macro

Hello,

I had not been able to add users with this Macro (Confluence v1.4.4, JDK1.5.0_04, Tomcat). The users simply did not appear in "Manage Users" although adding them again either with the User Manager or with this macro always revealed that the users already exist. To work around the problem I finally wrote my own small macro which might be handy to use:

## Creates a user with default-groups as used here at
## CoreMedia. Put this on your page and render it.
## Mind that any exception-handling e. g. for duplicate
## users is missing.
##
## Usage: 
##  {admin-create-user:loginname|passwd|email|fullname}
##
#set($username=$param0)
#set($userpasswd=$param1)
#set($useremail=$param2)
#set($userfullname=$param3)
##
#set($defaultGroups=["confluence-users", "common"])
##
#set($currentUser=$action.getRemoteUser())
#set($userManager=$currentUser.getUserManager())
#if(!$currentUser.inGroup("confluence-administrators"))
<p style="color:red;">
Macro can only be rendered by administrators.
</p>
#else
$userManager.flushCaches()
##
<hr/>
<div>
Going to create user ${username}...
</div>
#set($userObject=$userManager.createUser($username))
<div>
Created user ${username}.
</div>
$userObject.setPassword($userpasswd)
$userObject.setFullName($userfullname)
$userObject.setEmail($useremail)
<div>
Set password, etc. of user ${username}.
</div>
##
#foreach($group in $defaultGroups)
#set($groupObject=$userManager.getGroup($group))
#set($addResult=$userObject.addToGroup($groupObject))
<div>
Add user ${username} to group ${group}
</div>
#end
<hr/>
$userManager.flushCaches()
#end

And to remove users which did not get created correctly (or even for normal users) I created a macro to remove users:

## Removes a user from confluence
##
## Usage: 
##  {admin-remove-user:loginname}
##
#set($username=$param0)
##
#set($currentUser=$action.getRemoteUser())
#set($userManager=$currentUser.getUserManager())
#if(!$currentUser.inGroup("confluence-administrators"))
<p style="color:red;">
Macro can only be rendered by administrators.
</p>
#else
$userManager.flushCaches()
##
<hr/>
<div>
Going to delete user ${username}...
</div>
#set($userObject=$userManager.getUser($username))
#if($userObject)
#set($result=$userObject.remove())
<div>
Removed user ${username}
</div>
#end
<hr/>
$userManager.flushCaches()
#end

This code is finicky because it takes a couple attempts to get some your users entered.  The major issue with the program is that is says that it can not add users because the user already exist, but they are not in the "list users."    
Things that I found that may help:

1. Delete all quotes and comma-space

2. Make sure none of the fields are null

It's not working for me, I've installed the plugin and created a page with

{bulk-user-upload}

All I get is the following error...
Error rendering macro: java.lang.NoSuchMethodError: com.atlassian.confluence.user.UserAccessor.getGroup(Ljava/lang/String;)Lcom/opensymphony/user/Group;

Any ideas what I'm doing wrong? (I'm using version 2.1.3)

The Perl XML-RPC client page illustrates the use of Perl to upload users via the remote API. This has been tested with 2.1.3, but not with prior versions.

I desperately needed a way to add users so I tinkered with Mark Michaelis' contribution above to get this. I made two changes:

• removed the check for admin rights, since I was sure that only I would use it
• added the ability to specify up to three groups for each user
• added a check for existing user

If anyone happens across this and can suggest how to pass a list as a param, then the group processing could be done with an iterator. I couldn't figure that out. Also, if I have time I'd like to get a list of users from an attached CSV file; seems like it might be possible? Don't know.

The best solution would be for the Bulk User Upload Macro to actually work!

## Usage:
##  {admin-create-user:loginname|passwd|email|fullname[|group1[|group2[|group3]]]}
##
#set($username=$param0)
#set($userpasswd=$param1)
#set($useremail=$param2)
#set($userfullname=$param3)
#set($group1=$param4)
#set($group2=$param5)
#set($group3=$param6)
##
${username} ${userpasswd} ${useremail} ${userfullname} ${group1} ${group2} ${group3}
##
#set($myuseraccessor=$content.getUserAccessor())
##
#set($userObj=$myuseraccessor.getUser($username))
#if($userObj)
<span style="color:red">Already exists!</span>
#else
#set($userObj=$myuseraccessor.addUser($username,$userpasswd,$useremail,$userfullname))
#if($group1)
#set($addResult=$myuseraccessor.addMembership($group1,$username))
#end
#if($group2)
#set($addResult=$myuseraccessor.addMembership($group2,$username))
#end
#if($group3)
#set($addResult=$myuseraccessor.addMembership($group3,$username))
#end
<span style="color:green">Done!</span>
#end
<br />

[Confluence SOAP Client in Java] can also be used for bulk add (and remove) of users and of users to groups using csv files.

I would really love to use this plugin but it keeps stacking on me.  I've written an app to parse a bunch of LDAP filter matches for confluence groups 'Users' which gives me 450 AD users in nice-and-neat CSV just as described, my problem is it bales with hiberate issues such as 'Failed to lazily initialize a collection'. I'm lucky if its get to #3,

Also, if I add a user, it bales if I try to add it again, (it not just ignoring and carrying on with the next user).  As you can imagine this is a bit of a problem for 450 users.  I really need an automated upload route.

Perhaps related is that the system I'm trying to create users in already has content? dunno.

I hear the SOAP client reference, Ill try that next, heck I may even have to write something! 

Warning, this macro will silently fail (you get a blank page) if you have any accentuated (diacritical) character in a user full name. Just one such char and your whole list gets rejected.

hi, just testing this add-in on conf v2.6 and get a strange error that you might be able to point me in the right direction... when we create users with a group of confluence-users, the plugin creates its own group and uses that instead of using the confluence-users group that already exists in the system, even though the spelling is exactly the same - this causes issues when the user , created by the bulk upload, tries to login as the system errors with a message saying that permission is not allowed to the whole system.

i have run the bulk upload as an admin user and also as admin itself with the same results.

is there a configuration soemwhere that i have not assigned correctly ?

thanks

 richard buchan

The white space needs to be removed from the sample input:

testUser1,testPassword1,testEmail1,testFullName1,confluence-users
testUser2,testPassword2,testEmail2,testFullName2,confluence-users
testUser3,testPassword3,testEmail3,testFullName3,confluence-users

See also:

and Python snippet using remote API: http://confluence.atlassian.com/display/CONFEXT/Add+a+new+user+with+a+personal+space

but I'd prefer to get this function working within the wiki (with this macro) rather than command line.

Works for me, thank you!  You've saved me having to add 100 users manually!

Sweet! Works for me on Confluence 2.7.1, added 500 dummy users for performance testing with no problem. Thanks & great job. Now, only if there is a tool like this for JIRA...

ive been using this plugin on 2.10 and its saved me hours....but first attempt after 3.0 upgrade and its failing on "add users".  is there an update required for compatibility?

here's a synopsis of the error:

System Error

A system error has occurred — our apologies!

Cause

java.lang.RuntimeException: Error rendering template for decorator root

    at com.atlassian.confluence.setup.velocity.ApplyDecoratorDirective.render(ApplyDecoratorDirective.java:210)

caused by: java.lang.RuntimeException: Error rendering template for decorator page

    at com.atlassian.confluence.setup.velocity.ApplyDecoratorDirective.render(ApplyDecoratorDirective.java:210)

caused by: org.apache.velocity.exception.MethodInvocationException: Invocation of method 'getViewableLabels' in class com.atlassian.confluence.themes.PageHelper threw exception net.sf.hibernate.LazyInitializationException: Failed to lazily initialize a collection at /labels/labels-editor.vm[line 6, column 25]

    at org.apache.velocity.runtime.parser.node.ASTIdentifier.execute(ASTIdentifier.java:223)

caused by: net.sf.hibernate.LazyInitializationException: Failed to lazily initialize a collection

    at net.sf.hibernate.collection.PersistentCollection.initialize(PersistentCollection.java:201)

caused by: net.sf.hibernate.HibernateException: collection was evicted

    at net.sf.hibernate.impl.SessionImpl.initializeCollection(SessionImpl.java:3305)