LTI User variables

Message variable name

Description

Example

$User.id

<CustomerId>_<PersonId>

1234_400012

$User.username

User's username.
Only provided if privacy level is set to Public.

adamsmith

LIS Person variables

Message variable name

Description

Example

$Person.name.full

Person full name
Only provided if privacy level is set to Public or NameOnly 

Adam Smith

$Person.name.family

Person family name
Only provided if privacy level is set to Public or NameOnly  

Smith

$Person.name.given

Person given name
Only provided if privacy level is set to Public or NameOnly  

Adam

$Person.address.locality

Person locale 

en-GB

$Person.address.timezone

Person windows timezone 

GMT Standard Time

$Person.email.primary

Person primary e-mail address
Only provided if privacy level is set to Public or EmailOnly 

[email protected]

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

Example

$CourseOffering.sourcedId

<CustomerId>_<CourseCode>

1234:MYCA

$CourseOffering.title

Course title

Course A

$CourseOffering.courseNumber

Course code

MYCA

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

Example

$CourseSection.sourcedId

Identifier for Learning tool instance in course

For Resources:

If SectionId > 0 then <CustomerId>:<CourseCode>-<SectionId>-<LearningObjectId>

When tool is added in another place than resources:

If SectionId <= 0 then <CustomerId>:<CourseCode>-<LearningObjectInstanceId>

1234:MYCA-1-04454

$CourseSection.title

Learning tool instance title

LTI tool title

$CourseSection.shortDescription

Short description that is registered for the tool in itslearning.

Add a Demo tool resource to your course.

$CourseSection.longDescription

Long description that is registered for the tool in itslearning.

Demo tool allows you to create interactive resources, that can easily be integrated in your LMS. Simple by ... (etc.)

$CourseSection.courseNumber

Course code

MYCA

$CourseSection.sourceSectionId

Learning tool instance ID

04454

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

Example

$Context.courseId

Course ID for course this instance is placed in

1233

$Context.organisationId

Course customer ID for course this instance is placed in

143

$Context.organisationSyncKey

Course organisation SyncKey for course this instance is placed in

ASD1234

$Context.organisationLegalId

Course organisation LegalID for course this instance is placed in

ASD123