Difference between revisions of "Bulk User add"

From Studentnet Wiki
Jump to navigation Jump to search
 
Line 3: Line 3:
 
To use this facility it will require a csv of the users in a format so that the system can use it.  
 
To use this facility it will require a csv of the users in a format so that the system can use it.  
  
It is important to keep in mind that when uploading a group of users - users that were manually added to groups by administrators are not automatically removed.
+
 
  
 
== Creating a CSV file ==
 
== Creating a CSV file ==

Latest revision as of 00:39, 2 February 2022

Under the user menu is ability to add a bulk list of users. This is generally for users that will not exist in the directory such as parents. To use this facility it will require a csv of the users in a format so that the system can use it.


Creating a CSV file

Your CSV file should contain the following headings:

Email, User Name, First Name, Last Name, Password, Role, SIS_ID

e.g. Email, User Name, First Name, Last Name, Password, Role, SIS_ID

principal@example.edu.au,principal,School,Principal,pri2009,teacher, 23
joeblogs@example.edu.au,joeblogs,joe,blogs,joe2009,teacher, 24
a.student@example.edu.au,SN1234,Alfred,Student,as2010,student, 25

The following email accounts will be created:

principal@example.edu.au with a password of pri2009
joeblogs@example.edu.au with a password of joe2009
a.student@example.edu.au with a password of as2010, and a SSO username of SN12345678

SIS_ID is the management ID

Valid roles must be chosen from the following list:

  • Student
  • Alum
  • Teacher
  • Parent
Recovery Phone Number

This is the phone number that is used in password reset. As with the other headings it must be put exactly as above. This field is not compulsory and may be left out if it is not required.

Recovery Email Address

This is the email address that is used in the in password reset. As with the other headings it must be put exactly as above. This field is not compulsory and may be left out if it is not required.

Additional Attributes

This is where things can get a little more interesting. You can now add additional attributes to the import and will will import them into the Custom Attributes for the user. This can be useful when having to bring additional information for a user that needs to be sent to the service provider, but doesn't quite fit in the existing categories. For example StudentID, SynID etc

These are not compulsory and can be left blank for the users that do not have such a value.


With the extra attributes the CSV file may looks like this:

Email, User Name, First Name, Last Name, Password, Role, Recovery Email, Recovery Phone, SynID, SIS_ID
principal@example.edu.au,principal,School,Principal,pri2009,teacher, othermail@gmail.com, 0412345678, 314159, 23
joeblogs@example.edu.au,joeblogs,joe,blogs,joe2009,teacher, joemail@gmail.com, 045678910, 123456, 24
a.student@example.edu.au,SN1234,Alfred,Student,as2010,student, sparemail@gmail.com, 042345678, 234566, 25

As well as another attribute called SynID. Once the user logs in, all the normal attributes will be created and sent to the service provider, additionally this user will have SynID sent. NB Password reset information is NOT exposed to service providers.

So when the user is created all the information about the user is already there without need for further interaction.

Just to make things clear on these new attributes, they can be left blank for users that they do not apply, or just simply not included in the import. Remember these imports can be run as scheduled imports through the sync profile interface.

Bulk user add - Encrypted passwords

As a new feature you can now do a bulk user upload with the password being already encrypted. Currently supported encryption formats are BCrypt, SHA1 and MySQL Passwords. To enable the Encrypted Password feature simply adjust the headings to be:

Email, User Name, First Name, Last Name, Encrypted Password, Role

This will tell the upload facility that the password is already encrypted and it does not need to do any further encryption.