Difference between revisions of "Main Page"
(→Developer APIs) |
|||
(67 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
[[File:NUS_Connect.png|thumb|200px|Screenshot of the NUS Connect Website, one of the heaviest users of the UnionCloud Platform.]] | [[File:NUS_Connect.png|thumb|200px|Screenshot of the NUS Connect Website, one of the heaviest users of the UnionCloud Platform.]] | ||
− | This Community Wiki, is our venture in hoping that we can provide to you the best, most up to to date, comprehensive, and yet easy to understand support possible. Though our team will be working hard to ensure we cover, and keep on top of this, providing help, support, and guidance on all areas of | + | This Community Wiki, is our venture in hoping that we can provide to you the best, most up to to date, comprehensive, and yet easy to understand support possible. Though our team will be working hard to ensure we cover, and keep on top of this, providing help, support, and guidance on all areas of UnionCloud, there are only so many hours in the day. As with all 'Wiki' based websites, we're going to be asking for a little bit of help from you guys, the community. If you're looking through here, and there is something you've noticed is missing, feel free to add it, or let us know that you'd like some help on a particular topic adding. With your help, we can make this a hugely successful support mechanism to allow you to create the best UnionCloud platforms possible for your own institutions! |
− | + | ||
− | As with all 'Wiki' based websites, we're going to be asking for a little bit of help from you guys, the community. If you're looking through here, and there is something you've noticed is missing, feel free to add it, or let us know that you'd like some help on a particular topic adding. With your help, we can make this a hugely successful support mechanism to allow you to create the best | ||
− | |||
− | |||
− | |||
− | |||
== About == | == About == | ||
First time here? All you need to do is quickly register, as soon as you have, you will be able to view more content, and even make edits!<br/> | First time here? All you need to do is quickly register, as soon as you have, you will be able to view more content, and even make edits!<br/> | ||
==FAQ's / Common Questions == | ==FAQ's / Common Questions == | ||
− | *[[User Groups & Permissions|How do I give people permissions on | + | *[[GDPR|'''Tell me about GDPR''']] |
+ | *[[User Groups & Permissions|How do I give people permissions on UnionCloud?]] | ||
*[[How to set up an election|How do I set up an election?]] | *[[How to set up an election|How do I set up an election?]] | ||
*Creating an Event | *Creating an Event | ||
Line 19: | Line 15: | ||
== What would you like help with? == | == What would you like help with? == | ||
− | These are the major areas you will come across using the ''Back End'' of | + | These are the major areas you will come across using the ''Back End'' of UnionCloud. |
− | === Admin === | + | === Admin === |
− | [[File:Admin_Menu.png|frame|200px|Admin Menu from | + | [[File:Admin_Menu.png|frame|200px|Admin Menu from UnionCloud Dashboard.]] |
− | The Admin section of the | + | The Admin section of the UnionCloud Dashboard contains all of the tools you as the Administrator are likely to need to make sure that your site functions, and functions correctly. Everything from setting up the specific ID's students are allowed to register with, Single Sign On, Nominal Codes for your finance teams, Data Uploads, and more. |
− | It is the main suite of tools you will use to manage your site, [[Setup]], is mainly used, as it would suggest, in the setup of your website, the crucial settings, and, custom email responses, often this is made up of the settings that doesn't require changing too often. The other group of tools, you will use more frequently, though which tools are available to you will depend on which | + | It is the main suite of tools you will use to manage your site, [[Setup]], is mainly used, as it would suggest, in the setup of your website, the crucial settings, and, custom email responses, often this is made up of the settings that doesn't require changing too often. The other group of tools, you will use more frequently, though which tools are available to you will depend on which UnionCloud package you are on. |
The Sections of the Admin Menu are; | The Sections of the Admin Menu are; | ||
Line 39: | Line 35: | ||
=== Website === | === Website === | ||
− | [[File:Website Menu.png|thumb|Website Menu from | + | [[File:Website Menu.png|thumb|Website Menu from UnionCloud Dashboard.]] |
MarComs is a Portmanteau of the words ''Marketing'', and ''Communications'', and that is largely what this section covers, it includes all of the areas to edit content on your site, add '[[Articles Manager|News Articles]]', send out Emails to your members ([[Campaign Manager|Campaigns]]), and managing all of your [[Images Library|Uploaded Images]] & [[Documents Manager|Documents]].<br/> | MarComs is a Portmanteau of the words ''Marketing'', and ''Communications'', and that is largely what this section covers, it includes all of the areas to edit content on your site, add '[[Articles Manager|News Articles]]', send out Emails to your members ([[Campaign Manager|Campaigns]]), and managing all of your [[Images Library|Uploaded Images]] & [[Documents Manager|Documents]].<br/> | ||
<br/> | <br/> | ||
Line 46: | Line 42: | ||
The Sections of the MARCOMS Menu are; | The Sections of the MARCOMS Menu are; | ||
*[[Web Site Manager]] | *[[Web Site Manager]] | ||
+ | *[[Developers Toolkit]] | ||
*[[Articles Manager]] | *[[Articles Manager]] | ||
*[[Documents Manager]] | *[[Documents Manager]] | ||
*[[Images Library]] | *[[Images Library]] | ||
− | *[[ | + | *[[Logo]] |
*[[301 Redirect]] | *[[301 Redirect]] | ||
=== Campaigns === | === Campaigns === | ||
− | [[File:Campaigns Menu.PNG|thumb|Campaigns Menu from | + | [[File:Campaigns Menu.PNG|thumb|Campaigns Menu from UnionCloud Dashboard.]] |
− | Previously from within the MARCOMS Section, these have been separated out now for Clarity. Campaigns is the section you visit if you wish to send out Email 'Campaigns' from within your UnionCloud site to your membership, it's broken down into | + | Previously from within the MARCOMS Section, these have been separated out now for Clarity. Campaigns is the section you visit if you wish to send out Email 'Campaigns' from within your UnionCloud site to your membership, it's broken down into two sections.<br/> |
[[Campaign Manager]] | [[Campaign Manager]] | ||
− | :*Union | + | :*Union Campaigns |
− | + | :*NUS Campaigns | |
− | |||
− | :*NUS | ||
=== Groups === | === Groups === | ||
− | [[File:Groups_Menu.png|frame|200px|Groups Menu from | + | [[File:Groups_Menu.png|frame|200px|Groups Menu from UnionCloud Dashboard.]] |
− | Groups is the catch all term we use to describe any student group we want to give some access and independence to on our Website | + | Groups is the catch all term we use to describe any student group we want to give some access and independence to on our Website. Typically, these are Sports Clubs & Societies, however, some also use it for Course reps, mailing lists, interest groups and one-off projects. |
<br/> | <br/> | ||
If the people in charge of said group have been assigned permissions, then they can also manage themselves, their own ''minisite'', their own memberships / prices, events, emails and more. | If the people in charge of said group have been assigned permissions, then they can also manage themselves, their own ''minisite'', their own memberships / prices, events, emails and more. | ||
Line 69: | Line 64: | ||
The Sections of the Groups Menu are; | The Sections of the Groups Menu are; | ||
*[[Manage Groups]] | *[[Manage Groups]] | ||
− | *[[Manage Group Promotions|Manage Promotions]] | + | *[[Manage Group Promotions|Manage Group Promotions]] |
− | *[[Manage Awards]] | + | *[[Manage Awards|Manage Group Awards]] |
=== Events === | === Events === | ||
Line 78: | Line 73: | ||
The Sections of the Events Menu are; | The Sections of the Events Menu are; | ||
*[[Manage Events]] | *[[Manage Events]] | ||
+ | *[[Manage Event Promotions|Event Promotions]] | ||
*[[Redeem Tickets]] | *[[Redeem Tickets]] | ||
− | *[[Manage | + | *[[Manage Ticket Orders|Ticket Orders]] |
− | |||
=== Eshop === | === Eshop === | ||
− | [[File:EShop Menu.png|thumb|eShop Menu from | + | [[File:EShop Menu.png|thumb|eShop Menu from UnionCloud Dashboard.]] |
− | There are currently three options available relating to eShops | + | There are currently three options available relating to eShops within UnionCloud sites; None, Managed, or Union.<br/><br/> |
'''None''' is straight forward, a non commercial union who do not wish to sell products.<br/> | '''None''' is straight forward, a non commercial union who do not wish to sell products.<br/> | ||
− | '''Managed''' is an eShop managed by the | + | '''Managed''' is an eShop managed by the UnionCloud team, and stocked by [http://www.eponashop.com/ Epona], the Fairtrade clothing supplier that is a subsidiary of NUS, as the shop. <br/> |
'''Union''' is the most common option, and refers to an eShop managed by a member of staff at your Union, and requires you to upload and maintain your stock, and stock levels, reviewing and dispatching orders.<br/><br/> | '''Union''' is the most common option, and refers to an eShop managed by a member of staff at your Union, and requires you to upload and maintain your stock, and stock levels, reviewing and dispatching orders.<br/><br/> | ||
The financial breakdown for Managed and Union is slightly different, you can get these details by contacting you Membership Engagement Executive.<br/> | The financial breakdown for Managed and Union is slightly different, you can get these details by contacting you Membership Engagement Executive.<br/> | ||
Line 100: | Line 95: | ||
=== Democracy === | === Democracy === | ||
− | [[File:Democracy Menu.png|thumb| | + | [[File:Democracy Menu.png|thumb|Democracy Menu from UnionCloud Dashboard.]] |
+ | The Democracy section of UnionCloud includes all features relating to student participation and representation within your Union. Here you can run elections which students can nominate themselves for or vote in. You can also use the Student Voice module for students to raise ideas and petitions or referendums to understand your students' opinions on particular issues. | ||
+ | |||
The Sections of the Democracy Menu are; | The Sections of the Democracy Menu are; | ||
*[[Elections]] | *[[Elections]] | ||
Line 112: | Line 109: | ||
:*[[Student Voice#Manage Ideas|Manage Ideas]] | :*[[Student Voice#Manage Ideas|Manage Ideas]] | ||
:*[[Student Voice#Manage Comments|Manage Comments]] | :*[[Student Voice#Manage Comments|Manage Comments]] | ||
+ | *[[Digital Rep]] | ||
+ | :*[[Digital Rep#Setup|Setup]] | ||
=== Volunteering === | === Volunteering === | ||
− | [[File:Volunteering Menu.png|thumb|Volunteering Menu from | + | [[File:Volunteering Menu.png|thumb|Volunteering Menu from UnionCloud Dashboard.]] |
The Sections of the Volunteering Menu are; | The Sections of the Volunteering Menu are; | ||
+ | *[[Dashboard]] | ||
*[[Volunteering Setup]] | *[[Volunteering Setup]] | ||
*[[Manage Volunteers]] | *[[Manage Volunteers]] | ||
*[[Manage organisations/projects]] | *[[Manage organisations/projects]] | ||
*[[Manage opportunities]] | *[[Manage opportunities]] | ||
− | |||
*[[Manage reports]] | *[[Manage reports]] | ||
*[[Upload organisation/project]] | *[[Upload organisation/project]] | ||
Line 126: | Line 125: | ||
=== Reports === | === Reports === | ||
− | [[File:Reports Menu.png|thumb|Reports Menu from | + | [[File:Reports Menu.png|thumb|Reports Menu from UnionCloud Dashboard.]] |
The Sections of the Reports Menu are; | The Sections of the Reports Menu are; | ||
*[[NUS Analytics]] | *[[NUS Analytics]] | ||
Line 136: | Line 135: | ||
*[[Group Committee Report]] | *[[Group Committee Report]] | ||
*[[Membership Details]] | *[[Membership Details]] | ||
+ | |||
+ | |||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
+ | <br/> | ||
== [[Version History]] == | == [[Version History]] == | ||
Line 147: | Line 158: | ||
=== Sprint Updates === | === Sprint Updates === | ||
− | * [[ | + | * [[Patch: 24th July 2018]] |
− | * [[ | + | * [[Patch: 31st July 2018]] |
− | * [[ | + | * [[Patch: 14th August 2018]] |
+ | |||
+ | == UnionCloud Newsletter == | ||
+ | We will keep an up-to-date archive of previous UnionCloud briefings and newsletters if you wish to go back and review them for any reason. | ||
− | + | Below you can see the three most recent newsletters, but if you want to see them all you can visit our [[UC Briefing Archive]]. | |
− | + | * [https://mailchi.mp/d24bd06871d0/december18-catch-up-1751753 December 2018] | |
− | *[[ | + | * [https://mailchi.mp/0162e53b0cc7/november18-catch-up-1751713 November 2018] |
− | *[ | + | * [https://mailchi.mp/8b9f6e57044b/october18-catch-up-1751685?e October 2018] |
− | *[ | + | * [http://r.eb.totum.com/mk/mr/owTlKE9Dl1LP_-PdBf30LsmjiHfFGmBLQd7G4CksGhMgz5yvt2Yim2eLfeBpmYK-9-lDmsBieoE51wW0CoM5CfLYLEUuDQQ0JhZ1CkLZ August 2019] |
+ | * [http://r.eb.totum.com/mk/mr/yH0Z-B9nzqEhwbCZ3HJx2eBaZHKcUCvQUi7k8pGZ0uiM-buCbv4aepzADJeyx0B96uLBev0OOMJw9-eUyhK_O36i3Q7HnU_8xApRchavcg September 2019] | ||
== Misc Info == | == Misc Info == | ||
− | Here we'll list links or info about any documentation that isn't necessarily directly | + | Here we'll list links or info about any documentation that isn't necessarily directly UnionCloud, but may still relate to your usage of the platform. |
[[UnionCloud Sub-Domain List]] | [[UnionCloud Sub-Domain List]] | ||
Line 175: | Line 190: | ||
*[[Auto select single group membership type]] | *[[Auto select single group membership type]] | ||
*[[Rename tab in Elections Stats Dashboard]] | *[[Rename tab in Elections Stats Dashboard]] | ||
+ | *[[Hide Group email preferences from user]] | ||
+ | |||
+ | ===Experimental=== | ||
+ | *[[Userscript experimental local features]] | ||
===Developer APIs=== | ===Developer APIs=== | ||
Line 180: | Line 199: | ||
*[[API PHP Wrapper]] | *[[API PHP Wrapper]] | ||
*[https://nationalunionofstudents.webex.com/nationalunionofstudents/lsr.php?RCID=04ef572078655728e31404b1643a2ed7 API Webinar] | *[https://nationalunionofstudents.webex.com/nationalunionofstudents/lsr.php?RCID=04ef572078655728e31404b1643a2ed7 API Webinar] | ||
+ | |||
+ | ===Common Error workarounds=== | ||
+ | *[[Auto-stripe jQuery debug]] | ||
+ | *[[Old images loading Cache issue]] |
Latest revision as of 11:24, 21 February 2020
This Community Wiki, is our venture in hoping that we can provide to you the best, most up to to date, comprehensive, and yet easy to understand support possible. Though our team will be working hard to ensure we cover, and keep on top of this, providing help, support, and guidance on all areas of UnionCloud, there are only so many hours in the day. As with all 'Wiki' based websites, we're going to be asking for a little bit of help from you guys, the community. If you're looking through here, and there is something you've noticed is missing, feel free to add it, or let us know that you'd like some help on a particular topic adding. With your help, we can make this a hugely successful support mechanism to allow you to create the best UnionCloud platforms possible for your own institutions!
Contents
About
First time here? All you need to do is quickly register, as soon as you have, you will be able to view more content, and even make edits!
FAQ's / Common Questions
- Tell me about GDPR
- How do I give people permissions on UnionCloud?
- How do I set up an election?
- Creating an Event
- Uploading a News Story
- What other support can I get for UnionCloud?
What would you like help with?
These are the major areas you will come across using the Back End of UnionCloud.
Admin
The Admin section of the UnionCloud Dashboard contains all of the tools you as the Administrator are likely to need to make sure that your site functions, and functions correctly. Everything from setting up the specific ID's students are allowed to register with, Single Sign On, Nominal Codes for your finance teams, Data Uploads, and more.
It is the main suite of tools you will use to manage your site, Setup, is mainly used, as it would suggest, in the setup of your website, the crucial settings, and, custom email responses, often this is made up of the settings that doesn't require changing too often. The other group of tools, you will use more frequently, though which tools are available to you will depend on which UnionCloud package you are on.
The Sections of the Admin Menu are;
- Setup
- User Groups
- Remote Sales
- User Account Details
- Manage Refunds
- Manage Course Rep
- Upload Files
- Android App
Website
MarComs is a Portmanteau of the words Marketing, and Communications, and that is largely what this section covers, it includes all of the areas to edit content on your site, add 'News Articles', send out Emails to your members (Campaigns), and managing all of your Uploaded Images & Documents.
Some areas, like Developers Toolkit, are slightly more advanced still and allow users with the know how to alter the structure of their site, the navigation, the order / location of pages and more, it also gives the ability to add widgets, sub-sites, and with one of the extra packages, customise the CSS and Javascript within the site, allowing a greater level of bespoking.
The Sections of the MARCOMS Menu are;
- Web Site Manager
- Developers Toolkit
- Articles Manager
- Documents Manager
- Images Library
- Logo
- 301 Redirect
Campaigns
Previously from within the MARCOMS Section, these have been separated out now for Clarity. Campaigns is the section you visit if you wish to send out Email 'Campaigns' from within your UnionCloud site to your membership, it's broken down into two sections.
Campaign Manager
- Union Campaigns
- NUS Campaigns
Groups
Groups is the catch all term we use to describe any student group we want to give some access and independence to on our Website. Typically, these are Sports Clubs & Societies, however, some also use it for Course reps, mailing lists, interest groups and one-off projects.
If the people in charge of said group have been assigned permissions, then they can also manage themselves, their own minisite, their own memberships / prices, events, emails and more.
The Sections of the Groups Menu are;
Events
The events section is a useful tool used for eTicketing, Door Entry (Scanning / Redeeming tickets at an event), Obtaining information in advance from all of your guests, notifying them of updates, and giving the abilty to promote events, to boost attention or sales.
The Sections of the Events Menu are;
Eshop
There are currently three options available relating to eShops within UnionCloud sites; None, Managed, or Union.
None is straight forward, a non commercial union who do not wish to sell products.
Managed is an eShop managed by the UnionCloud team, and stocked by Epona, the Fairtrade clothing supplier that is a subsidiary of NUS, as the shop.
Union is the most common option, and refers to an eShop managed by a member of staff at your Union, and requires you to upload and maintain your stock, and stock levels, reviewing and dispatching orders.
The financial breakdown for Managed and Union is slightly different, you can get these details by contacting you Membership Engagement Executive.
The Sections of the Eshop Menu are;
- Products
- Categories
- Orders
- Colours
- Product Promotions
- Category Discount
- Shipping Charges Upload
- Stock Report
Democracy
The Democracy section of UnionCloud includes all features relating to student participation and representation within your Union. Here you can run elections which students can nominate themselves for or vote in. You can also use the Student Voice module for students to raise ideas and petitions or referendums to understand your students' opinions on particular issues.
The Sections of the Democracy Menu are;
Volunteering
The Sections of the Volunteering Menu are;
- Dashboard
- Volunteering Setup
- Manage Volunteers
- Manage organisations/projects
- Manage opportunities
- Manage reports
- Upload organisation/project
- Volunteer awards
Reports
The Sections of the Reports Menu are;
Version History
Links to Version Updates / Release Notes, this stub stores the most recent 3 sprints, and the most recent three major releases, however if you are looking for full details you can find all release / sprint data on the Version History page.
Major Updates
- Release 25 - 25th June 2016
- Release 26 - 26th November 2016
- Release 27 - 6th May 2017
Sprint Updates
UnionCloud Newsletter
We will keep an up-to-date archive of previous UnionCloud briefings and newsletters if you wish to go back and review them for any reason.
Below you can see the three most recent newsletters, but if you want to see them all you can visit our UC Briefing Archive.
Misc Info
Here we'll list links or info about any documentation that isn't necessarily directly UnionCloud, but may still relate to your usage of the platform.
Finance
Code Snippets
- Modify Site Background Image or Colour
- Change Officer Stripe Speed
- Hide Events on index
- Show Count on All Usergroups
- Simple image slideshow
- Auto load content on scroll
- Rename Student Voice Module
- Auto select single group membership type
- Rename tab in Elections Stats Dashboard
- Hide Group email preferences from user