ℹ︎ | During this installation, it is key to ensure it is available for all org units. To do so, click Add Org Units and select the org unit. Then, make sure to check All descendants, otherwise it will only work for exactly that org unit. If you don't do this, the learning tool will be unavailable. This step is not separately documented below, but if there is the opportunity in any step to define org units, make sure to make it available. This is unrelated to the placement of Portflow within nav bars, which will in the end define whether users will be able to find the application. |
For this installation, Administrator or Super Administrator permissions in Brightspace at the Organization level are required.
TABLE OF CONTENTS
- I. Register the tool
- II. Register the deployment
- III. Create an OAuth app for the user
- IV. Create an OAuth app for the admin
- V. Create links
- VI. Add Portflow to the nav bar
- VII. Adjust assignment end date settings
- VIII. Adjust email access
- IX. Default language
- Overview of information to send to Drieam
- Add user sync (optional)
I. Register the tool
Go to Admin Tools > Manage extensibility > LTI Advantage
Click Register Tool
Select Standard
Fill out the fields
Name: e.g., Portflow
Description: e.g., The student-owned portfolio solution by Drieam
Domain:
EU Hosting
https://app.portflow.app
AU Hosting
https://au.portflow.appRedirect URLs:
EU Hosting
https://app.portflow.app/lti/launches
AU Hosting
https://au.portflow.app/lti/launchesOpenID Connect Login URL:
EU Hosting
https://app.portflow.app/lti/open_id
AU Hosting
https://au.portflow.app/lti/open_idKeyset URL:
EU Hosting
https://app.portflow.app/lti/keypairs
AU Hosting
https://au.portflow.app/lti/keypairsExtensions:
Assignment and Grade Services
Deep Linking
Names and Role Provisioning Services
Roles:
Send Institution Role
Substitution Parameters
resource_link_title $ResourceLink.title resource_link_history $ResourceLink.id.history course_offering_title $CourseOffering.title course_offering_label $CourseOffering.label user_email $Person.email.primary user_sourced_id $Person.sourcedId Click register.
- Communicate the Registration details with Drieam.
II. Register the deployment
Go to Admin Tools > External Learning Tools > LTI Advantage
Click New Deployment
Select the tool Portflow (tool name), the rest should be filled out automatically
Under security settings, check:
Org Unit Information
User information (and all descendants)
Link information (and all descendants)
Classlist including users not known to this deployment
Under Make tool available to, add the organization and all descendants (even if just available to 1 department)
Click Create Deployment
Communicate the Deployment Id with Drieam.
III. Create an OAuth app for the user
Go to Admin Tools > Manage Extensibility > OAuth 2.0
Click Register an app
Fill out the fields
Application name: Portflow
Redirect URI:
EU Hosting
https://app.portflow.app/lti/oauth2/callback
AU Hosting
https://au.portflow.app/lti/oauth2/callbackScope: core:*:*
Accept the terms
Click Register
Communicate the Client ID and Client Secret with Drieam
IV. Create an OAuth app for the admin
As Brightspace only allows for one callback URL per application, there needs to be another application for admin access to file submissions from course assignments.
Go to Admin Tools > Manage Extensibility > OAuth 2.0
Click Register an app
Fill out the fields
Application name: Portflow Admin
Redirect URI:
EU Hosting
https://app.portflow.app/admin/oauth2/callback
AU Hosting
https://au.portflow.app/admin/oauth2/callbackScope: core:*:*
Accept the terms
Click Register
Communicate the Client ID and Client Secret with Drieam
V. Create links
We’ll create 2 links to integrate Portflow in Brightspace, a launching link and an insert stuff link to submit Portflow snapshots in assignments.
Go to Admin Tools > External Learning Tools > LTI Advantage
Open Portflow
Click View Links at the bottom of the page
Click New Link
Fill out the fields
Name: Portflow Launch
URL:
EU Hosting
https://app.portflow.app/lti/launches
AU Hosting
https://au.portflow.app/lti/launchesDescription: Launch Portflow in Brightspace
Select Type: Basic Launch
Click Save and Close
Click New Link
Fill out the fields
Name: Portflow
URL:
EU Hosting
https://app.portflow.app/lti/launches
AU Hosting
https://au.portflow.app/lti/launchesDescription: Insert a Portflow snapshot
Select Type: Deep Linking Insert Stuff
Click Save and Close
VI. Add Portflow to the nav bar
Go to Admin Tools > Navigation & Themes > Custom Links
Click Create Link
Name: Portflow
Or any other name. It is also possible to add emoji, or symbols like ⎈.URL: Insert Quicklink > External Learning Tools > Portflow Launch
Copy the generated URL (e.g. /d2l/common/dialogs/quickLink/quickLink.d2l?ou={orgUnitId}&type=lti&rcode=XXXX&srcou=6606&launchFramed=1&framedName=Portflow) and communicate it with Drieam.
Behaviour: Same Window
Description: Access your portfolio
Icon: e.g., the icon available at Drieam
Availability: select Share with child org units
Click Save
Go to Navbars
Open the desired Navbar and add the link via Add Links > select Portflow.
Click Save and Close
VII. Adjust assignment end date settings
Navigate to Config Variable Browser > Tools > Dropbox > EndDateDefaultType
At Override values, choose 'visible with submission restricted' for the Org unit which will use Portflow. This will make sure students are able to import their submissions into Portflow after the deadline has passed.
! If you choose 'visible with access restricted' or 'hidden', students are not able to import their submitted assignments into Portflow once the deadline has passedClick Save
VIII. Adjust email access
- Navigate to Config Variable Browser > Tools > Classlist > DisplayEmail
- At Override values, choose 'on' for the Org unit (e.g. 6606) which will use Portflow.
This will make it possible to send email notifications to users that have not yet launched Portflow, e.g. when distributing Portflow templates. - Click Save
IX. Default language
The default language for Portflow has to be set by Drieam. This is the language that will be shown to users who have their Brightspace account set to any language other than the list of supported languages. Let Drieam know what your primary (default) language and secondary language(s) should be. The default language cannot be changed.
ℹ︎ | Portflow currently supports the following languages:
|
Overview of information to send to Drieam
Please send the following information from the steps above to support@drieam.com:
- Registration details (step I)
- Client ID
- Instance URL
- Brightspace Keyset URL
- OpenID Connect Authentication Endpoint
- Brightspace OAuth2 Access Token URL
- Deployment ID (step II)
- User OAuth app details (step III)
- Client ID
- Client Secret
- Admin OAuth app details (step IV)
- Client ID
- Client Secret
- Nav bar Quicklink URL
- Default language and secondary language(s)
- Optional: sign-in info for created Portflow user as described below
Add user sync (optional)
ℹ︎ | Brightspace does not offer an API through which Portflow can search for users. If this is not addressed, Portflow users can only search for and invite other users that have already launched Portflow at least once. To enable user search in the entire Brightspace user base, follow the steps below. For this purpose, a new role will be created with a special set of permissions that allows Portflow to access the required data to enable user search. This role will be assigned to a new user of which the sign-in credentials need to be shared with Drieam. Drieam will use the credentials to authenticate the application as a user in Brightspace with the specified permissions. This is then used to execute a weekly (each Saturday) user synchronization between Brightspace and Portflow. |
VIII Add new role
Go to Admin Tools > Roles and Permissions
Click Create/Copy
Click Start Fresh (for the least amount of permissions set – most secure)
Fill out the settings
Name: Portflow admin
Description: DO NOT DELETE – Required for access to users for Portflow.
Check Cascading Role
Course Access Options
Access inactive courses
Access past courses
Access future courses
Leave the rest as is
Click Save
Check the required Role Interactions
Search for [...]
Super Administrator and Administrator at Organization and Department levels (4 checkboxes)
Impersonate [...]
Super Administrator and Administrator at Organization and Department levels (4 checkboxes)
Enroll [...]
Super Administrator and Administrator at all levels.
See External Email Addresses for [...]
Super Administrator and Administrator at Organization and Department levels (4 checkboxes)
Click Save
Click the v next to the new role and click Edit Permissions
Click Choose Org Unit Types and select All
Under Filter by Tool, select All Tools and click Apply Filter
Under Email, check all permissions for
See External Email Address for ‘<role>’ (do this for all relevant roles that need to be found in Portflow, e.g. instructor, mentor, student, etc. )
Under External Learning Tools, check all permissions for
Launch External Learning Tool Links
Under User Information Privacy, check all permissions for
See First Names
See Last Names
See Usernames
See Org Defined IDs
See Email Addresses
See Middle Names
Distinguish Preferred Names from Legal Names
Under Users, check all permissions for
View the Users' Email Address
See the User Management tool
Search for Inactive Users
Search for ‘<role>’ (do this for all relevant roles that need to be found in Portflow, e.g. instructor, mentor, student, etc.)
Click Save and Close
IX Add new user
Go to Admin Tools > Users
Click New User
Fill out the fields
Legal First Name: Portflow
Middle Name: Drieam
Legal Last Name: Administrator
Role: Portflow admin
Username: e.g. Portflow.Admin and keep a note of the Username
Password: check Manually set password and set a secure password and keep a note of the Password
Set user as Active
Click Save
Communicate the sign-in details (username, password and sign-in URL with Drieam and specify the corresponding environment – e.g., acceptance, testing, production).
Make sure to never delete the user nor the role.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article