SSP v2.X External View Tool
- Jason Elwood
Applicable version: v2.8.0 and later
Description
A new feature allows implementers to add 1-4 customizable tool links to the tool menu (Main, Early Alert, MAP, etc). The tools are configuration and permission based so implementers have control as to which tools show for users/roles as well as the name of the tool. The tool can be a simple link to an external site or contain parameterized url's based on SSP identifiers. Combined with Oauth or LTI based integrations, a parameterized url could open a new link/app directly into a student record, IE: appointment system, LMS, etc.
Display
Configuration
External View is a folder within the Administrative Tools folder in SSP administration. Minimally, the external url is required in order to successfully link the tool. One or more parameters, STUDENTID and USERID, are available to create a custom url whereby SSP will replace the parameters with data known to SSP. Configurations consists of the External View admin, Text (blurb) and Tool Permissions. Visibility of the tools is controlled by the external view permissions.
External View Admin
Configuration Options
| Option | Description |
|---|---|
External URL | A valid url to an external site/link is required
|
Student Identifier | Parameter = STUDENTID Values = Identifiers include: username, schoolID or primary email address |
User Identifier | Parameter = USERID Identifiers include: username, schoolID or primary email address |
Embed in Tool View | A checkbox to control the target of the tool selection. The default is to open a new browser tab/window. Choosing to embed the tool in the tool view will open the content similar to opening the Main or Early Alert tool. Considerations for the size and style of the content should be reviewed prior to embedding external tool content |
Text (blurb)
The tool name is defined in the Text configuration options in SSP administration. To rename the tool, the value for the tool can be modified.
Text Options
| Name | Value (default) | Code |
|---|---|---|
| External View Tool 1 | Tool 1 | ssp.label.tools.externalviewtool1 |
| External View Tool 2 | Tool 2 | ssp.label.tools.externalviewtool2 |
| External View Tool 3 | Tool 3 | ssp.label.tools.externalviewtool3 |
| External View Tool 4 | Tool 4 | ssp.label.tools.externalviewtool4 |
Permissions
By default, permissions are granted to only the ADMIN and DEVELOPER roles. In order for the tool(s) to appear in the tool menu for a user, the user or parent role must contain read permissions. The following permissions are available for assignment:
- EXTERNAL_VIEW_TOOL_1_READ
- EXTERNAL_VIEW_TOOL_2_READ
- EXTERNAL_VIEW_TOOL_3_READ
- EXTERNAL_VIEW_TOOL_4_READ
To add permissions to the Accommodation Custom Security Group
- As a super user, navigate to Manage Users
- Choose Manage permissions
- Use Ctrl+F to find the "EXTERNAL_VIEW_TOOL_1_READ". Click it.
- Click "Add an Assignment"
- You'll get an unlabeled input field with instructions to select a target. Type "All permissions".
- Click the "Submit" button
- Click "Choose Principals"
- Click the "SSP Roles" group, then select the desired group
- Click the green "plus" icon above that list, next to the selected group. That group should appear in the right hand panel with a green "checkmark" icon.
- Click "Submit"
- You should see the permission granting tree view from d/e, but with the selected group group now present, with a "Inherit (Deny)" grant.
- Change that to "Grant". The change will be applied immediately. There is no form submission button.
- Repeat steps 3-12 for each tool and role for assignment.