...
Table of Contents | ||
---|---|---|
|
...
Configuration
...
and External
...
Data Validation
Validation | Description | |
---|---|---|
Purpose | Holds attributes for any user accessing or referenced by SSP. For example, supports search results, early alerting and student creation. Records in this table are periodically synchronized into the "person" table and several of its supporting tables. Both school_id and username must be unique identifiers for each record. I.e. any given school_id or username can occur at most once. | |
Considerations |
| |
Sync'd Fields |
| |
User Interface Validation | Documentation of display locations for external data in the user interface | |
Data and Configuration Validation | Common validation queries to test the accuracy of the configuration and integrity between external tables |
Block 1 - Base SSP Configuration
External DB Tables
external_person | Description | |||
---|---|---|---|---|
Purpose | Holds attributes for any user accessing or referenced by SSP. For example, supports search results, early alerting and student creation. Records in this table are periodically synchronized into the "person" table and several of its supporting tables. Both school_id and username must be unique identifiers for each record. I.e. any given school_id or username can occur at most once. | |||
Considerations |
| |||
Sync'd Fields |
|
...
Install Settings | General Settings | Counseling Reference Guide (CRG) | Journal Track-Step-Detail |
---|---|---|---|
Section 1 | Section 2 | Worksheet | Worksheet |
|
|
|
|
...
Tool Permissions | Descriptions |
---|---|
Purpose | Each role has a default set of tool permissions. Beyond assigning multiple roles, individual tool permissions can be assigned if necessary. |
Considerations |
|
Validation Steps
- Add a new student to SSP
- Review the sync'd data from external person
- Confirm section1 and 2 configuration items
...
Block 2 - Main Tool Phase 1
...
external_student_transcript_course | Description |
---|---|
Purpose | Contains section- or course-scoped student transcript records. Used in the Main Tool Transcript Tab. Each row represents a collection of course completion metrics (grade, credits earned, etc) for a particular student at at least course granularity (course code + term code). Additional values can be specified to scope a given entry to a particular section, but this may not be possible in all cases, e.g. transcript entries sourced from other institutions. |
Considerations |
|
external_student_financial_aid | Description |
---|---|
Purpose | Holds student financial aid information. Used in Main Tool Details Tab |
Considerations |
|
external_financial_aid_award_term | Description |
---|---|
Purpose | Holds student financial aid information to describe the term by term acceptance of financial aid. Each term financial aid was offered to a student should be included along with the acceptance status for each term. Used in Main Tool Details Tab |
Considerations |
|
external_student_financial_aid_file | Description |
---|---|
Purpose | Holds student financial aid information related to the files required in the students application. Each of the required files should be associated to a row for each student. Each row should have an appropriate status code to describe the status of each file. Used in Main Tool Details Tab and MAP |
Considerations |
|
Block 4 - Student Intake
SSP Configuration Guide
- Student Intake Settings
- Student Intake Message Template
- Intake Field Labels
Block 5 - Early Alert
External DB Tables
- external_faculty_course_roster
- external_faculty_course
SSP Configuration Guide
- Early Alert Settings
- Early Alert Message Templates
Block 6 - Journal
SSP Configuration Guide
- Journal Settings
Block 7 - Counseling Reference Guide and Action Plan
SSP Configuration Guide
- Action Plan Settings
- MyGPS
- Action Plan Message Templates
Block 8 - Map Phase 1
External DB Tables
- external_course
- external_division
- external_department
- external_program
SSP Configuration Guide
- MAP message templates
- MAP Settings
- MAP Plan Status Calculation
Block 9 - Map Phase 2
External DB Tables
- external_course_term
- external_course_program
- external_course_tag
- external_course_requisite
- external_substitutable_courses
- external_person_planning_status (optional)
SSP Configuration Guide
- MAP Settings
Block 10 - Notes and Accommodation
External DB Tables
- external_person_note
SSP Configuration Guide
. transcript entries sourced from other institutions. | |
Considerations |
|
external_student_financial_aid | Description |
---|---|
Purpose | Holds student financial aid information. Used in Main Tool Details Tab |
Considerations |
|
external_financial_aid_award_term | Description |
---|---|
Purpose | Holds student financial aid information to describe the term by term acceptance of financial aid. Each term financial aid was offered to a student should be included along with the acceptance status for each term. Used in Main Tool Details Tab |
Considerations |
|
external_student_financial_aid_file | Description |
---|---|
Purpose | Holds student financial aid information related to the files required in the students application. Each of the required files should be associated to a row for each student. Each row should have an appropriate status code to describe the status of each file. Used in Main Tool Details Tab and MAP |
Considerations |
|
...
Block 4 - Student Intake
SSP Configuration Guide
Student Intake Settings | Student Intake Message Template | Intake Field Labels |
---|---|---|
Section 3 | Section 8 with Template Definitions and Examples | Section 3 |
Many of the intake settings should match the values available in the SIS. Most common:
|
|
...
Block 5 - Early Alert
SSP Configuration Guide
Early Alert Settings | Early Alert Message Templates |
---|---|
Section 4 | Section 8 with Template Definitions and Examples |
|
External DB Tables
external_faculty_course | Description |
---|---|
Purpose | Holds information related to course details for each course taught by an instructor for a given term. Used along with v_/external_faculty_course_roster to support SSP Early Alert creation. |
Considerations |
|
external_faculty_course_roster | Description |
---|---|
Purpose | Holds course roster details for each course taught by an instructor. Used for SSP Early Alert. Each record in this table represents a selectable enrollment in the SSP Early Alert creation UI. For Early Alerts created directly via API, the application may attempt to locate additional course-related data from this table, but this is optional. Any data sourced from this table during Early Alert creation is copied into the Early Alert record, so this table can be periodically pruned, e.g. as a simple means to limit the selectable rosters in the Early Alert UI. |
Considerations |
|
...
Block 6 - Journal
SSP Configuration Guide
Journal Settings |
---|
Worksheet |
|
...
Block 7 - Counseling Reference Guide and Action Plan
SSP Configuration Guide
Action Plan Settings | MyGPS | Action Plan Message Templates |
---|---|---|
Section 7 | Worksheet | Section 8 with Template Definitions and Examples |
|
|
...
Block 8 - Map Phase 1
External DB Tables
external_course | Description |
---|---|
Purpose | Holds course details generally found in a course catalog/bulletin. Used in the MAP Tool |
Considerations |
|
external_division | Description |
---|---|
Purpose | Defines the list of divisions that can be added to the plan template definition. Used in the MAP Tool. |
Considerations |
|
external_department | Description |
---|---|
Purpose | Defines the list of departments that can be added to the plan template definition. Used in the MAP Tool. |
Considerations |
|
external_program | Description |
---|---|
Purpose | Defines the list of programs that can be added to the plan template definition. Used in the MAP Tool. |
Considerations |
|
SSP Configuration Guide
MAP Settings | MAP Message Templates |
---|---|
Section 11 | Section 8 with Template Definitions and Examples |
|
|
...
Block 9 - Map Phase 2
External DB Tables
external_course_term | Description |
---|---|
Purpose | Defines the terms in which the designated course is offered. Each course with the associated term to include is listed separately. Used in the MAP Tool. |
Considerations |
|
external_course_program | Description |
---|---|
Purpose | Description: Defines the courses required by degree programs. Each course with the associated program is listed separately. Used in the MAP Tool. |
Considerations |
|
external_course_tag | Description |
---|---|
Purpose | Defines the tag codes assigned to courses. Each course with the associated tag is listed separately. Used in the MAP Tool. |
Considerations |
|
external_course_requisite | Description |
---|---|
Purpose | Defines the list of programs that can be added to the plan template definition. Used in the MAP Tool. |
Considerations |
|
external_substitutable_courses | Description |
---|---|
Purpose | Description: Defines the relationship of courses that may be used during the MAP plan status calculation. An option in the calculation allows for a planned course to be substituted by another course when the matching logic identifies courses. When matched to the subtitution (target course), the planned course will be considered a match. Each row will define a single pair of courses, and multiple rows can be inserted to define additional substitutions for a plan course. Used in the MAP Tool |
Considerations |
|
external_person_planning_status (optional) | Description |
---|---|
Purpose | Defines the status of the student's active plan. Valid values are On and Off. This indicates whether or not the student is on plan to complete the active plan. The requirements and calculation of plan status is done outside of SSP and simply stored in this table. If the student planning status is Off, a reason can be stored in the table. Used in the MAP Tool when SSP is not calculating the plan status. |
Considerations |
|
SSP Configuration Guide
MAP Settings | |
---|---|
Section 11 | MAP Plan Status Calculation
|
|
...
Block 10 - Notes and Accommodation
External DB Tables
external_person_note | Description |
---|---|
Purpose | Notes from any system can be save in the table for display in SSP. Notes can originate from any system and will be displayed to the user in chronological order. Used in the External Notes Tool |
Considerations | By default, Notes are only available to Coach roles. Implementers commonly add permissions to the Support Staff and Faculty roles No security is applied to the rows. If a user has access, all rows loaded into the table are visible are visible |
SSP Configuration Guide
Accommodation Settings |
---|
Section 9 |
Considerations
|