Custom parameters (delivery launch)
The parameters described in this topic are used to customize the LTI launch using TAO delivery features. These parameters are optional.
Parameter format
All custom parameters must be wrapped one custom claim:
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"key": "value"
}
Topic layout
Multiple attempt
This option allows test takers multiple attempts on the same assessment.
key | Value | Description |
---|---|---|
|
|
This will override |
Proctoring
The following parameters are used to define proctoring settings within the delivery. These settings will impact how proctoring (once launched) is configured for a given delivery. For more information on how to launch proctoring, see Proctoring via LTI.
key | Value | Default | Description |
---|---|---|---|
|
|
|
|
|
|
| Needed to require test takers to wait for proctor authorization. For the authorization parameter to function, |
|
|
| Needed to require test takers to wait for proctor authorization (regardless of whether they were authorized before or not). |
|
|
| This parameter supports assessment control from a third party proctoring tool. The provided value will be used to internally link the generated delivery execution ID with external customer value. |
Example:
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"proctoringSettings.enableMonitoring": true,
"proctoringSettings.requireProctorAuthorization": true
}
Dry-run
This parameter is used to define whether proctors/admins can preview the delivery without impacting results.
key | Value | Default | description |
---|---|---|---|
|
|
| This mode allows you to preview a delivery without generating any entry in the results store (while having the exact same experience as a test-taker):
|
Test review
The following parameters are used to launch a review of an existing test session. When these parameters are added to a launch in combination with the launch URL and User Identity claim (and attempt ID if mutliple attemps), the session launches in review mode for the user.
key | Value | Default | description |
---|---|---|---|
|
|
|
|
|
|
|
If When set to true, all the parameters below will take effect. If
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example:
{
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.review.enabled": true,
"deliverySettings.review.showScore": true,
"deliverySettings.review.showCorrect": true,
"deliverySettings.review.showQuestion": true,
"deliverySettings.review.showUnShuffled": true
}
}
Navigation
The following parameters are used to define navigation for the test taker.
key | Value | Default | description |
---|---|---|---|
|
| None |
Setting this parameter to
|
|
| None |
|
|
|
| If it is |
Auto-closure
If provided, the following parameters will ensure a delivery execution will be closed at a given time, triggering a final AGS call (if requested). This is useful to force a test session to be closed when testing is over (for example, when a student forgets to submit the test on the last item).
key | value | default | description |
---|---|---|---|
|
| None | TTL (time-to-live) provided as a value in seconds. If provided, a delivery execution will be closed once the TTL has passed, starting from the delivery launch (+ some margin of error due to the closure script being executed at certain intervals). |
|
| None | RFC3339-formatted absolute date-time value. If provided, a delivery execution will be closed at a given time (+ some margin of error due to the closure script being executed at certain intervals). |
Since these parameters essentially complete the same task (designating when to close the delivery), providing only one of these parameters is needed if you want a delivery to close at one specific time. If both provided, the earlier date will apply.
Examples:
{
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.ttl": 600
}
}
{
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.closeOn": "2021-01-20T19:58:00+00:00"
}
}
Titles customization
This parameter allows the title displayed for the session to be customizable.
key | value | default | description |
---|---|---|---|
|
| None |
Example:
CODE
|
Plugin parameters
This section lists plugin parameters - these options enable or disable accessibility and security plugins.
Tenant default enabled pluginstaoQtiNuiTest/runner/plugins/content/title/plugin
taoQtiNuiTest/runner/plugins/panel/menu/plugin
taoQtiNuiTest/runner/plugins/navigation/jumpMenu/plugin
taoQtiNuiTest/runner/plugins/settings/plugin
(visibility depends on item categories)taoQtiNuiTest/runner/plugins/tools/highlighter/plugin
(visibility depends on item category)taoQtiNuiTest/runner/plugins/tools/scratchpad/plugin
(visibility depends on item category)taoQtiNuiTest/runner/plugins/tools/calculator/plugin
(visibility depends on item category)taoQtiNuiTest/runner/plugins/tools/lineReader/plugin
(visibility depends on item category)taoQtiNuiTest/runner/plugins/tools/fullscreen/plugin
(visibility depends on item category)taoQtiNuiTest/runner/plugins/tools/readAloud/plugin
taoQtiNuiTest/runner/plugins/tools/print/plugin
(visibility depends on item category)taoQtiNuiTest/runner/plugins/navigation/warnBeforeLeaving/plugin
taoQtiNuiTest/runner/plugins/tools/preventDropToInput/plugin
Tenant default omitted pluginstaoQtiNuiTest/runner/plugins/panel/a11y/plugin
(portal session option)taoQtiNuiTest/runner/plugins/security/disableRightClick/plugin
(portal session option)taoQtiNuiTest/runner/plugins/security/disableCommands/plugin
(portal session option)taoQtiNuiTest/runner/plugins/security/preventScreenshot/plugin
(portal session option)taoQtiNuiTest/runner/plugins/security/forceFullscreen/plugin
(portal session option)taoQtiNuiTest/runner/plugins/security/pauseOnBlur/plugin
(portal session option)
Adding plugins
key | value | default | description |
---|---|---|---|
|
|
| Comma-separated list of plugins to apply to the current assessment session. Plugin examples:
|
Example:
The following will apply the accessibility plugins and plugin settings (answer masking and answer eliminator) to the assessment sessions:
{
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.plugins.add": "taoQtiNuiTest/runner/plugins/panel/a11y/plugin, taoQtiNuiTest/runner/plugins/settings/plugin"
}
}
Removing plugins
key | value | default | description |
---|---|---|---|
|
|
| Comma-separated list of plugins to remove from the current assessment session, e.g. Plugin example:
|
Example:
The following will remove main-menu and warn-before-leaving plugins:
{
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.plugins.remove": "taoQtiNuiTest/runner/plugins/panel/menu/plugin, taoQtiNuiTest/runner/plugins/navigation/warnBeforeLeaving/plugin"
}
}
General plugin settings
key | value | default | description |
---|---|---|---|
|
| None | A JSON-encoded object as a string, e.g. Plugin settings example:
|
Examples:
{
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.plugins": "{\"localItemState\":{\"saveState\":{\"liveSaveIndicator\":{\"enabled\":false}}}}"
}
}
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.plugins": "{\"readAloud\": {\"readAloudOption\": \"always-enabled\"}}"
}
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.plugins": "{\"a11yMenuPanel\": {\"openOnStart\": true, \"contrastTheme\": {\"enabled\": true, \"themes\": [\"default\", \"whiteOnBlue\", \"yellowOnBlack\", \"blueOnYellow\", \"greyOnGreen\"]}, \"groups\": [\"group-contrast\", \"group-pointer\", \"group-text\", \"group-zoom\"]}}"
}
Read Aloud Plugin
key | value | default | description |
---|---|---|---|
|
|
|
|
Example:
{
"https://purl.imsglobal.org/spec/lti/claim/custom": {
"deliverySettings.readAloud.enabled": true
}
}
Security Plugins
key | value | default | description |
---|---|---|---|
|
|
|
|
|
|
| If
|
|
|
|
|
|
|
| If
|
|
|
|
|
|
|
|
|
Example:
{
"https://purl.imsglobal.org/spec/lti/claim/custom":
{
"deliverySettings.plugins.forceFullScreen.enabled": "true",
"deliverySettings.plugins.forceFullScreen.autoresume": "true",
"deliverySettings.plugins.pauseOnBlur.enabled": "true",
"deliverySettings.plugins.pauseOnBlur.autoresume": "true",
"deliverySettings.plugins.preventScreenshot.enabled": "true",
"deliverySettings.plugins.disableCommands.enabled": "true"
}
}
Delivery execution control
The following parameters are used to define in what ways test takers are allowed to execute with the test.
key | value | default | description |
---|---|---|---|
|
|
|
|
|
|
|
Any value set for this parameter will override Any results from a previous attempt (pre-reset) will be deleted without the possibility to restore them. |
|
|
| For now, only a Only the results from the last attempt are recorded. Any results from previous attempts will be deleted without the possibility to restore them. |
Delaying assessment start
The following parameters are used to define the assessment’s time constraints for test takers.
key | value | default | description |
---|---|---|---|
|
|
| RFC3339-formatted absolute date-time value. Example: 2024-10-03T11:44:13-04:00 (October 3 2024 at 11:44:13 AM EST) If defined and current time is behind it, a waiting page will be displayed until the |
|
|
| RFC3339-formatted absolute date-time value. Example: 2024-10-03T11:44:13-04:00 (October 3 2024 at 11:44:13 AM EST) If defined, will be used to display indicative time of the exam. Once this time is reached, the test taker will end on the waiting page. This parameter will have no effect if |
|
|
| If defined, will be used to display the test name/title on the waiting page. If not defined, the QTI-test level label (from the Authoring tool) will be used. ![]() |