SSP External Data and Configuration Guide Proposed Phases
Pre Configuration and Data Tasks
...
Below is a recommended approach to dividing the configuration and corresponding external data into blocks of effort. Based on the SSP tools to be implemented, the corresponding block(s) of effort can be scheduled into the project timeline. The main goal of the block approach is to divide the effort into measurable segments of work that can be analyzed, executed and tested independently from other SSP tools.
Table of Contents | ||
---|---|---|
|
...
Configuration and External Data Validation
Validation | Description |
---|---|
Purpose | For each of the blocks described below, the configuration and external data should be validated for accuracy, integrity and support for the business processes. The links below should be used to assist with validation for each block. The external data is displayed throughout SSP as described in the User Interface Validation. The documentation describes the location of external data in the UI. The external data also is the basis for user information and supports various tools. To ensure the supports the application, the validation queries will identify common problems with the data load in the external tables. |
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
- v_external_person
- v_external_term
...
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 |
|
external_term | Description |
---|---|
Purpose | Holds academic calendar information. Required in many locations throughout the application: Caseload Assignment, Main, Intake and MAP. |
Considerations |
|
SSP Configuration Guide
Install Settings | General Settings |
---|
...
uPortal Roles and Permission
- Role Assignments
- Tool Permissions
Counseling Reference Guide (CRG) | Journal Track-Step-Detail | ||
---|---|---|---|
Section 1 | Section 2 | Worksheet | Worksheet |
|
|
|
|
uPortal Roles and Permissions
Role Assignments | Description |
---|---|
Purpose | Each user must have a role assignment in order to log into SSP. The default role for all users should be student which allows the least amount of access to SSP (specifically MyGPS) |
Considerations |
|
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 DB Tables
...
external_registration_status_by_term | Description |
---|---|
Purpose | Holds registration status for each student by term |
...
. Used in SSP reporting capabilities. Used in the Main Tool Details Tab | |
Considerations |
|
external_student_academic_program |
---|
...
Description | |
---|---|
Purpose | Defines each student's current academic program(s) of study. Used in the Main Tool Dashboard Tab |
Considerations |
|
external_student_transcript | Description |
---|---|
Purpose | Holds current, cumulative student transcript summary information. Used in the Main Tool Dashboard Tab. Note that SSP will never attempt to calculate a GPA. |
Considerations |
|
...
|
external_student_transcript_term | Description |
---|---|
Purpose | Holds term by term student transcript summary information. Used in the Main Tool Dashboard Tab. Note that SSP will never attempt to calculate a GPA. |
Considerations |
|
SSP Configuration Guide
- Begin Continue collecting referrals items for the Counseling Reference Guide
- Continue collecting items for the Journal Track-Step-Detail associations
...
Block 3 - Main Tool Phase 2
SSP Configuration Guide
- General Settings (FinAid)
- Financial Aid Files
- Financial Aid SAP Status Codes
External DB Tables
...
external_student_test | Description |
---|---|
Purpose | Holds student test score data. Used in the Main Tool Placement Tab |
Considerations |
|
...
|
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 |
---|---|---|
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 |
SSP Configuration Guide
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
...
SSP Configuration Guide
...
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
|