Note: This feature is only available for LTI 1.3.
When an H5P is launched through LTI, the LMS sends the current user's email. This typically is the email connected to the user's account within the LMS. H5P.com has a feature for using another email address than the user's default one. This is done by utilizing the possibility to send custom parameters through LTI in combination with the LMS's feature for variable substitution.
Technical details
To utilize this feature, the LMS has to send the following two fields inside the https://purl.imsglobal.org/spec/lti/claim/custom part of the launch (JWT):
- email_user_name: will be the part before the @
- email_domain· will be the part after the @
Example:
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"email_domain": "example.com",
"email_user_name": "john.doe"
}
This will translate to john.doe@example.com when h5p.com receives the launch
Brightspace
In Brightspace, custom variables can be set on several "levels":
- LTI Advantage registration
- Deployment
- Link
Since this is a hierarchy, any variable set on a higher level will be inherited. In the example below, I have set it on the LTI Advantage registration:
The above means the email for the user's h5p.com account will be <$User.username>@example.com
Canvas
The custom attributes are set on the LTI Developer Key setup for h5p.com. You'll find it under developer keys. Click the edit button, and then expand "Additional Settings". Here you should see "Custom fields". Below's an example:
In the example above, the email on h5p.com will be: <the user's given name>@yourdomain.com.
(Please remember that if the user's given name contains a space, this will not work because the resulting email address would be considered invalid. In this case, the user's email will fall back to their regular email address).
You can read more about the different variables offered by Canvas here
Blackboard
On Blackboard is possible to add any custom parameters that you might need, this can be edited inside the "My applications" in the "Developer" site of Blackboard.
Keep in mind that, each parameter must be on its own line, they must be formatted as a "name=value" pair, and they can be substitution variables so it looks something like this:
You can also create template variables. These variables are resolved using data from Blackboard Learn in its parameter format@x@user.full_name@x@. For example:
You can read more about it here.