Tutorial
NOTICE: This tutorial is a work in progress so some headers will not have content under them and some aspects of the site will not be covered at all. We are working hard to make sure this tutorial is all inclusive and laid out in a favorable manner.
If you open the site and are not logged in, the only pages you will have access to are the login page and the signup page. If you start at the login page, you can login if you have an account or create a new one by clicking the button labeled "Sign Up". If you have an account and can login, skip to the next section.
Once you signup, you will be asked to confirm your email address by clicking a link in a confirmation email sent to you by the email "[email protected]". Once you have confirmed your account you are ready to login.
The bar at the top has five of the most important links as well as a logout button for logged in users.
Any website using Sapphire has support for multiple organizations, or Groups. Groups are separate and data from one cannot be accessed by the other. Groups can have members, organizers, events and slots. Groups are the most basic level of organization on Sapphire. They provide security, multiple levels of permission and organization of events and slots
This is the page you will be sent to when you log in. It has a basic layout that you will see repeated throughout the Slots and Groups pages.
The "breadcrumb" helps you know where you are in navigation. It will display a link to the group that the current event was made under. On other pages this breadcrumb might show different content.
Shows the information about the event: Title, start and end time, location and description. Clicking the location of the event will open a panel with the location shown in google maps.
Organizers will see the four buttons shown in the image. From left to right these buttons are edit, send email notification, open console and delete. The edit button will open a new page which looks similar to the create event page but has the information of the current event already filled in. Here you can make changes to all of the parts of the event. Title, description, location etc. Next is the green Send email notification button. This button also opens a new page where you can select volunteers and organizers to send an email to. When you hit send, a premade email is sent by the website to the selected recipients with all the necessary information about the event. This is similar to the Send email notification function for slots. Next, the blue console button. This also opens a new page which is describe more here. Finally the red delete button. Clicking it will open a confirmation dialog box. Once an event is deleted it is gone. It is not archived on the website or disabled. It is removed completely.
Volunteers will not see these buttons. Their page is similar otherwise. The only differences are the places where buttons have been removed since they lead to content only organizers can see.
This table lists all the slots that have been added by organizers. It gives a link to the slot and some basic information about it.
Organizers can also see a list of all the people currently volunteered on each slot. In addition they have a blue plus button to the right of the table title that adds new slots and a red delete button next to each slot on the table. These delete buttons also have a confirmation dialog.
Collecting data from an event has never been easier. This button converts all the data about the event into a spreadsheet file. The file format is .csv which can be imported by almost all spreadsheet applications including Excel and Google Sheets.
This is an organizer only tool so volunteers will not see this button or have access to the link it goes to.
The feed page shows all public recent actions as well as all of your actions, public or not. It is a good tool for accountability and as a history so you can return to something you were working on previously. Off to the right is a blue filter button which allows filtration based on which organization the action is associated with. Organizers can see the entire feed for their organization as can owners.
This page is very similar to the events page.
The blue plus button at the top allows you to create slots. You will need to be an organizer of at least one group in order to make new slots. Below that, there is a search bar which will search through all the slots you have access to. Off to the right is a blue filter button which allows filtration based on date range. Next is a table of all the slots. If you enter a search term or a date range, these results will be constrained by that. The text in blue links you to the respective slot or group.
The "breadcrumb" helps you know where you are in navigation. It will display links to the group and event that the current slot was made under. On other pages this breadcrumb might show different content.
Shows the information about the slot: Title, start and end time, location (bolded) and description, which is below the progress bar.
The progress bar shows how full a slot is. In the picture only 2 waiters are needed so the bar shows 100% full.
Organizers will see the four buttons shown in the image. From left to right these buttons are volunteer/unvolunteer, send email notification, edit and delete. The volunteer button toggles between volunteering and unvolunteering. It functions the same for organizers and volunteers. Next is the green send email notification button. This button also opens a new page where you can select volunteers and organizers to send an email to. When you hit send, a premade email is sent by the website to the selected recipients with all the necessary information about the event. This is similar to the send email notification function for events. To the right is the blue edit button. The edit button will open a new page which looks similar to the create slot page but has the information of the current slot already filled in. Here you can make changes to all of the parts of the slot. Title, description, location etc. Finally the red delete button. Clicking it will open a confirmation dialog box. Once a slot is deleted it is gone. It is not archived on the website or disabled. It is removed completely.
Volunteers will not see these buttons. They will only see a single button that either says "Volunteer" or "Unvolunteer" depending on whether they have signed up yet or not.
Organizers can see all the information, including any information marked as private. The blue plus button to the right of the table title adds a new opening for volunteers to fill. A second blue plus button is displayed in the header labeled "User". We call this system voluntold. This button manually adds a user to the list of volunteers and send them an email. This means they will not have to signup themselves. In the email they can choose to either accept or reject the assignment. If they reject it they will be removed from the list. If they accept they will be treated like any other volunteer by Sapphire. The next two columns, sign in and sign out, contain buttons that will record the current date and time and store it when clicked. The elapsed time between these two timestamps is shown in the column labeled "Time" to their right. Next, any custom columns will be shown. Finally a delete button which can be used to remove volunteers from the slot. It has no confirmation dialog
This section looks very different for volunteers. It will only display their information. Name, sign in time, sign out time and elapsed time.
Collecting data from a slot has never been easier. This button converts all the data about the slot into a spreadsheet file. The file format is .csv which can be imported by almost all spreadsheet applications including Excel and Google Sheets.
This is an organizer only tool so volunteers will not see this button or have access to the link it goes to.
This page is very similar to the events page.
The blue plus button at the top allows you to create a group. Below that, there is a search bar which will search through all the groups on the site. Next is a table of all the groups. If you enter a search term, these results will be constrained by that. The text in blue links you to the respective group.
