Custom parameters (proctoring launch)

The following parameters are used to customize the LTI proctoring launch using TAO features. These parameters are optional.

All custom parameters must be wrapped in one custom claim:

CODE

"https://purl.imsglobal.org/spec/lti/claim/custom": {
  "key": "value"
}

Key	Value	Default	description
Groups
`groups.allContexts`	serialized `object[]`	none	This parameter allows proctors to monitor multiple contexts by switching between those that are defined using the dropdown (see example below the table). The ID defined in this parameter must match the context ID defined for a test taker for the delivery launch (see Context (delivery launch)).
`groups.allContexts[].id`	`string\|required`	none	This value defines the active test-sessions (and test takers) to monitor (see example below the table).
`groups.allContexts[].label`	`string\|required`	none	Enter a short, human-readable description of the context that will be displayed in the group switcher dropdown menu.
`groups.nrpsUrlPattern`	`string`	none	`NRPS memberships` endpoint with a `{context-id}` placeholder. Example: `https://customerSystem.com/{context-id}/memberships` If provided, the proctoring tool will query this endpoint for each context provided in the `groups.allContexts` parameter, replacing the `{context-id}` placeholder with the actual `context.id`
`groups.nrpsServiceVersions`	json-encoded `string[]`	none	`service_versions` parameter to be used during the `NRPS` query. Typically, `2.0`. This is required if `groups.nrpsUrlPattern` is provided. Since LTI custom parameters are key/value(string) pairs, this array of strings needs to be JSON-encoded (see examples).
`groups.allowDisplayAll`	`boolean`	`false`	If this flag is set to `true`, when monitoring there will be added groups selection “All“. If group selection “All“ is selected in monitoring, records from all contexts that are provided in the `groups.allContexts` list will be shown in the proctoring interface.
`groups.defaultSelected`	`string`	none	Value of this field is context id (one of `groups.allContexts[].id`). If this field is provided, then the value will define which context in the group switcher dropdown menu will be set as the default during monitoring. If that field is not presented: In the group switcher dropdown menu, the `All` entry will be selected (if enabled by the field `groups.allowDisplayAll` being set to `true`). Or, it will be selected the context given in the `context` parameter ( `https://purl.imsglobal.org/spec/lti/claim/context )`
Other
`availableActions`	json-encoded `string[]`	none	For this parameter, list the actions available to proctors when monitoring. The possible values are the following: `report`: enables the proctor to report a test-taker. `terminate`: enables the proctor to terminate a test-session. `reopen`: enables the proctor to re-open a closed or submitted test-session. `pause`: enables the proctor to pause a test-session. `resume`: enables the proctor to authorize/resume a test-session. `extend_time`: enables the proctor to add extra time to a test-session. Example: CODE `{ "https://purl.imsglobal.org/spec/lti/claim/custom": { "availableActions": "[\"report\", \"reopen\"]" } }`
`hideTabs`	json-encoded `string[]`	none	This parameter allows you to hide certain tabs from the monitoring page. The possible values are the following: `paused`: hides the `Paused` tab `awaiting-authorization`: hides the `Not started` tag Example: CODE `{ "https://purl.imsglobal.org/spec/lti/claim/custom": { "hideTabs": "[\"awaiting-authorization\", \"paused\"]" } }` Hiding a tab may lead to certain assessments becoming unavailable to proctors.
`requireProctorAuthorization`	`Boolean \|\| String`	`false`	Needed to require test takers to wait for proctor authorization. For this to have effect,`proctoringSettings.enableMonitoring` should be set to `true` as well.

Example:

CODE

"https://purl.imsglobal.org/spec/lti/claim/custom": {
  "groups.allContexts": [
    {
      "id": "456",
      "label": "Classroom B"
    },
    {
      "id": "789",
      "label": "Classroom C"
    }
  ],
  "groups.allowDisplayAll": true,
  "groups.defaultSelected": "456",
  "groups.nrpsUrlPattern": "https://customerSystem.com/{context-id}/memberships",
  "groups.nrpsServiceVersions": ["2.0"],
  "availableActions": ["terminate", "reopen"],
  "allowReview": ["finished"],
  "extraColumns": [
    "ip"
  ]
}

Example (json-encoded):

CODE

"https://purl.imsglobal.org/spec/lti/claim/custom": {
  "groups.allContexts": [
    {
      "id": "456",
      "label": "Classroom B"
    },
    {
      "id": "789",
      "label": "Classroom C"
    }
  ],
  "groups.allowDisplayAll": true,
  "groups.defaultSelected": "456",
  "groups.nrpsUrlPattern": "https://customerSystem.com/{context-id}/memberships",
  "groups.nrpsServiceVersions": "[\"2.0\"]",
  "availableActions": "[\"terminate\", \"reopen\"]",
  "allowReview": "[\"finished\"]",
  "extraColumns": [
    "ip"
  ]
}

Groups

Other