You are here:
Student Success Hub K-12 Installation Reference
Understand what's included in the installation plans for K-12 Student Success Hub orgs.
- K-12 Installation Suggestions and Best Practices
Discover ways to help ensure a smooth installation of Student Success Hub for K-12. - K-12 Base Plan
The base plan installs the minimal, core packages required to run Student Success Hub: K-12 Architecture Kit, Education Data Architecture (EDA), and Student Success Hub. It also installs unpackaged metadata. - Full Configuration Plan
The full configuration plan deploys optional unmanaged metadata such as record types, page layouts, and profiles and permission sets. We recommend that all customers install the full configuration plan to help get Student Success Hub up and running. Install the full configuration plan after installing the base plan, and then customize the metadata for your school. - Sample Data Plan
The sample data plan deploys optional sample data that you can use to test or demo features. Sample data includes student and counselor personas (Users), district and school Accounts, and roles. Install the sample data plan after installing the base and full configuration plans. We recommend the sample data plan for partners. - K-12 Metadata Plans
Install these plans by using the Installation Manager on the SSH Settings page in the Student Success Hub app.
K-12 Installation Suggestions and Best Practices
Discover ways to help ensure a smooth installation of Student Success Hub for K-12.
-
We recommend that you execute all of the steps in the installer plans, including optional steps. Completing all steps reduces errors and ensures that you have all of the configurations in place for customizing your org.
-
Some recommended steps require the successful completion of earlier recommended steps. If you skip recommended steps and encounter errors, re-run the installer with all recommended steps selected.
-
We recommend that you install SSH into a new org that has no customizations. Installing SSH into an existing org can affect your custom metadata.
-
Do not deploy optional metadata configurations directly to a live production environment. Instead, deploy to a new sandbox environment, customize configurations for your org, and then migrate to production.
K-12 Base Plan
The base plan installs the minimal, core packages required to run Student Success Hub: K-12 Architecture Kit, Education Data Architecture (EDA), and Student Success Hub. It also installs unpackaged metadata.
| Step | Description | Installation |
|---|---|---|
EDA - Account Record Types |
Deploys Account record types for EDA. |
Required |
EDA - Contact Key Affiliation Fields |
Deploys Contact Key Affiliation fields for EDA. |
Required |
Install EDA |
Updates or installs the Education Data Architecture managed package. |
Required |
EDA - Case Behavior Record Types |
Deploys Case Behavior record types for EDA. |
Required |
EDA - Course Connection Record Types |
Deploys Course Connection record types for EDA. |
Required |
EDA - Facility Display Name Formula Field |
Deploys the Facility Display Name formula field for EDA. |
Required |
| EDA - Health Check | Validates EDA Settings related to Accounts, Affiliation mappings, Reciprocal Relationships, and Course Connections. | Required |
Student Success Hub - Prerequisite Record Types |
Deploys required record types for the Event and Case objects. |
Required |
Install SSH |
Installs the latest version of the Student Success Hub managed package. |
Required |
Student Success Hub - Unpackaged Metadata |
Deploys unpackaged metadata, including record types, custom tabs, and metadata associated with Lightning pages. |
Required |
Student Success Hub - Custom Settings |
Inserts Student Success Hub custom settings. |
Optional, recommended |
K-12 Architecture Kit - Add Application Type Picklist Values |
Deploys picklist values for the Application Type field on the K-12 Architecture Kit Application object. |
Required |
K-12 Architecture Kit - Add Behavior Response Type Picklist Values |
Deploys picklist values for the Type field on the K-12 Architecture Kit Behavior Response object. |
Required |
K-12 Architecture Kit - Add Case Category Type Picklist Values |
Deploys picklist values for the K-12 Architecture Kit custom Category field on the Case object. |
Required |
K-12 Architecture Kit - Add Case Location Type Picklist Values |
Deploys picklist values for the K-12 Architecture Kit custom Location field on the Case object. |
Required |
K-12 Architecture Kit - Add Behavior Involvement Role Picklist Values |
Deploys picklist values for the Role field on the K-12 Architecture Kit Behavior Involvement object. |
Required |
| K-12 Architecture Kit - Add Relationship Type Picklist Values | Deploys picklist values for the Type field on the K-12 Architecture Kit Relationship object. | Required |
| K-12 Architecture Kit - Add Contact Gender Picklist and RecordType Values | Deploys picklist values for the K-12 Architecture Kit custom Gender field and custom record types for the Contact object. | Required |
K-12 Architecture Kit - Prerequisite Record Types |
Deploys required record types for the Account, Case, Contact, Behavior Involvement, and Behavior Response objects. |
Required |
Install K-12 Architecture Kit |
Installs the latest version of the K-12 Architecture Kit managed package. |
Required |
K-12 Architecture Kit - Metadata and Configuration |
Deploys unpackaged metadata for K-12 Architecture Kit including record types, Reports and Dashboards, metadata associated with Lightning pages, object customizations, object translations, and translation settings. |
Required |
K-12 Architecture Kit - Course Connections |
Enables Course Connections in K-12 Architecture Kit. |
Required |
Deploy K-12 Architecture Kit App Tile |
Deploys the K-12 Architecture Kit Lightning app. |
Required |
Full Configuration Plan
The full configuration plan deploys optional unmanaged metadata such as record types, page layouts, and profiles and permission sets. We recommend that all customers install the full configuration plan to help get Student Success Hub up and running. Install the full configuration plan after installing the base plan, and then customize the metadata for your school.
| Step | Description | Installation |
|---|---|---|
Student Success Hub - Unpackaged Metadata |
Deploys unpackaged K-12 metadata including Reports and Dashboards, Flows, page layouts, object customizations, the Attendance path on the Alert object, quick actions, user roles, and metadata associated with Lightning pages. |
Optional, recommended |
Student Success Hub - Sample Sharing Rules |
Deploys sample sharing rules for the Alert, Success Plan, and Success Plan Template objects. |
Optional, recommended |
Student Success Hub - Lightning App and Support Staff Profile |
Deploys the Student Success Hub Lightning app and the K-12 support staff profile. |
Optional, recommended |
Student Success Hub - Support Staff Permission Set |
Deploys a permission set for the support staff profile. |
Optional, recommended |
Sample Data Plan
The sample data plan deploys optional sample data that you can use to test or demo features. Sample data includes student and counselor personas (Users), district and school Accounts, and roles. Install the sample data plan after installing the base and full configuration plans. We recommend the sample data plan for partners.
| Step | Description | Installation |
|---|---|---|
Student Success Hub - Sample Data |
Deploys unpackaged K-12 sample data to the org, including Account data, Alerts, Cases, Contacts, Success Plan Templates, and Users. |
Required |
| Student Success Hub - Sample Student Photo | Uploads a photo for the Student Success Hub student persona. | Optional, recommended |
Student Success Hub - Sample Counselor Photo |
Uploads a photo for the Student Success Hub counselor persona. |
Optional, recommended |
K-12 Metadata Plans
Install these plans by using the Installation Manager on the SSH Settings page in the Student Success Hub app.
For instructions, see Add Metadata to Your Student Success Hub Org.
- Sample Reports and Dashboards
- A sample dashboard and a set of underlying reports for Alerts.
- Sample Support Reports and Dashboards
- Sample reports and dashboards for staff and managers to assess student needs, trends, and team workloads.
- Sample Permission Set
- A permission set for K-12 support staff.
