Assess API Initialization

Enable automatic saving of responses during assessment sessions.

Note By default, this feature will check every 300 seconds for changes to the sessions responses, and silently save the responses.

Values

Attribute path navigation.auto_save

Default false

• Type boolean

  Enables auto saving with the default behavior.

  Note this auto save feature will be paused if there is any active video or audio recording and will be resumed once the recording is stopped/completed - a paused recording is considered an active recording.

• Type object

  • changed_responses_only boolean

    Only auto-save when there are changes to responses.

    Enable to have the auto_save invoked only when users have new or modified responses since the last save. Set to false to trigger an automatic save at every save interval, regardless of new responses (for example to capture changes in timer state, or depleted reading time).

    Default: true

  • save_interval_duration number

    The number of seconds between each auto-save check.

    Default: 300

  • ui boolean

    Enable a UI indicator.

    Default: false

  • disable_force_save_on_quit boolean

    Enable this to ignore the force save when quitting, unloading or when navigating away from the page.

    By default it's set to false which will always allow the force save on quit.

    Default: false

    Version added: v2021.1.LTS