--- schema_version: "1" id: 6a208f9af2b45f26bea790eadba11276a9805ce3634780b5c7ff247aaf93d417 title: Student Portal Components collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/sfdo/264-0-0/ssh_setup_portal_components.md canonical_url: https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 7a105065525c5173aee96a9847b4dd871320ea0b7217e68a7b3d76192f9e0753 description: Learn about the custom Lightning components you can use in a Student Success Hub student portal. products: - Nonprofit - Education release: "264" --- # Student Portal Components Learn about the custom Lightning components you can use in a Student Success Hub student portal. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/images/icon_note.png) Note Requires a Customer Community Plus or Customer Community Plus Login license, such as through Experience Cloud for Learner Success. Student Success Hub provides several custom Lightning components for student portals. Some are compatible only with certain pages, so make sure you add components to the appropriate pages. You can also customize pages with other Lightning components, such as object pages that display object details and related records. - **[SSH Appointment Action Menu Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Appointment Action Menu component gives students a button to allow them to quickly reschedule or cancel appointments from the Appointment Detail page. - **[SSH Appointment Scheduler Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Appointment Scheduler component allows students to view upcoming, past, and canceled appointments, and to access the Scheduling Wizard. - **[SSH Assigned Tasks Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Assigned Tasks component lets students view their assigned Tasks. The component looks a little different on a mobile device than on the desktop, but it offers similar functionality in both experiences. Tasks are organized by priority and due date to help students focus on the items that need the most attention. If accessed in the context of a specific Success Plan, the component shows the Tasks that are assigned under the Success Plan. If accessed directly, the component shows the Tasks assigned in a Success Plan as well as individual, one-off Tasks assigned to the student. - **[SSH Launchpad Agenda Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Launchpad Agenda component gives students a consolidated view of their scheduled appointments, courses, and calendar Events, such as a study group session or a doctor’s appointment. - **[SSH Program Plan Builder Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Program Plan Builder component allows students to create Personal Program Plans that detail the Courses to take each Term. - **[SSH Program Plan Highlights Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Program Plan Highlights component displays a header that contains key Program Plan fields. Use the SSH Program Plan Highlights component with the SSH Program Plan Requirements Summary component. - **[SSH Program Plan Requirements Summary Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Program Plan Requirements Summary component displays a header that contains key Program Plan fields. Use the SSH Program Plan Requirements Summary component with the SSH Program Plan Highlights component. - **[SSH Scheduling Wizard Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Scheduling Wizard component lets students schedule individual appointments with a support staff member, check for walk-in availability, and reserve a spot in a group appointment. Students choose options in the wizard so that they can meet with the staff member best suited to help at a convenient time and location. - **[SSH Success Plan Progress Bar Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Success Plan Progress Bar component gives students a visual indication of their progress toward completing the Tasks in a Success Plan. - **[SSH Success Plans Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Success Plans component lets students see all of the published Success Plans assigned to them. The component looks a little different on a mobile device than on the desktop, but it offers similar functionality in both experiences. It groups Success Plans into sections by type. Each section and Success Plan can be toggled open or closed. Each Success Plan shows the number of remaining and overdue Tasks and allows students to take action on any Task. - **[SSH Success Team Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Success Team component lets students see the members of their success team. - **[SSH Support Staff Appointment Settings Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH Support Staff Member Appointment Settings component shows a support staff member's appointment availability, including their working hours and the locations where they can meet. - **[SSH User Profile Schedule Button Component](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_portal_components.htm&release=264.0.0&type=5)** The SSH User Profile Schedule Button component allows students to schedule an appointment when they view a support staff member's User Profile page. ## SSH Appointment Action Menu Component The SSH Appointment Action Menu component gives students a button to allow them to quickly reschedule or cancel appointments from the Appointment Detail page. To offer the Reschedule or Cancel button, create a custom Appointment object page in the portal and then place this component on the Appointment Detail page. When a student taps or clicks Reschedule or Cancel for a group appointment that a support staff member scheduled, they're prompted to cancel their own attendance and told to contact the appointment organizer (staff member) if they need to reschedule. When a student reschedules an individual appointment or a reservation for a group appointment that they signed up for in the portal, they're sent to the Scheduling Wizard and can choose a different appointment of the same type for the same topic. They can also just cancel and not reschedule. For all group appointments, if the student is the last remaining attendee besides the organizer, then canceling their attendance cancels the appointment itself. ![The SSH Appointment Action Menu component with a callout on the Reschedule or Cancel button](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_appointment_action_menu.png) ## SSH Appointment Scheduler Component The SSH Appointment Scheduler component allows students to view upcoming, past, and canceled appointments, and to access the Scheduling Wizard. Place the component on a page where it's convenient for students to access and manage their appointments. For example, create a custom page called My Appointments. The appointment card may show the Topic, Subtopic, or Appointment Subject as a link that opens the Appointment record. Student Success Hub turns off the link by default. If you want students to be able to access the Appointment record, turn on the link. See [Turn Off Student Appointment Record Link](https://help.salesforce.com/s/articleView?id=sfdo.ssh_reference_custom_settings.htm&release=264.0.0&type=5 "Review the SSH Hierarchy Settings and SSH Queuing Settings in Custom Settings.") in your SSH Hierarchy Custom Settings. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/images/icon_note.png) Note As a security best practice, don't make Appointment records available in the portal. If you do, lock down fields as much as possible on the page layout used by students. That way students can't, for example, change appointments to times or locations that are unavailable to support staff. Also, be sure to disable the Appointment Attendee related list to ensure privacy and security for other attendees of group appointments. For virtual appointments, the component displays a Join Web Meeting button that the student can tap or click to enter the meeting. When a student taps or clicks Reschedule or Cancel for a group appointment that a support staff member scheduled, they're prompted to cancel their own attendance and told to contact the appointment organizer (support staff member) if they need to reschedule. When a student taps or clicks Reschedule or Cancel for an individual appointment or for a group appointment that they signed up for in the portal, they're sent to the Scheduling Wizard and can choose a different appointment of the same type for the same topic. They can also just cancel and not reschedule. If they're the last remaining attendee besides the organizer in the group appointment—any group appointment—then canceling their attendance cancels the appointment itself. ![The SSH Appointment Scheduler component](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_appointment_scheduler.png) ## SSH Assigned Tasks Component The SSH Assigned Tasks component lets students view their assigned Tasks. The component looks a little different on a mobile device than on the desktop, but it offers similar functionality in both experiences. Tasks are organized by priority and due date to help students focus on the items that need the most attention. If accessed in the context of a specific Success Plan, the component shows the Tasks that are assigned under the Success Plan. If accessed directly, the component shows the Tasks assigned in a Success Plan as well as individual, one-off Tasks assigned to the student. Place the Assigned Tasks component on a page where it's convenient for students to see a list of their assigned Tasks. For example: - Create a page called My Tasks to show both the Tasks assigned under Success Plans and the one-off Tasks unrelated to a Success Plan. - Create custom object pages for the Success Plan object, and on the Success Plan Detail page, create a Tasks tab to show the Tasks specific to a Success Plan. For instructions on how to set up both a My Tasks page and a Success Plan Detail page with a Tasks tab, see [Additional Success Plan Setup for Higher Ed](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_success_plans_hed.htm&release=264.0.0&type=5 "Configure the Student Success Hub app and your student portal to use Success Plans and Tasks."). ![The SSH Assigned Tasks component as it appears on a Success Plan Detail page on the desktop](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_assigned_tasks.png) ## SSH Launchpad Agenda Component The SSH Launchpad Agenda component gives students a consolidated view of their scheduled appointments, courses, and calendar Events, such as a study group session or a doctor’s appointment. Place the component on the Home page or on a page called My Agenda. If you create a new page, remember to add it to the navigation bar. ![The SSH Launchpad Agenda component showing ENG-201, a scheduled appointment, and a Calculus study group](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_launchpad_agenda.png) To set up the Launchpad Agenda: - Set the necessary object permissions and field-level security for these EDA objects: Course, Course Connection, Course Offering, Course Offering Schedule, Facility, and Term. See [Configure Student Permissions](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_security_perms_student_hed_configure.htm&release=264.0.0&type=5 "Give students the object and field permissions they need to use Student Success Hub from the portal."). - Review and update sharing settings for these EDA objects: Course Connection, Course Offering Schedule, and Facility. See [Configure Sharing Settings](https://help.salesforce.com/s/articleView?id=sfdo.ssh_sharing_settings.htm&release=264.0.0&type=5 "Review and edit the org-wide default sharing settings for the objects that Student Success Hub uses."). - If you want calendar Events to show in the Agenda, give students a way to create or sync events. Add the Calendar component to a page in your portal. Remember to test the student experience. - If you want Courses to show up in the Agenda, import that data first. See [Import Your School's Data](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_data_import_school.htm&release=264.0.0&type=5 "Create data to represent your educational institution in Student Success Hub."). Keep in mind that if you have holidays set up, Courses don’t display on specified holidays (however, Events and appointments will show). - The appointment card may show the Topic, Subtopic, or Appointment Subject as a link that opens the Appointment record. Student Success Hub turns off the link by default. If you want students to be able to access the Appointment record, turn on the link. See [Turn Off Student Appointment Record Link](https://help.salesforce.com/s/articleView?id=sfdo.ssh_reference_custom_settings.htm&release=264.0.0&type=5 "Review the SSH Hierarchy Settings and SSH Queuing Settings in Custom Settings.") in your SSH Hierarchy Custom Settings. ## SSH Program Plan Builder Component The SSH Program Plan Builder component allows students to create Personal Program Plans that detail the Courses to take each Term. Place this component on a page that can be accessed from a tab or from the navigation menu. For information, see [Set Up Pathways to Build Personal Program Plans](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_pathways_build_personal_plan.htm&release=264.0.0&type=5 "Complete these tasks to give support staff and students the ability to create Personal Program Plans in Student Success Hub."). ![The SSH Program Plan Builder component showing Courses for Fall 2019 and Spring 2020](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_personal_program_plan_sample.png) ## SSH Program Plan Highlights Component The SSH Program Plan Highlights component displays a header that contains key Program Plan fields. Use the SSH Program Plan Highlights component with the SSH Program Plan Requirements Summary component. Place the component on a page where it's convenient for students to see the details of a Program Plan. See [Set Up Pathways to View Program Plans](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_pathways_view_program_plans.htm&release=264.0.0&type=5 "Complete these tasks to give support staff and students the ability to view Program Plans and Program Enrollments in Student Success Hub."). ![The SSH Program Plan Highlights component](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_pathways_program_plan_highlights.png) ## SSH Program Plan Requirements Summary Component The SSH Program Plan Requirements Summary component displays a header that contains key Program Plan fields. Use the SSH Program Plan Requirements Summary component with the SSH Program Plan Highlights component. Place the component on a page where it's convenient for students to see the details of a Program Plan. See [Set Up Pathways to View Program Plans](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_pathways_view_program_plans.htm&release=264.0.0&type=5 "Complete these tasks to give support staff and students the ability to view Program Plans and Program Enrollments in Student Success Hub."). ![The SSH Program Plan Requirements Summary component](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_pathways_program_plan_req_summary.png) ## SSH Scheduling Wizard Component The SSH Scheduling Wizard component lets students schedule individual appointments with a support staff member, check for walk-in availability, and reserve a spot in a group appointment. Students choose options in the wizard so that they can meet with the staff member best suited to help at a convenient time and location. Place this component on a custom page that you create specifically for scheduling appointments. In the SSH Scheduling Wizard component properties panel, enter the API name of the page on your site with the SSH Appointment Scheduler component. This page opens when a student successfully schedules an appointment using the wizard. If you don't enter the Upcoming Appointments Page API Name, the wizard sends students to the site Home page when they successfully schedule an appointment. On any other pages that also include or call the Scheduling Wizard, specify the API name of the custom page that you created for the Scheduling Wizard component. For example, on your User Profile page, select the SSH User Profile Schedule Button component and enter the Scheduling Wizard Site Page API Name. ![Tip](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/images/icon_tip.png) Tip To find the API name of a portal page, in Experience Builder, select the page in the Pages menu, click ![A blue gear icon](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_page_properties_icon.png), and look in the API Name field. You can also add the component to the portal's navigation menu so that students can click Schedule an Appointment from anywhere on the site. ![The staff member selection page (left) and the appointment scheduled page (right) of the SSH Scheduling Wizard](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_scheduling_wizard_first_last.png) ## SSH Success Plan Progress Bar Component The SSH Success Plan Progress Bar component gives students a visual indication of their progress toward completing the Tasks in a Success Plan. Place the component at the top of a Success Plan Detail page above the SSH Assigned Tasks component. For setup instructions, see [Additional Success Plan Setup for Higher Ed](https://help.salesforce.com/s/articleView?id=sfdo.ssh_setup_success_plans_hed.htm&release=264.0.0&type=5 "Configure the Student Success Hub app and your student portal to use Success Plans and Tasks."). ![The SSH Success Plan Progress Bar component on a Success Plan Detail page on the desktop](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_success_plan_progress_bar.png) ## SSH Success Plans Component The SSH Success Plans component lets students see all of the published Success Plans assigned to them. The component looks a little different on a mobile device than on the desktop, but it offers similar functionality in both experiences. It groups Success Plans into sections by type. Each section and Success Plan can be toggled open or closed. Each Success Plan shows the number of remaining and overdue Tasks and allows students to take action on any Task. Place the component on a page where it's convenient for students to see a list of their Success Plans. For example, create a page called My Success Plans. ![The SSH Success Plans component on the desktop](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_success_plans.png) ## SSH Success Team Component The SSH Success Team component lets students see the members of their success team. Place the component on a page where it's convenient for students to see their success team, such as the Home page or a custom page. ![The SSH Success Team component](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_success_team.png) ## SSH Support Staff Appointment Settings Component The SSH Support Staff Member Appointment Settings component shows a support staff member's appointment availability, including their working hours and the locations where they can meet. ![Important](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/images/icon_important.png) Important Use this component only on the User Profile page. ![The SSH Support Staff Appointment Settings component](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_appointment_settings.png) ## SSH User Profile Schedule Button Component The SSH User Profile Schedule Button component allows students to schedule an appointment when they view a support staff member's User Profile page. ![Important](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/images/icon_important.png) Important Use the SSH User Profile Schedule Button component only on the User Profile page. We recommend placing it above the User Profile or User Profile Detail component. Placing it on other pages can interfere with other components and cause errors. To show their phone numbers and email address on their User Profile page, support staff must go to their profile in Salesforce Classic and set the visibility for these fields to External. For more information, see [Share Personal Contact Information Within Experience Cloud Sites](https://help.salesforce.com/articleview?id=networks_contact_info_visibility.htm&type=5) in Salesforce Help. ![The SSH User Profile Schedule Button component on a support staff member's User Profile portal page](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-sfdo-student_success_hub-264-0-0-production-enus/b7ac11a0-381d-499e-afd5-05e856602032/student_success_hub/images/ssh_portal_component_user_profile_schedule_button.png)