Affects Version/s: None
Property addition/change required:Yes
IMS LTI has a feature called "Custom Parameter Substitution"
A tool can put in a custom variable into its configuration like:
And when the tool is launched the "$Person.name.full" will be replaced by the user's full name and sent to the tool as a custom parameter. These are only substitution values and are only sent if "requested" by the tool in the custom values section.
This JIRA adds the feature where we can set a value in sakai.properties that defines a custom parameter substitution string by adding a lines like:
The first half "lti.custom.substitution." indicates to Sakai that this is to be made available to the tool as a custom substitution. The second half defines the custom substitution course string. For example is the tool had this in its custom area:
When then tool was launched the following custom variables would be sent:
It is important to note that these values will be available to any tool - and some tools set their own custom parameters in the Deep Link / Content Item flow. So do not place any sensitive information in these properties in sakai.properties. This is why the values have a long prefix - "lti.custom.substitution" - so we don't mistakenly allow tools to read general values in sakai.properties.
Note that I have marked this as "change to sakai.properties" - there is no real change required - but there is new documentation that needs to be written for this new convention.