Online PASS User Manual.

This is an in-depth guide that explains the ins and outs of Online PASS. Here, you'll find detailed explanations of every feature, how they function, and some helpful tips. If you encounter something mentioned here that isn't visible in the app, it likely means that feature isn't accessible to you.

Getting Started

Online PASS is a progressive web app, meaning you can either use it as a plain website, or download the app for it. Note: downloading the PWA will not install separate app, but rather provision a isolated window of your default browser.The website has been tested and is ready for the following browsers:

The PWA however, is only downloadable through Chrome, Edge and Brave. This is because Opera and Firefox do not support progressive web apps. Note: the website version works fine, but if you want the best experience possible, it is recommended that you Download the PWA from Edge on either a laptop or desktop.

Onboarding

After signing in using your USP Student Email for the first time, you will be taken to the Onboarding page. Filling the onboarding form with your information is required in order to continue and use the web app. This is a one time process and all roles a required to do so. This page will not be accessible after you have boarded OPASS.

Users

Account details such as name, profile image and bio can be edited in the Settings page. Unlike leaders or students, admins can also change you student Id as long as it is unique. Despite not being students, admins have a student Id field, simply to keep the schema and code simple. By default, it is set to their First name . Surname.

Courses

Courses refer to the groups within the web app. They hold members and everything a member creates. Deleting a course will result in the deletion of its members, chat history, polls, resource repository, session schedule and attendance history. If you are an admin, you can:

• Attend a course - This is done by clicking the Arrow pointing to the top right. You will be redirected to the Course chat page. Note: you need to be a member to attend.

• Create a course - This is done through clicking the Create button with a Plus inside a Circle icon on the controls panel of the Courses page. Only admins have access to this page.

• Update a course - This is done through clicking the Expand button on a course (this looks like a broken square) and then click the Update button on the Course settings page.

• Delete a course - same as updating but you click teh Delete button on the Course settings page. Note: deleting a course requires a password which only the course leader has access to.

Admins have the highest role in OPASS but when in a Course, the leader for that course has the most authority and most features available. Admins then hold the role of a student.

Members

Members are created when a User gets added to a Course. There are 2 types of members, students and leaders. If you are an admin or leader, and are in the Course settings page, you can:

• Add members - This is done by clicking the Add button with a Person and Plus icon on the controls panel. If you know the student Id of the student you wish to add, you can either enter their Id or you can enter a list of student Ids separated by either a space or comma. If you aren't aware of the Ids, you can copy the invite link and share it with the students you want to add.

• Remove members - This is done by clicking the Remove button with a Person and Minus icon on the controls panel. This is disabled by default and will remain as is until one or more members are selected. This can be done by checking the check box on the very left of the table for the respective member(s) you wish to remove. Note: removing the leader is a very bad idea as majority of the courses entities will have a relation to the leader.

• Update member roles - This is done by simply toggling the switch at the end of the table for the respective member that needs to be updated. This feature is only available to admins.

If you are a leader or student, you can request admins to either directly add you to a course or visit the respective Moodle course shell to obtain the Invite Link.

Messages

All roles have the ability to send messages so long as they are a member of the course they are sending the message in. Messaging supports both real time broadcasting and optimistic updates. Once you are added to a course and are on the course chat page, you can:

• Send a message - This is done by entering a message on the input at the bottom and hitting Enter. This will optimistically update the message on your screen. If there was an error, there will be a small red circle on the bottom right of your message. If it was successfully sent, the circle will be gray, and if someone in the course has seen your message, it will turn teal.

• Edit a message - This is done by first hovering over the message you want to edit and then clicking the Pen icon. The input field at the bottom will be filled with the message you chose. Once you are done making changes, hit Enter to confirm.

• Delete a message - This is done similar to editing but you click the Red Trash icon instead. There will be a confirmation message on the bottom right, beside the input at the bottom. Click the Tick to confirm or the Cross to cancel.

• Reply to other messages - This is done by first hovering over the message you want to edit and then clicking the Arrow icon which bends from top to the left. Continue to type out your reply and send it as if were a normal message.

Calls

This feature is yet to be properly implemented. Expect the ability to join audio / video calls, share your screen and save call recordings to the Resources page. As a temporary workaround, leaders will be able to attach Zoom / Google Meet links when creating online sessions.

Polls

All roles have the ability interact will polls so long as they are a member of the course they are interacting with the poll in. Polls also support both real time broadcasting and optimistic updates. Once you are added to a course and are on the course chat page, you can:

• Create a poll - This is done by clicking the Chart icon at the end of the message input. This will open a modal where you are required to add a questions and at least 2 options. You can add more options by clicking the text that reads Add Option under the last option. Any options added after the required 2 can be removed by clicking button which consist of a Minus inside a Circle.

• Delete a poll -this is done by clicking the Red Trash icon after hovering over the poll you wish to delete. A confirmation modal will open up where you can either Confirm or Cancel. This modal will also list the options and vote count for each.

• Cast your vote on a poll - This is done by simply clicking on the option you wish to vote for. You can only chose one option per poll and are allowed to change your choice as you please.

Resources

Each course has its own Resource Repository. This can be access by navigating to a course and then clicking the Resources button with a folder icon on the top navigation bar. Once there, you can:

• Submit a file - This is done by clicking the Submit button with a Arrow pointing up icon. You will be required to upload a file and give it a title on the modal that opens up. Note: this submission will be available to all members of the course you are submitting to. Member submissions will be denoted by a Person icon.

• Update your submission - This is done by clicking the Update button with a Pen icon. Note: this is button is disabled until at least 1 submission is selected. Selecting a resource can be done by first Hovering over the submission you wish to update, and then Selecting the check box on the top left of your submission. A modal will open, which is where you fill in the new information.

• Delete your submission - This is done in the same way as updating, but instead of the Update button, you click the Delete button with a trash icon. A confirmation modal will open, where you can either chose to proceed or cancel. The delete button is also disable until one or more submissions are selected.

• Download resources - This is done by clicking the Download button which consists of a Arrow pointing down icon. This button is only found on the bottom right of the downloadable resources. Note: you will not be asked to chose a download destination, the resource will be downloaded to your Downloads folder.

• Visit external links - This is done by clicking the View button which consists of an Arrow pointing to the top right icon. This will open the linked resource in a new tab. Recognized links will have a relevant icon to help easily identity the source, for instance: a link to a Chat GPT conversation will have a Robot icon.

• View session recording - This is done by clicking the Play button which consists of a triangle icon. This button is only found on the bottom right of the recordings resources. Pressing it will redirect you to a video Playback Page where you can view the recording.

Leaders have the added ability to add and manage Resources, which is the same as submissions but has a different name to keep roles in place. Leaders can also add and manage External Links in the same way they would with resources.

OPASS currently supports the most commonly used file formats. This consists of: text based files (.pdf, .txt, .doc, .docx), code based files (.html, .css, .js, .cpp, .java, .py ), spreadsheets (.xls, .xlsx) and presentations (.ppt, .pptx).

Sessions

Each course will have it's own session time table which can be accessed by clicking the Schedule button with a Calender icon on the top navigation bar inside a course. This will open the secondary sidebar, listing all the sessions schedule for the current week. Sessions marked with a Desktop icon are held online (Zoom / Google Meet links included) and the Pin icon indicates a face-to-face session (venue provided). Similarly, a Teal background implies the session is active and a Red background for cancelled sessions. If you are a leader and click a session, you can:

• Update the session - This is done by clicking the Update button with a Pen icon which will be visible when the accordion opens. Fill in the new information and the confirm. A Notification will be sent to all members stating a change was made. You can also Cancel sessions here, which will also notify members.

• Delete the session - This is done in the say way as updating, but instead of the update button, you click the Delete button with a Trash icon. This will remove the session but not notify members.

If you are a student and a leader has requested to mark you as present for a session, you can:

• Confirm Attendance - This is done by clicking the Confirm button with a Tick in a Circle icon which will be visible when the accordion opens.

• Deny Attendance - This is done by clicking the Deny button with a Cross in a Circle icon which will be visible when the accordion opens.

Attendance

Attendance for scheduled sessions can be taken directly from within the app. This can be accessed by navigating the the Attendance page by clicking the link that reads Attendance with a User and Tick icon on in the top navigation bar when inside a course. Once here, you can:

• Take session attendance - This is done by clicking the Create button with a Plus inside a Circle icon on the controls panel. This button is disabled by default and will remain as is until one or more members are selected. This can be done by checking the check box on the very left of the table for the respective member(s) you wish to mark aas present. Note: you will need to have a session scheduled before taking attendance for it. An attendance notification will then be sent to the attendees, who will have to confirm their presence by clicking on the notification Title.

• View the attendance history - if you are an admin, this is done by first navigating to the Course Settings page, either by clinking the Expand button if you are on the Courses Page or by clicking the Settings button on the top navigation bar when inside the course. Once there, click the Sessions button with a Clock icon to go to the Attendance History Page. If you are a leader, this button wil read History and will be present beside the create attendance button on the Attendance page.

Announcements

Admins and leaders have the ability to broadcast a message to global scope and course scope respectively. This announcement will be accessible to all the recipients via the notifications panel. If you have access to either of these roles, you can:

• Create announcement - if you are an admin, this is done by first navigating to the Courses page. Once there, click the Announce button with a Bell with a Plus and then fill in the details. If you are a leader, this button wil be beside the Create Poll button at the end of the text input for sending messages in a course.

Notifications

Students ahd leaders have access to this feature. In app notifications are sent out to subscribed members (all by default) when certain events trigger. There are no push notifications at the moment, but plans to add them are underway To view your notifications, navigate to the Notifications page by clicking the link that reads Notifications with a Bell icon on the primary sidebar. once there, you can:

• View resource uploads - a notification will be sent to all course members when either a leader adds a Resource or member Submits a worksheets. Clicking the title will redirect you to the Resources page.

• View session updates - a notification will be sent to all course members when the course leader makes an update to Existing sessions. This will consist of either time changes or session Cancellation.

• Confirm session attendance - a notification will be sent to all Attendees of any current session in progress. The attendance will be marked as Pending until the attendee clicks the title and Confirm their presence.

Dashboard

Admins and leaders have access to a powerful dashboard which presents information on current trends and presents weekly statistics. To view this information, first navigate to the Dashboard page by clicking the link that reads Dashboard with a Grid icon on the primary sidebar. Here, you can:

• View weekly data - This refers to the 4 quick stats displayed on the top of the Dashboard page. The numbers indicate the current weeks stats and the percentage increase / decrease is in comparison to the previous weeks stats.

• View attendance trends - This refers to the Tpo Chart on the Dashboard page. It shows the number of attendees in the courses you lead (if you are a leader) or all courses combined (if you are an admin). The chart will show weekly data until the current date.

• View enrollment trends - This refers to the Bottom Chart on the Dashboard page. It shows the number of users that were enrolled in the courses you lead (if you are a leader) or all courses combined (if you are an admin). The chart will show weekly data until the current date.

Badges

Badges are awarded to users for completing certain tasks or reaching milestones. And in certain cases, badges wil be awarded for special events or easter eggs, like this one right here! - provided you have signed in. The logic for unlocking a badge will need to be implemented in the codebase by a maintainer. Only admins can manage badges. This is done by first navigating to the Badges page by clicking the label that reads Badges on the primary sidebar. Once there, you can:

• Create a badge - This is done through clicking the Create button with a Plus inside a Circle on the controls panel of the Badges page. Only admins have access to this page.

• Update a badge - this is done by clicking the Update button with a Pen icon. Note: this is button is disabled until at least 1 badge is selected. Selecting a badge can be done by first Hovering over the badge you wish to update, and then Selecting the check box on the top left of the badge. A modal will open, which is where you fill in the new information.

• Delete a badge - this is done in the same way as updating, but instead of the Update button, you click the Delete button with a trash icon. A confirmation modal will open, where you can either chose to proceed or cancel. The delete button is also disable until one or more badges are selected.

Leaderboards

This composes of the top leaders and students. Ranking is purely based on engagement and interaction. The top 3 students are Rewarded at the end of each semester, proudly sponsored by Vodafone. Despite being a combined ranking system, neither leaders nor students have an advantage over the other. This is the result of a balanced points system, which will be updated every semester based on trends seen in the previous semester. The point allocation is as follows:

• Sending a message - 1 point.
• Creating a poll - 1 point.
• Casting a vote - 2 points.
• Uploading resources - 1 point.
• Submitting worksheets - 2 points.
• Attending sessions - 2 points.
• Unlocking badges - 1 point.
• Sending feedback - 2 points.

Streaks (comoing soon)

Users have the ability to log in daily and increase their streak count. The streak will be used as a Points Multiplier to help boost leaderboard rankings. All points earned on day will be multiplied to the current steak count of that day with some dampening to keep streaks balanced.

Preferences

Users can specify personal preferences to adjust OPASS tot their liking. This can be done by navigating to the Settings page by clicking on teh link that reads Settings with a Gear icon on the primary sidebar. Once here, you can manage preferences on the right half of the page. Current settings include:

• Dark mode - This is done by toggling the Switch with the label that reads Dark Mode to swap between light and dark mode.

Turbo Keys

Turbo Keys is a handy feature that aims to speed up the navigation and interaction process around the app. Every internal link and action has a custom bind. These can only be used when Turbo Keys are active, to avoid conflicts with native browser shortcuts. Turbo Keys can be activated and deactivated by either pressing ctrl + /, ⊞ + / or ⌘ + /. Pressing Escape will also disable turbo keys.