Skip to content

User Documentation

Emma Eagles edited this page Apr 8, 2019 · 15 revisions

The Cooperator system can be accessed here.

Features:

  1. Create Admin Account
  2. Log In
  3. Log Out
  4. View Student Information
  5. View Employer Information
  6. View Co-op Term Information
  7. View Report
  8. Edit Report
  9. Send Notification
  10. Generate Statistics
  11. Toggle Light/Dark Mode

Create Admin Account

On this page, the user can enter their name, email, phone number and create a password. This will create a new administrator account that will allow them to enter the system.

Log In

If the user has an account, they can enter their email and password to be let into the system. If the email does not correspond to an administrator in the system, the page will tell the user the account does not exist. If they enter an incorrect password, the page will also inform them.

Log Out

The user can log out from their account by clicking the 'Log Out' button that appears in the top right corner of every page other than the login and create account pages.

View Student Information

Once the user has logged in, they will be brought to the homepage where they will see a list of students and employers. To view a student, they can simply click on the student's name. The user can also navigate to a student's page from the coop page, and the report page by clicking wherever they see the name of the student.

View Employer Information

Once the user has logged in, they will be brought to the homepage where they will see a list of students and employers. To view an employer, they can simply click on the employer's name. The user can also navigate to an employer's page from the coop page by clicking on the name of the employer.

View Co-op Term Information

If a student or employer has associated coop terms, they will be visible in a list on their profile page. To view all the information associated with the coop, click on one of the terms in the list. The user can also navigate to the coop page by clicking on the title of the coop on the report page.

View Report

To view a report, the user must navigate to a coop page through a student or employer as described above. On a coop page, all reports associated to the coop will be displayed in a list. In the list, there is also a view/edit button that will redirect the user to a page dedicated to the specific report.

Edit Report

To edit a report, the user must navigate to a coop page through a student or employer as described above. On a coop page, all reports associated with the coop will be displayed in a list. In the list, there is also a view/edit button that will redirect the user to a page dedicated to the specific report. From there, the user can change the status and type of the report, choosing a new option from the dropdown selection boxes and clicking the 'Set' button. The user can also change the due date of a report by entering a new date and clicking 'Set'. If the report is a contract, the user can change the information of the coop by entering new information in the fields on the page. They can change the title of the job, the start/end dates, the hourly pay, weekly hours and the address. To save these changes to the contract, the user must press the "Save Changes" button at the bottom of the page. To view the changes, the user must refresh the page.

Send Notification

There are two ways that a user can create a notification. The first method requires that the user be on the home page and select students or employers from the list by clicking their associated checkbox. From there, the user can click the 'Create Notification' button where they are redirected to a page where they can type the message they would like to send. To send it, the user must click the 'Send' button at the bottom of the page.

The second method requires that they are on a student or employer's profile page. From there, they can click the 'Send Notification' button that will redirect them to a page where they can write the notification's message, then click the 'Send' button to send it.

Generate Statistics

To generate statistics, the user must be on the home page of the Cooperator system. By clicking the 'Generate Statistics' button at the bottom of the page below the list of Students and Employers, they will be redirected to the statistics page where they can specify the range of terms they would like to generate statistics for, and if they would like to see only statistics for coops that are a student's first, second, third, etc. As the fields are selected, the charts update automatically.

Toggle Light/Dark Mode

Throughout the entire Cooperator System, the user can click the moon or sun emoji button in the top right corner in order to change from light mode to dark mode or vice versa.