Actions

Proposals/Done/Groups csv create: Difference between revisions

From Mahara Wiki

< Proposals‎ | Done
mNo edit summary
m (Anitsirk moved page Developer Area/Specifications in Development/Done/Groups csv create to Proposals/Done/Groups csv create: Shorter navigation, not always technical)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This feature was funded by the [http://www.uwcsea.edu.sg/ United World College of South East Asia] and implemented by [http://catalyst.net.nz Catalyst IT] in Mahara 1.5.
The following changes would need to be made to allow this.
The following changes would need to be made to allow this.


Create a groupid or shortname which is unique (but can also be null)
* Create a groupid or shortname which is unique (but can also be null) &#x2713;
Create a csvfile structure for uploading csvs to create groups
* Create a csvfile structure for uploading csvs to create groups
Create a csvfile structure for uploading csvs to enrol users into groups
* Create a csvfile structure for uploading csvs to enrol users into groups
 
 
* Aspects of the work:
1. A CSV file that contains the group name and the group members (a unique ID that also exists in Mahara, e.g. their email or their login
if  they cannot change that -> still to be determined which one is the best).
2. When the CSV file is imported, a controlled course membership group is created if it does not already exist and members are added.
3. If the group already exists, its members are only updated -> new ones added, old ones removed.
4. The CSV file also determines which members are admins, tutors and regular members. Maybe in order to do this we need 2 CSV files (still
to  be determined).
5. Groups that are not listed in the CSV file are not changed.
 


===Group Identifier===


<div id="section_1">
The group identifier/shortname is a unique text field (similar to group name), but will not be used for display purposes. On upgrade, will default to group name. The field name in database is shortname.


==Group ID==
The identifier can be viewed/changed on the edit page, and the search function (in internal search) searches against shortname as well.
The group id will be a unique nullable field that holds a shortname or groupid
which is different from the already present id field (which is only for the database)


</div><div id="section_2">
Language strings for group name are changed to "Group Display Name" instead of "Group Name"
 
===CSV to create groups===


==CSV to create groups==
This file will need to have group name, group shortname, group desc, group type
This file will need to have group name, group shortname, group desc, group type


</div><div id="section_3">
===CSV to enrol users into groups===


==CSV to enrol users into groups==
This file will need to have group shortname, user studentid, member type
This file will need to have group shortname, user studentid


- The studentid will be focused on to start with, then other ways of identifying the user
* The studentid will be focused on to start with, then other ways of identifying the user
may be created, such as username or email
may be created, such as username or email


</div>
The member type will show either admin tutor or user
 
This would need to keep track of all the users in this file for each group, and remove extra users from groups listed
in this file, but don't have that username.
 
 
===Alternate CSV Format===
 
Use one CSV, will have the following in it
groupname, groupshort, groupdesc, grouptype, adminusers, endofadmins, tutorusers, endoftutors, normalusers
testgroup,test,a test group showing csv strut,controlled,admin1,admin1,!,tutor1,tutor2,!,user1,user2
 
Here we have a list of all users, seperated into member types, between each type is a ! to delimit them
This can be processed by a loop that runs til it gets a ! and changes user type
 
This allows for the functionality of removing users that aren't in the file, though
it has the side effect of having group metadata and users all in one file.
 
I (Hugh) would suggest the first two formats, and have two seperate files for creation and population/updating

Latest revision as of 17:43, 11 July 2020

This feature was funded by the United World College of South East Asia and implemented by Catalyst IT in Mahara 1.5.

The following changes would need to be made to allow this.

  • Create a groupid or shortname which is unique (but can also be null) ✓
  • Create a csvfile structure for uploading csvs to create groups
  • Create a csvfile structure for uploading csvs to enrol users into groups


  • Aspects of the work:
1. A CSV file that contains the group name and the group members (a unique ID that also exists in Mahara, e.g. their email or their login 
if  they cannot change that -> still to be determined which one is the best). 
2. When the CSV file is imported, a controlled course membership group is created if it does not already exist and members are added. 
3. If the group already exists, its members are only updated -> new ones added, old ones removed. 
4. The CSV file also determines which members are admins, tutors and regular members. Maybe in order to do this we need 2 CSV files (still 
to  be determined). 
5. Groups that are not listed in the CSV file are not changed.


Group Identifier

The group identifier/shortname is a unique text field (similar to group name), but will not be used for display purposes. On upgrade, will default to group name. The field name in database is shortname.

The identifier can be viewed/changed on the edit page, and the search function (in internal search) searches against shortname as well.

Language strings for group name are changed to "Group Display Name" instead of "Group Name"

CSV to create groups

This file will need to have group name, group shortname, group desc, group type

CSV to enrol users into groups

This file will need to have group shortname, user studentid, member type

  • The studentid will be focused on to start with, then other ways of identifying the user

may be created, such as username or email

The member type will show either admin tutor or user

This would need to keep track of all the users in this file for each group, and remove extra users from groups listed in this file, but don't have that username.


Alternate CSV Format

Use one CSV, will have the following in it groupname, groupshort, groupdesc, grouptype, adminusers, endofadmins, tutorusers, endoftutors, normalusers testgroup,test,a test group showing csv strut,controlled,admin1,admin1,!,tutor1,tutor2,!,user1,user2

Here we have a list of all users, seperated into member types, between each type is a ! to delimit them This can be processed by a loop that runs til it gets a ! and changes user type

This allows for the functionality of removing users that aren't in the file, though it has the side effect of having group metadata and users all in one file.

I (Hugh) would suggest the first two formats, and have two seperate files for creation and population/updating

Retrieved from ‘https://wiki.mahara.org/index.php?title=Proposals/Done/Groups_csv_create&oldid=11609’