View source for User Groups & Permissions

[[File:User groups and permissions.PNG|thumb|Sample view of User Groups & Permissions page]]
The User Groups and permissions screen, is one of the most commonly used screens for Union Administrators. It contains all of the default permission groups created by Union Cloud on your behalf, the groups students are placed into by default. It also stores the sub sections for viewing group (Club & Society) membership groups (Administrators, Current, Alumni etc.), Events group lists, halls group lists, programme names, and their membership counts, demographic groups, and importantly '''Custom groups'''. <br/>

One of the reasons for it's heavy use is, that it is the easiest way to control which users have access to what, once you have your [[Permission Set|Permission Sets]] sorted and applied to a user group, as we explain further down, all you need to do is add a user to that group.

[[Events]]

==Union==
{{url|/administrator/user_groups}}
The '''Union''' Sub Menu,
hese groups here are some of the most important, and also the groups that users will be placed into automatically upon registration / upload / expiry.
===Default User Groups Breakdown===
{| class="wikitable" style="margin: auto;"
|+ style="caption-side:bottom; color:black;"|''Those highlighted in blue will only appear if you have University Email selected, or the Volunteering Module included in your package''
|-
! scope="col"| Name 
! scope="col"| Description
|-
! scope="col" style="text-align:Left;"| Activated Students
| This group is empty by default, and you can't upload users to it, Confirmed Students, move to this group, after logging in for the first time.
|-
! scope="col" style="text-align:Left;"|  Administrator
| This is the Default Union Administrator group, who have permissions to manage all website content.
|-
! scope="col" style="text-align:Left;"| Alumni
| This group is empty by default, but once a users course date expires, they move '''out''' of Confirmed Students, and into Alumni.
|-
! scope="col" style="text-align:Left;"| Confirmed Students
| This group is populated by data upload, and is the group of students that you are confirming you ''know'' are students, this can then be used for elections etc.
|-
! scope="col" style="text-align:Left;"| Deleted Students
| This group is for users that have requested to be removed from the system, it excludes them from all comms, records, reports etc. They remain in this group as  <br/>there is still content linked totheir accounts from previous purchases and the like, in case this ever needs reporting on. 
|-
! scope="col" style="text-align:Left;"| Non Students
| This group is populated by anybody that registers with a non-university email address and can't confirm they are a student.
|-
! scope="col" style="text-align:Left;"| Staff
| This is a list to help you differentiate Staff from General users, you can manually upload to this group via CSV, for example to give staff access to more content <br/>than regular site users, i.e. if you have staff sections / documents / hr etc.
|-
! scope="col" style="text-align:Left; background-color: #0BAEC7;"| Students Waiting for<br/> University Email Access
| If you have checked the box indicating registration has to be done via university email address, and a user indicates they don't have access to it pre-arrival, they <br/>will be added to this list, allowing them to register with a personal email address also, and merge their accounts once they have access.
|-
! scope="col" style="text-align:Left; background-color: #0BAEC7;"| Volunteering Organisations
| If you have the [[Volunteering Module]] included in your package, you will have this option, when new Volunteering Organisations register, to list opportunities, they<br/> a Volunteering Administrator will need to approve them in the Volunteering Dashboard, then they will be added to this group, and be given permissions to manage Volunteering Opportunities.
|-
! scope="col" style="text-align:Left; background-color: #0BAEC7;"| Volunteering Students
| Any student who has signed up to the Volunteering module will be added to this group, as it is confirming the group of students who have registered their interest to <br/>volunteer, and listed the areas they are interested in / skills they have.
|-
|}
<br/>
===Other Features within Union subsection===
[[File:User Group Overview.PNG|center|frame|A simple overview of the first two rows of the table in the Union sub-section, of the ''User Groups & Permissions'' Menu.]]
====Show Count====
Previously you may remember this used to show the number of members in each screen by default, this meant that it performed a count function for a large number of groups in some cases, every time a page like this loaded, which caused larger burdens on the server, so to improve page load times this feature was removed and replaced with the line of text in blue, which on click performs a count for the group in question.
====View User Group====
[[File:View User Group.PNG|thumb|View User Group Screen]]
This screen gives you an overview of an individual User Group, at the top you can see the title of the group you are in, highlighted with a blue font.
*'''Adding New Users'''
::#Manually
:::You can add users manually using the three boxes under the group title, the method is as follows;
::::*From the drop down list, choose a group you know the user is already a member of
::::*Search for the user by their name, it will return to you close matches, and Dates of Birth to allow you to check you have the right person
::::*Choose a membership expiry date for the user, this should be a year or so, and checked regularly to ensure there are no dormant accounts with permissions they shouldn't have.
::::*Select the 'Add members' button to finish the process.
::#CSV Upload
This is the same as in the [[#User Group Member Upload]] section below, there are just two places you can select this option.
*'''Filter / Sort Users'''
[[File:Filter-Sort.PNG|thumb|Image showing how the Filter / Sort menu bar looks after choosing the filter option]]
The header row of the table, with the darker grey background is of much use, particularly when you are dealing with groups containing thousands, or even tens of thousands of users. You can both filter and sort any users in this table, and it also allows you to filter by multiple fields, and use part matches.
You can click any of the Column headings to sort (ID, University ID, Forename, Surname, DOB, Email Membership Expiry Date), primarily it will sort (A-Z) in field which can contain strings, and (0-9) in a field that contains numeric values, however if you click the heading a second time, it will filter this to the reverse.

With regards to filtering, this works almost the same, to make the filter section appear, all you need to do is click the small cocktail glass looking symbol in the far right hand column, and it will reveal the menu as pictured to the right hand side.
You can filter by any of the same fields as outlined above, with the exception of Membership Expiry Date, and the only filter that works differently is Date of Birth, this filter gives you two calendar options, Start and End, which will return all user whose DoB falls within the range.

Finally, there are two buttons below the filter button, one to reset your filters, and another to apply the filters you have just typed in the fields, alternatively you can press return on the keyboard to update.
{{note| Remember, you can use multiple filters AND sort in conjunction with each other, particularly useful if you are looking for someone with a common name!|reminder}}
[[File:Edit Expiry 2.PNG|thumb|Edit user expiry date from a group]]

*'''Edit a Users Expiry Date'''
Editing a users Expiry date is a fairly straight forward function, it just requires the user to click the Edit button({{edit}}), in the far right hand column, this will take you to the screen pictured in the thumbnail to the right where you can use the calendar to pick a new expiry date for the user, and then simply click the 'Edit Expiry Date' button, and you're done!
::''Feedback'': Currently we have on the feedback log, a request for users to be able to instantly remove users from particular user groups, as the current method is to set their expiry to the next working day.
<br/>
<br/>
<br/>
<br/>
*'''Edit'''
The Edit button{{edit}} at the bottom of this page takes you to the same page as the edit button before you click into a specific user group, and we will cover that below or you can click [[#Edit User Group|here]] to skip to it.

For any particular group, a screenshot is provided on the right for your convenience.
<br/>
*'''Download Demographics'''
After clicking the Download Demographics button, a timing icon will appear in the '''Downloads''' section at the bottom of the page, this usually takes a few seconds, but under peak times and heavy usage could take up to a minute or so, for the site to gather the data, and present you with a PDF to download, this is a short 2 page document containing the Demographic data for all members within the group you are currently managing.
We will cover the content of the [[Demographics Report]] in another section.

*'''Download CSV'''
The final option within the View Usergroup screen is to Download a CSV of the group members, this downloads data on all of the users in the current group you are managing, in CSV Format, the data also matches the format used in the Student Upload file, so you will be getting Nationality, CourseID, StudentID, etc.
[[File:Edit User Group.PNG|thumb|Screenshot of the Edit User Group Screen]]
====Edit User Group====
The Edit page is where it gives you the options to;
# Rename
# Update Description For
# Change [[Permission Set]]

====[[CSV Upload|User Group Member Upload]]====
[[File:UserGroup CSVUpload.PNG|thumb|User Group Member Upload Pop-Up]]
''Before we begin talking through this section, if you click on the title to this section 'User Group Member Upload' it will take you to a page were we talk through CSV Uploads in slightly more detail.''
It doesn't matter which method you use to select the User Group Member Upload Option, the small CSV Upload button({{CSV}}) on the right hand side of the 'User Groups & Permissions' screen, or the View User Group Option, which you get to by selecting the View button({{view}}) on the right hand side next to any of the user groups, to get the more detailed view for a particular user group, and a list of it's current members, then there is a large, 'Upload Members' Button on the right hand side.

Once the pop up appears you are presented with a number of options.
*''Choose File'' button, to upload a CSV
*A Checkbox to add users for e-voting
*An icon to the right to 'Download Sample CSV Template'
*And two notifications, which we will clarify here;
:*'Email and Expiry Date can't be blank' (For e-voting users forename and surname are also mandatory)
:::''Email'' and ''Date of Birth'' are the required fields that Union Cloud uses to find a user in the database and add them to the correct user group
:*'File processing is a scheduled background activity.
:::All files you upload will be processed at midnight local time, this is because processing large quantities of database puts an increased load on the server and to do it at peak time would cause an increase in page load times, and a poorer experience for all members. Please bear this in mind when you need to upload Member files.

==Groups==
[[File:View Groups.PNG|thumb|This screen, is the overview screen for all of your 'Group' User Groups]]
{{url|/administrator/user_groups/groups}}
The '''Union''' Sub Menu,
These groups here are some of the most important, and also the groups that users will be placed into automatically upon sign-up / upload / expiry.
===Default Group User Groups Breakdown===
As mentioned in the caption, this screen is the overview screen for all of the 'Group' User Groups. That is to say, it will show all of the different User Groups, from all of your Clubs, Societies, Sports, Charity groups etc.
Every new student group when they are created, via the [[Groups Module]], have three User Groups created for them by default;
*Administrators
*Current Members
*Alumni
Though, Administrators, and group Union staff are able to add more.
The reason that three group

{| class="wikitable"
|-
! Group Name !! Description
|-
| Administrator || If Assigned a Group Manager, permission set, when added to this group, students can manager their own clubs & societies!
|-
| Current Members || All users that purchase membership to a group, are by default added to this group for the duration membership was set for.
|-
| Alumni || Once your purchased membership to a group expires, you are added to a groups Alumni group, meaning groups can contact you to <br/>remind you renew your membership, or send out newsletters to former members and such.
|}
===Other Features Withing Groups Subsection===
====Show Count====
Previously you may remember this used to show the number of members in each screen by default, this meant that it performed a count function for a large number of groups in some cases, every time a page like this loaded, which caused larger burdens on the server, so to improve page load times this feature was removed and replaced with the line of text in blue, which on click performs a count for the group in question.
====View User Group====
[[File:Group - User Group View.PNG|thumb|View a specific Group, User Group Screen]]
This screen gives you an overview of an individual User Group, at the top you can see the title of the group you are in, highlighted with a blue font.
You May notice on the screenshot, that this user group doesn't include the Upload / Manually add students options that were present on the 'Union' User Groups screen, that is because it is the 'Current Members' group for a club or a society. All 'Current Members' have to be added to the group, my joining / purchasing membership.

*'''Filter / Sort Users'''
[[File:Filter-Sort.PNG|thumb|Image showing how the Filter / Sort menu bar looks after choosing the filter option]]
The header row of the table, with the darker grey background is of much use, particularly when you are dealing with groups containing thousands, or even tens of thousands of users. You can both filter and sort any users in this table, and it also allows you to filter by multiple fields, and use part matches.
You can click any of the Column headings to sort (ID, University ID, Forename, Surname, DOB, Email Membership Expiry Date), primarily it will sort (A-Z) in field which can contain strings, and (0-9) in a field that contains numeric values, however if you click the heading a second time, it will filter this to the reverse.

With regards to filtering, this works almost the same, to make the filter section appear, all you need to do is click the small cocktail glass looking symbol in the far right hand column, and it will reveal the menu as pictured to the right hand side.
You can filter by any of the same fields as outlined above, with the exception of Membership Expiry Date, and the only filter that works differently is Date of Birth, this filter gives you two calendar options, Start and End, which will return all user whose DoB falls within the range.

Finally, there are two buttons below the filter button, one to reset your filters, and another to apply the filters you have just typed in the fields, alternatively you can press return on the keyboard to update.
{{note| Remember, you can use multiple filters AND sort in conjunction with each other, particularly useful if you are looking for someone with a common name!|reminder}}
[[File:Edit Expiry 2.PNG|thumb|Edit user expiry date from a group]]

*'''Edit a Users Expiry Date'''
Editing a users Expiry date is a fairly straight forward function, it just requires the user to click the Edit button({{edit}}), in the far right hand column, this will take you to the screen pictured in the thumbnail to the right where you can use the calendar to pick a new expiry date for the user, and then simply click the 'Edit Expiry Date' button, and you're done!
::''Feedback'': Currently we have on the feedback log, a request for users to be able to instantly remove users from particular user groups, as the current method is to set their expiry to the next working day.
<br/>
<br/>
<br/>
<br/>
*'''Edit'''
The Edit button{{edit}} at the bottom of this page takes you to the same page as the edit button before you click into a specific user group, to skip to it.


*'''Download Demographics'''
After clicking the Download Demographics button, a timing icon will appear in the '''Downloads''' section at the bottom of the page, this usually takes a few seconds, but under peak times and heavy usage could take up to a minute or so, for the site to gather the data, and present you with a PDF to download, this is a short 2 page document containing the Demographic data for all members within the group you are currently managing.
We will cover the content of the [[Demographics Report]] in another section.

====Edit Group User Group====
The Edit page is where it gives you the options to;
# Rename
# Update Description For
# Change [[Permission Set]]

==Events==
[[File:Events UserGroups.PNG|thumb|Events User Groups Screen]]
{{url|/administrator/user_groups/events}}

==Halls==
[[File:Halls_UserGroups.PNG|thumb|Halls of Residence User Groups Screen]]
{{url|/administrator/user_groups/hall_of_residences}}

==Programme==
[[File:Programme_UserGroups.PNG|thumb|Programme User Groups Screen]]
{{url|/administrator/programs}}

==Demographics==
[[File:Demographics_UserGroups.PNG|thumb|Demographics User Groups Screen]]
{{url|/administrator/user_groups/questions}}

==Custom==
[[File:Custom_UserGroups.PNG|thumb|Custom User Groups Screen]]
{{url|/administrator/user_groups/custom_tree}}


==Dynamic==
[[File:|thumb|Description]]
{{url|/administrator/user_groups/dynamic_tree}}