LTI Custom parameter substitutions
LTI User variables
Message variable name | Description | Value |
---|---|---|
$User.id | Platform user entity id (not sync key in any case) | E.g.: 400012 (Same as for user_id from LTI standard parameters) |
$User.username | User's username. | E.g.: adamsmith |
LIS Person variables
Message variable name | Description | Value |
---|---|---|
$Person.name.full | Person full name | E.g.: [email protected] (Same as for lis_person_name_full from LTI standard parameters ) |
$Person.name.family | Person family name | E.g.: Smith (Same as for lis_person_name_family from LTI standard parameters ) |
$Person.name.given | Person given name | E.g.: Adam Smith (Same as for lis_person_name_given from LTI standard parameters ) |
$Person.address.locality | Person locale | E.g. : en-GB (Same as for launch_presentation_locale from LTI standard parameters ) |
$Person.address.timezone | Person windows timezone | E.g: GMT Standard Time |
$Person.email.primary | Person primary e-mail address | E.g : [email protected] (Same as for lis_person_contact_email_primary from LTI standard parameters ) |
LIS Course Offering Variables
These Message variables are only substituted in course context, and the custom parameters containing these are only passed in course context.
Message variable name | Description | Value |
---|---|---|
$CourseOffering.sourcedId | Identifier for course | E.g. : ltitest.itslearning.com:MYCA (Same as for lis_course_offering_sourcedid from LTI standard parameters |
$CourseOffering.title | Course title | E.g.: Course A (Same as for context_title from LTI standard parameters |
$CourseOffering.courseNumber | Course code | E.g. : MYCA (Same as for context_label from LTI standard parameters |
LIS Course Section Variables
These Message variables are only substituted in course context, and the custom parameters containing these are only passed in course context.
Message variable name | Description | Value |
---|---|---|
$CourseSection.sourcedId | Identifier for Learning tool instance in course | E.g.: ltitest.itslearning.com:MYCA-104454 (Same as for lis_course_section_sourcedid from LTI standard parameters |
$CourseSection.title | Learning tool instance title | E.g.: LTI tool title |
$CourseSection.shortDescription | Max 200 characters of learning tool instance description | A short description describing the learning tool instance |
$CourseSection.longDescription | Learning tool instance description | A long description elaborately describing the learning tool instance and possible some more details |
$CourseSection.courseNumber | Course code | E.g. : MYCA (Same as for context_label from LTI standard parameters |
$CourseSection.timeFrame.begin | Time the learning tool instance is active from | E.g. : 01.01.1900 23:59:59 |
$CourseSection.timeFrame.end | Time the learning tool instance is active to | E.g. : 31.12.9999 23:59:59 |
$CourseSection.sourceSectionId | Learning tool instance ID | E.g. : 104454 |
LIS Result Variables
These Message variables are only substituted in course context, and the custom parameters containing these are only passed in course context.
Message variable name | Description | Value |
---|---|---|
$Result.sourcedGUID | Unique result identifier | E.g. : mzkaxjv4rwgjrt55eov0tj55;104454;114662;18619 (Same as for lis_result_sourcedid from LTI standard parameters |
$Result.resultScore | Result in format valid according to LTI specs | E.g: 0.6 |
itslearning Context Variables
These Message variables are only substituted in course context, and the custom parameters containing these are only passed in course context.
Message variable name | Description | Value |
---|---|---|
$Context.courseId | Course ID for course this instance is placed in | Format: <CustomerId>-<CourseId> E.g. 23002-6 |
$Context.organisationId | Course organisation ID for course this instance is placed in | E.g. 1233 |
$Context.organisationSyncKey | Course organisation SyncKey for course this instance is placed in | E.g. ASD1234 |
$Context.organisationLegalId | Course organisation LegalID for course this instance is placed in | E.g. ASD123 |