Student Success Hub Custom Settings Reference

Review the SSH Hierarchy Settings and SSH Queuing Settings in Custom Settings.

SSH Hierarchy Settings
These settings primarily control appointments and availability.
SSH Queuing Settings
Review the settings that control queue management functionality in Student Success Hub orgs. These settings are licensed and configured for student users and Experience Cloud sites.

SSH Hierarchy Settings

These settings primarily control appointments and availability.

Note If you installed Student Success Hub before version 1.11, you might see additional fields that were previously used for specifying availability and have since been deprecated.

Field	Description	Can Support Staff Specify a Different Individual Default Value?
Advance Notice	The default minimum number of hours that an appointment can be scheduled before its start time.	Yes
Allow Mass Update in Alerts Related List	Shows checkboxes and a Change Status button on Alerts related lists on Student Record Cases so that support staff can make updates to multiple Alert statuses at once.	No
Appointment Buffer (minutes)	The default number of minutes between back-to-back scheduled appointments. When a value is specified, it becomes the default buffer for all support staff. However, individual users can override the value and set their own buffer in their Availability Settings.	Yes
Appointment Email Opt In	An integer representing the combination of appointment emails that a support staff member has chosen to receive (assuming the related field, Appointment Emails, is enabled). Do not edit the organization-level value. When individual support staff members edit their Email Notification Settings, the appropriate value is derived and saved automatically in the user's custom settings—you don't need to specify a value for each individually. Valid values: 7 = All emails (confirmation, update, and cancellation) 6 = Update and cancellation only 5 = Confirmation and cancellation only 4 = Cancellation only 3 = Confirmation and update only 2 = Update only 1 = Confirmation only 0 = No emails	Yes
Appointment Emails	Indicates whether Student Success Hub appointment email notifications are sent to both support staff and students. If enabled, also gives support staff access to individually manage their own Email Notification Settings (see the related field, Appointment Email Opt In). If disabled, Student Success Hub doesn't send appointment email notifications and Email Notification Settings are hidden from support staff.	No
Appointment Length	The default appointment length in minutes.	Yes
Appointment Locations	Meeting locations. List multiple locations separated by semicolons.	Yes
Chosen Full Name Field	Display a student’s chosen name instead of their legal name in the Student Snapshot on the Student Record Case and in the Attendee Snapshot in the Appointment Manager. Enter the API name of the field used for a chosen name, such as `hed_Chosen_Full_Name__c` provided in EDA. If this setting or the specified field is blank, Student Success Hub displays the Name field from the Contact record. To display the chosen name in other places, customize the associated page layouts. See Set Up the Student Snapshot.	No
Contact Photo File ID Field	The API name of the field on the Contact object that contains the LatestPublishedVersionId for the Contact's photo.	Yes
Custom Appointment Length Opt-In	If the related custom setting, Enable Custom Appointment Length, is enabled, indicates that a support staff member has set custom Appointment lengths by Topic or Subtopic. Do not edit the organization-level value. When individual support staff members opt in to set custom lengths, this setting is automatically enabled in their user custom settings.	Yes
Customize Student Snapshot Fields	Indicates whether the Student Snapshot can be changed from its default configuration. If enabled, you can customize which fields are displayed using an included custom field set and the related custom setting, Student Snapshot Headline Fields. If disabled, the Student Snapshot shows the fields that come preconfigured with Student Success Hub.	No
Disable Enhanced Notes	Indicates whether the Add Note actions are visible in the Action menus when viewing a support Event in the Appointment Manager. If you're using your own custom object to manage support notes instead of using Salesforce Enhanced Notes, select this setting to hide the Add Note actions and prevent taking notes with Enhanced Notes. If not selected, support staff can see the Add Note actions and use them to create Enhanced Notes.	No
Disable Support Staff Email Attachments	Indicates whether a .ics (calendar) file should be attached to appointment emails to support staff.	No
Display Student ID in Event Subject	If the related custom setting, Student ID Field, is enabled, this setting controls whether a student's student ID displays in the Subject of an Event record in Calendar appointments.	No
Email ID for Appointment Emails	Indicates that appointment emails are sent from a default From field. This value is not an email address. See Set Up Email for Appointments.	No
Enable Custom Appointment Length	Allows support staff to set their own custom appointment lengths by topic or subtopic. This setting makes visible the Custom Appointment Lengths option on their Availability Settings page. If this setting is deselected, the Appointment Length custom setting value is used.	No
Group Availability Event Type	A type of Event and a type of Availability that indicate availability for group appointments that students can sign up for in a portal.	No
Location	The entity, such as your institution, that the custom setting applies to.	No
Require Comments	Select this field to require comments when students schedule an appointment.	No
Scheduled Availability Event Type	The type of Event used to indicate availability for scheduled support appointments, such as `Scheduled`.	No
Student Appointment Interval	The time period, in days, used to determine whether a student is served. A student who hasn't had an appointment during the interval is "not served."	No
Student ID Field	The API name of the Contact field used for a student ID. If specified, student ID values can display with student names to uniquely identify students and can be searched in certain student lookup fields. If blank, student ID values don't display and can't be searched. See the related custom setting, Display Student ID in Event Subject.	No
Student Record Case Record Type	The API name of the Case record type for student records.	No
Student Snapshot Headline Fields	If the related custom setting, Customize Student Snapshot Fields, is enabled, this setting indicates the number of headline fields displayed in the Student Snapshot.	No
Support Event Record Type	The API name of the Event record type that identifies a support appointment.	No
Support Time Event Record Type	The API name of the Event record type that identifies the times a User is available for appointments to be scheduled.	No
Turn Off Email Attachments for Students	Indicates whether a .ics (calendar) file should be attached to appointment emails to students.	No
Turn off Student Appointment Record Link	Indicates whether the appointment card in the student portal includes a link to the Appointment record page.	No
Walk-In Appointment Event Type	The type of Event used to indicate a walk-in appointment.	No
Walk-In Availability Event Type	The type of Event used to indicate availability for walk-in appointments. The value provided here is used in the New Walk-In button in the Appointment Manager.	No

SSH Queuing Settings

Review the settings that control queue management functionality in Student Success Hub orgs. These settings are licensed and configured for student users and Experience Cloud sites.

Field	Description
Show Email for Check-In Notifications	Indicates whether the Email field appears on the Queue Waiting Room self check-in page.
Show Phone for Check-In Notifications	Indicates whether the Phone field appears on the Queue Waiting Room self-check-in page.
Show Student ID for Self Check-In	Indicates whether the Student ID field appears on the Queue Waiting Room self check-in page.
Support Queue Case Record Type	The API name of the Case record type that identifies a Support Queue Case. The default record type is `SupportQueue`.
Support Queue Status - Abandoned Cases	The status to use on a Support Queue Case to represent that the attendee didn't show up when called or notified. The default status is `Abandoned`.
Support Queue Status - Fulfilled Cases	The status to use on a Support Queue Case to represent that the attendee’s request was resolved. The default status is `Fulfilled`.
Support Queue Status - Queued Cases	The status to use on a Support Queue Case to represent that the attendee has been added to the queue and is waiting to see someone. The default status is `Queued`.
Support Queue Status - Ready Cases	The status to use on a Support Queue Case to represent that the attendee is ready to meet with someone. The default status is `Ready`.
Support Queue Status - Referred Cases	The status to use on a Support Queue Case to represent that the attendee showed up and an Appointment was created. The default status is `Referred`.
Waiting Room Description	The API name of the field used to represent the displayed description of the Queue Waiting Room. The default value is `hed__Description__c`. The description appears under the Waiting Room Display Name in the queueWelcomeBanner component.
Waiting Room Display Name	The API name of the field used to represent the display name of the waiting room. The default value is `Name`. The name appears at the top of the queueWelcomeBanner component.
Waiting Room Object	The name of the object used to represent waiting rooms. The default value is `hed__Facility__c`.
Waiting Room Resource Lookup Field	The name of the field on the Waiting Room Resource object that looks up to the waiting room object. The default value is `WaitingRoom__c`.
Waiting Room Instructions	The API name of the field used to represent the message that appears when waiting room self check-in is successful. By default, the field is unspecified, so no instructions appear. If specified, the instructions appear on the final page of the check-in process, under the text confirming successful check-in.