Student Success Plan Notification Service

The Student Success Plan (SSP) notification service interfaces with the SSP service to display the list of SSP tasks for a user.

Configuration

The SSP notification service must be configured to know how to communicate with the SSP server. SSP must be installed and configured to allow OAuth authentication. See SSP OAuth2 API Authentication for instructions on how to enable OAuth. The uPortal OAuth connection will require the following permissions:

PERSON_READ
PERSON_TASK_READ
PERSON_TASK_WRITE
MY_GPS_TOOL

Edit the Notification service configuration.properties file and populate the following properties:

studentSuccessPlanService.clientId=SETME
studentSuccessPlanService.clientSecret=SETME
studentSuccessPlanService.authenticationUrl=/api/1/oauth2/token
studentSuccessPlanService.sspProtocol=http
studentSuccessPlanService.sspHost=localhost
studentSuccessPlanService.sspPort=80
studentSuccessPlanService.sspContext=ssp

Portlet Preferences:

Preference Name	Default Value	Description
SSPTaskNotificationService.enabled	false	Enable to Student Success Plan Notification service
SSPTaskNotificationService.categoryName	Student Success Plan	The Category name to use for displaying SSP tasks
SSPTaskNotificationService.sourceName	Student Success Plan	The Source value to use for displaying SSP tasks
SSPTaskNotificationService.schoolIdAttribute	schoolId	The SSP API requires that the uPortal user be mapped to the SSP user. This is handle via the ISSPPersonLookup interface. Currently, there is only 1 implementation of the ISSPPersonLookup interface. This implementation expect that the "schoolId" is available to uPortal as a user attribute. This portlet preference identifies the name of the user attribute to use to lookup the school ID.