.. include:: /shortcuts.rstext .. index:: pair: Administration; Group single: Site administrator; Group administration single: Institution administrator; Group administration .. _site_admin_groups: Groups ---------------- *Administration → Groups* In the *Groups* menu of the administration **site administrators** can: * add administrators to groups * delete groups * manage group categories * Add and update groups in bulk * Add and update group membership in bulk In the *Groups* menu of the administration **institution administrators** can: * Add and update groups in bulk * Add and update group membership in bulk .. index:: pair: Group; Administer groups single: Link group names from administrator interface Administer groups ~~~~~~~~~~~~~~~~~~~ *Administration → Groups → Administer groups* .. note:: *Administer groups* is only accessible by site administrators. You see an overview of all the groups on the site. .. figure:: /images/administration/groups_administer.* :alt: Administer groups Administer groups #. Search a group by its name or category. #. **Group name**: The table is sorted alphabetically according to the group name. The group names are linked for easy access to their group homepages. #. **Members**: Number of group members in each group. #. **Administrators**: Number of group administrators per group. #. **Group type**: Overview of whether and how users can join this group. #. **Group category**: Display of the group category that is associated with this group. #. **Visibility**: Overview of who has access to this group - members or the public. #. Click the *Manage* button |manage| to :ref:`change the group file quota ` or to :ref:`add or remove group administrators `. #. Click the *Delete* button |delete| to delete a group. .. warning:: When you delete a group, all its content - forum posts, files and pages - will be deleted permanently and cannot be restored. .. index:: single: Update group quota .. _group_file_quota: Group file quota ^^^^^^^^^^^^^^^^^^^^^^^^ You can :ref:`specify a default group file quota ` in *Plugins*. This allows you to limit the file space that each group can take up. Here you can update the file quota for just one group. .. figure:: /images/administration/groups_quota.* :alt: Change the group file quota Change the group file quota You get to this page by clicking the *Manage* button |manage| next to a group on the *Administer groups* page. #. **File quota**: Change the file quota that this particular group can have. #. Click the *Save* button to save your change. .. index:: pair: Group; Group administrators .. _group_admins: Add or remove administrators ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add to or remove administrators from a group by clicking the *Manage* button |manage| next to a group on the *Administer groups* page. .. figure:: /images/administration/groups_admins.* :alt: Add or remove group administrators Add or remove group administrators #. **Potential administrators**: Select the users you wish to make group administrators. You can select multiple users at once using ``Ctrl`` and ``Shift`` click. #. **Search**: If you have too many users on your site and you cannot see / find the users you want, you can search for them here. #. Add the potential group administrators to the right-hand side - Current administrators - by clicking the *right-arrow* button |right-arrow|. #. **Current administrators**: If you want to remove an existing or accidentally added group administrator, you can remove the user from the list on the right-hand side by clicking on the user. #. Then click the *left-arrow* button |left-arrow|, and the user is removed from the list. #. When you have chosen all members you wish to make group administrators, click the *Submit* button. .. note:: You can also double-click a name and it will be moved to the other side. .. index:: pair: Group; Group category - manage .. _group_categories: Group categories ~~~~~~~~~~~~~~~~~~~~ *Administration → Groups → Group categories* .. note:: *Group categories* is only accessible by site administrators. Group categories help you to filter your groups more easily on the *My groups* and *Find groups* pages. A group administrator can always assign one group category to a group if categories are enabled. .. figure:: /images/administration/groups_categories.* :alt: Manage group categories Manage group categories #. **Enable group categories**: Tick this checkbox to enable group categories for the entire site. #. Click the *Submit* button to save your choice. #. **Name**: Existing group categories are listed. #. Create a new group category by typing its name and then clicking the *Add* button. #. Edit a group category name by clicking the *Edit* button |edit|, change the name and then click the *Update* button. If you want to abort the action, click the *Cancel* button. #. Click the *Delete* button |delete| to permanently delete this group category. .. note:: Group categories are not hierarchical and are available to everybody on the site. Any user who can create groups can assign a group category when the feature has been enabled. .. index:: pair: Group; Group bulk creation and update single: Add groups by CSV single: Update groups by CSV .. _groups_csv_add: Add and update groups by CSV ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ *Administration → Groups → Add groups by CSV* .. note:: Both site and institution administrators can add and update groups by CSV file. You can create multiple groups at once by uploading basic information about them via a CSV file. .. figure:: /images/administration/groups_csv_add.* :alt: Add and update groups by CSV Add and update groups by CSV #. Create a CSV file that contains at a minimum the fields ``shortname,displayname,roles``. #. **Institution**: Choose the institution for which you want to create the groups. This is just for internal administrative purposes so that institution administrators do not overwrite each other's groups. #. **CSV file**: Choose the CSV file from your computer that contains the groups. #. **Update groups**: Place a check mark in this box if you are updating already existing groups. #. Click the *Add groups by CSV* button to make the changes. Here is a full list of all the possible fields that you can specify: * **controlled** - Group administrators can add users to the group without their consent, and members cannot leave the group. * **description** - Brief description about the purpose of this group. * **displayname** - The group name that appears around the site. * **editroles** - You can choose which roles will be allowed to create and edit pages owned by the group. If your group contains only members and administrators, then "Group administrators" and "Everyone except members" are identical. These edit permissions will also be used by default for new group files. Permissions can be changed on individual files in the group files area. * all: everyone in the group * notmembers: everyone except members in a course group that has tutors and administrators * admin: only group administrators * **hidden** - Choose to not list this group on the *Find groups* page. * **hidemembers** - Choose to hide group members from non-members. * **hidemembersfrommembers** - Choose to hide group members from everybody but the group administrator. * **invitefriends** - Choose to allow group members to invite their friends to the group. * **open** - Allow users to join the group without approval from the group administrator. * **public** - Allow people who are not logged in to view this group including the forums. * **quota** - Define the group file quota. * **request** - Allow users to send membership requests to group administrators. * **roles** - Choose to have a course or standard group. The roles in these group types are: * course: member, tutor, administrator * standard: member, administrator * **shortname** - This is the name used to identify this group in the database. This should be only one word. It is also used to identify the group when you :ref:`add or update its members by CSV `. * **submitpages** - Choose to allow the submission of pages to this group. If you create a course group, this setting is automatically chosen. * **suggestfriends** - Allow group members to send their friends a recommendation to join this group. * **usersautoadded** - Choose to have all new users on the site added to the group automatically. .. note:: For fields that require a Yes / No value, you need to put a numeric value into the CSV file: * No = 0 * Yes = 1 .. figure:: /images/administration/groups_csv.* :alt: Sample CSV file for a group upload Sample CSV file for a group upload When you look at your CSV file in a text editor and not a spreadsheet software, the above sample file looks like this: | ``"shortname","displayname","roles","usersautoadded","public","hidemembersfrommembers"`` | ``"public","Public group","standard",0,1,1`` | ``"course","Course group","course",1,0,0`` .. warning:: Do not delete this CSV file if you intend to make changes to your groups in bulk or if you want to add group members in bulk to these groups. There is no easy way to retrieve the group shortname unless you consult the database on the backend of Mahara. .. index:: pair: Group; Group members bulk update single: Update group members by CSV .. _groups_update_members: Update group members by CSV ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ *Administration → Groups → Update group members by CSV* .. note:: Both site and institution administrators can add and update group members by CSV file. You can easily update members of :ref:`groups that you have created via a CSV file `. .. figure:: /images/administration/groups_update_members.* :alt: Update group members by CSV Update group members by CSV #. Create a CSV file that contains the following fields: ``shortname,username,role`` in the first row. Then add groups and users that should become members of these groups. You can check their usernames on the :ref:`User search ` page. #. **Institution**: Choose the institution in which the groups were created. #. **CSV file**: Choose the CSV file from your computer that contains the group members mapped to groups. #. Click the *Update group members by CSV* button to add to or remove members from the groups that you have specified. .. warning:: If you manually added users to a group whose members you want to update via CSV file, these users will be removed from that group when you update the group membership and do not have them listed in the CSV file. Thus, be careful once you have added users manually. Always leave at least one administrator in a group. .. note:: You can only update group membership by CSV of users who belong to the institution in which you created the groups by CSV. All other users must be added manually. .. figure:: /images/administration/groups_csv_members.* :alt: Sample CSV file for updating group membership Sample CSV file for updating group membership When you look at your CSV file in a text editor and not a spreadsheet software, the above sample file looks like this: | ``"shortname","username","role"`` | ``"public","petra","admin"`` | ``"public","paula","member"`` | ``"course","petra","admin"`` | ``"course","percy","tutor"`` | ``"course","paula","member"`` .. note:: If you have many groups and could easily lose the overview, create one CSV file per group.