Actions

Difference between revisions of "Developer Area/Specifications in Development/Groups csv create"

From Mahara Wiki

< Developer Area‎ | Specifications in Development
(added more spec to header)
Line 1: Line 1:
 +
;ToDo
 +
 
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)
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:  
+
* 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  
 
  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).  
 
  if  they cannot change that -> still to be determined which one is the best).  
Line 16: Line 18:
  
  
==Group idnumber==
+
===Group idnumber===
  
 
The group idnumber will be a unique field that holds a shortname or groupid which is different from the already present id field (which is only for the database)
 
The group idnumber will be a unique field that holds a shortname or groupid which is different from the already present id field (which is only for the database)
Line 22: Line 24:
 
We could either have a nullable field in db, that we enforce uniqueness on or we could have a unique non-nullable field in db, and provide some unique default to store (which can be changed).
 
We could either have a nullable field in db, that we enforce uniqueness on or we could have a unique non-nullable field in db, and provide some unique default to store (which can be changed).
  
==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
  
==CSV to enrol users into groups==
+
===CSV to enrol users into groups===
 +
 
 
This file will need to have group shortname, user studentid
 
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

Revision as of 16:53, 24 May 2011

ToDo

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 idnumber

The group idnumber will be a unique field that holds a shortname or groupid which is different from the already present id field (which is only for the database)

We could either have a nullable field in db, that we enforce uniqueness on or we could have a unique non-nullable field in db, and provide some unique default to store (which can be changed).

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

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

may be created, such as username or email